Content generated with AI — it may contain mistakes.

ExyliaArmorSkin/GuidesUpdated in v1.4.1

Set up the wardrobe

Let players pick a skin for each armour piece from /wardrobe, choose between items, wardrobe or both, and see it working.

Page 5 of 219 min read

The wardrobe is a menu where players pick a skin for each armour piece, or for all four at once, and wear it. You end with /wardrobe working the way you want: items only, wardrobe only, or both.

A skin item writes onto the armour. The wardrobe stores the choice against the player, so it survives death, trading and a change of gear, and the armour is never written to.

Before you start#

You have at least one skin, see Create and edit skins. Players need exyliaarmorskin.wardrobe, which everyone has by default.

Set it up#

Pick where skins come from

In config.yml, set behaviour.mode to item, wardrobe or both (the default). See the three modes below.

Reload

Run /armorskinsadmin reload.

Give a player skins

Operators own every skin. Others own a skin through its permission (exyliaarmorskin.skin.<id>), /armorskinsadmin unlocks grant <player> <skin>, the crate or the shop.

Open it

Run /wardrobe.

There is a 3D wardrobe too

With menu.style: SPATIAL in config.yml, /wardrobe opens the wardrobe in the world instead: the player tries skins on their own body and saves or buys in place. /wardrobe 3d and /wardrobe classic open either one. See Set up the 3D wardrobe.

Check that it works#

/wardrobe opens a 54-slot window. The armour along the top is what the player currently looks like; the grid below is every skin. Left-click a piece, click a skin, and the skin is drawn on you. Click the worn skin again to take it off. Undress all empties everything.

The three modes#

behaviour.mode decides where a piece's skin comes from:

ModeWhere it comes fromWhat it implies
itemOnly what a skin item wrote onto the armour.The skin is traded, dropped and lost with the piece. No wardrobe, no database.
wardrobeOnly what the player picked in /wardrobe.It follows the player and lands on whatever they equip. Skin items do nothing.
bothThe armour's own skin, and the wardrobe for armour that carries none.The default.

In both the armour wins: a skinned piece is drawn with its own skin, and the wardrobe only covers bare pieces.

What the buttons do#

ButtonWhat it does
Undress all (slot 45)Takes everything off.
Filter (slot 52)Shows only the skins the player owns. Remembered like the tab.
Close (slot 49)Closes the menu.
Crate (slot 53)Opens the crate; shows the keys held and skins collected.
Page buttons (slots 48 and 50)Turn the skin grid.
ClickOnResult
LeftAn armour rowFocuses it: the grid now dresses that piece.
RightAn armour rowClears that piece.
LeftThe Full set rowFocuses every piece at once.
RightThe Full set rowClears the whole wardrobe.
Any clickA skinWears it on the focus, or takes it off when it is already worn.
Any clickA skin for saleAsks to confirm, charges the price and unlocks it. See Buying with currency.
Dressing the whole set dresses what you are allowed to wear

With the full set focused, a skin is applied to every piece the player may wear it on, so a rank that owns one piece of a skin still gets that piece rather than being refused.

Going further#

Change the look of the menu by editing lang/<language>/menus/wardrobe.yml (see Menus). Where the server's menu style is SCREEN, /wardrobe opens as a native screen (screens/wardrobe.html, with the crate and its reels) with a real body in a window that tries on the skin under the cursor. A screen that fails to load falls back to the chest menu.

Clearing a wardrobe hands out no item, because none was ever consumed. Skin items and removers belong to item and both.

Technical reference#

For people who edit the menu file.

Slots and lists of the menu
SectionSlotsWhat it holds
targets2,3,4,5,6What is being dressed: the full set, then helmet, chestplate, leggings and boots.
skins10-16,19-25,28-34,37-43Every skin, paged with the buttons at slots 48 and 50.

Undress all sits at slot 45 and takes everything off; Filter at 52 shows only the skins the player owns (remembered like the tab); Close at 49; Crate at 53 opens the crate and shows the keys the player holds and how many skins they have collected.

Each armour row is drawn in the leather piece of its own slot, tinted with the skin worn there, so the top of the screen is what the player currently looks like. A grid row is drawn in the piece being dressed, so the skin is previewed where it is going to end up; a skin that does not fit the focused piece is drawn in a piece it does fit.

Templates of the wardrobe menu
SectionTemplateUsed when
targetsitem_templateAn armour slot that is not focused.
focused_templateThe armour slot being dressed.
set_templateThe full-set row, not focused.
focused_set_templateThe full-set row while it is focused.
skinsitem_templateA skin the player may use and that fits.
selected_templateThe skin worn on the focused piece — or on every piece the skin fits, with the set focused.
unsupported_templateA skin whose pieces do not include the focused slot.
no_permissions_templateA skin the player does not own.
purchasable_templateA skin the player does not own that the shop sells, while shop.enabled is on.

item_template is the plain state and must stay first in each list. The locked and unsupported rows carry no action of their own: clicking one does nothing. A player owns a skin through its node or an unlock, from the crate or the shop.

Wardrobe placeholders

These are the wardrobe's own tokens, filled in while the screen is drawn. They are not PlaceholderAPI placeholders and only work inside this file.

The targets list holds two kinds of row — the full-set row first, then one row per piece — and each kind carries its own tokens.

PlaceholderWhereWhat it draws
%target%targetsWhat the row dresses: a piece key, or set on the full-set row.
%target_name%targetsIts name from wardrobe: full-set, or the piece's own name.
%dressed%targets, full-set rowHow many of the four pieces carry a skin.
%pieces%targets, full-set rowHow many pieces there are in total — four.
%piece%targets, piece rowsThe piece's key: helmet, chestplate, leggings or boots.
%piece_material%targets, piece rowsThe leather material of that slot, to draw the row with.
%skin_name%targets, piece rowsThe skin worn on that piece, or wardrobe.empty.
%skin_color%targets, piece rowsThat skin's hex colour, or undyed leather when it has none.
%skin_trim_pattern%targets, piece rowsThat skin's trim pattern, empty when it has no trim.
%skin_trim_material%targets, piece rowsThat skin's trim metal, empty when it has no trim.
%skin_id%skinsThe skin's id.
%skin_name%skinsIts display name.
%skin_icon%skinsIts icon, or the default skin item's material.
%skin_preview%skinsThe armor piece it is previewed in — the one being dressed when the skin fits it.
%skin_color%skinsIts hex colour, or undyed leather when it has none.
%skin_trim_pattern%skinsIts trim pattern, empty when it has no trim.
%skin_trim_material%skinsIts trim metal, empty when it has no trim.
%skin_pieces%skinsThe pieces it fits.
%skin_worn%skinsThe pieces the player is wearing it on, empty when none.
%skin_worn_name%skinsThe same, but wardrobe.empty when none.
%price%skins, purchasable_templateThe price, written the way its currency writes it.
%keys%anywhereThe crate keys the player holds.
%unlocked_count%anywhereHow many skins they own, by unlock or permission.
%catalogue_count%anywhereHow many skins the server declares.
Menu actions
ActionWhat it does
armorskin:wardrobeOpens the wardrobe menu.style names, after checking exyliaarmorskin.wardrobe.
armorskin:focus <target>Dresses one piece, or set for all four.
armorskin:wear <skin>Wears a skin on the focus, or takes it off when it is already worn.
armorskin:clear <target>Clears one piece, or set for the whole wardrobe.
armorskin:buy <skin>Buys a locked skin with currency, then reopens the wardrobe on the same focus. Needs exyliaarmorskin.buy.
armorskin:crateOpens the crate.
armorskin:equip <skin>Wears a skin on every piece the player may, from outside the wardrobe: what a crate reel's winner does when clicked.
Wording in messages.yml

The few strings one template draws for every row live under wardrobe in messages.yml:

messages.yml
yaml
wardrobe:
  full-set: "{primary}&lFULL SET"
  helmet: "{primary}&lHELMET"
  chestplate: "{primary}&lCHESTPLATE"
  leggings: "{primary}&lLEGGINGS"
  boots: "{primary}&lBOOTS"
  piece-names:
    helmet: "Helmet"
    chestplate: "Chestplate"
    leggings: "Leggings"
    boots: "Boots"
  empty: "{muted}Nothing"

piece-names is how a piece is written inside a sentence or a list, such as %skin_pieces%.

Where the wardrobe is stored

One row per player in armorskin_wardrobe: the uuid, and one column per piece holding a skin id. Reads never block — a wardrobe still coming back from the database answers "no skin yet", and the player is redrawn as soon as it lands.

The table is classified for ExyliaLib, so /exylialib resetplayer <player> ExyliaArmorSkin and /exylialib wipe clear it along with the crate's keys and unlocks. See ExyliaLib commands.

Nothing has to be given back

Clearing a wardrobe hands out no item, because none was ever consumed: a wardrobe choice is a row, not an item. Skin items and removers belong to item and both.

Something missing on this page? Tell us on Discord