Content generated with AI — it may contain mistakes.

ExyliaArmorSkin/ReferenceUpdated in v1.5.0

Configuration

config.yml in full: the language, how the items are drawn, the behaviour switches, the effects, showcases, the crate, the shop and the wardrobe style; then every line in messages.yml.

Page 12 of 2110 min read
          # ... see The crate       - {permission: group.vip, cosmetic: galaxy}    - {permission: '', cosmetic: ocean} 

config.yml holds every setting except the skins themselves. What a player reads (item names and lore, the armour lore, the wardrobe wording and every message) lives in lang/<language>/messages.yml. You will mostly change three things:

  • Language: language (default default, which follows ExyliaLib's language). See Installation.
  • Where skins come from: behaviour.mode is item, wardrobe or both (default). See Set up the wardrobe.
  • Where skins are off: behaviour.disabled-worlds is a list of world names.

After editing, run /armorskinsadmin reload. The sections below list every key.

The default config.yml
config.yml
yaml
language: default
 
skin-item:
  material: ARMS_UP_POTTERY_SHERD
  glow: true
 
remover-item:
  material: SCRAPE_POTTERY_SHERD
  glow: true
 
armor-lore:
  enabled: true
 
behaviour:
  mode: both
  consume-remover: true
  consume-skin-item: true
  hide-without-permission: true
  disabled-worlds: []
 
defaults:
  helmet: []
  chestplate: []
  leggings: []
  boots: []
 
effects:
  on-apply:
    sound:
      name: ITEM_ARMOR_EQUIP_LEATHER
      volume: 0.7
      pitch: 1.2
      category: PLAYERS
  on-remove:
    sound:
      name: ITEM_BUNDLE_REMOVE_ONE
      volume: 0.7
      pitch: 1.0
      category: PLAYERS
 
showcase:
  locations: []
  pause-seconds: 3.0
  radius: 24.0
  only: []
 
crate:
  enabled: true
  # ... see The crate
 
shop:
  enabled: true
  tier-prices:
    common: 500
    rare: 1500
    epic: 4000
    legendary: 10000
 
menu:
  style: CLASSIC

Keys of language#

Keys of language

Which folder under lang/ this plugin's menus and messages are read from.

ValueWhat it means
defaultFollow the language set in ExyliaLib's own config.yml. What a fresh install writes.
en, es, pt, fr, ru, trThis plugin alone, in that language. All six ship.
customThe files this server had before languages existed — see Installation.

Any other code starts from the English files and is yours to rewrite. A line a translation leaves out arrives in English. /armorskinsadmin reload picks a changed language up without a restart.

Keys of skin-item and remover-item#

Keys of skin-item and remover-item

How the system's two items are drawn. Their name and lore are in messages.yml.

KeyWhat it does
materialThe item's material. For the skin item this is only used when the skin sets no icon.
glowWhether the item has the enchantment glint. Attributes are always hidden.

Keys of armor-lore#

Keys of armor-lore
KeyDefaultWhat it does
enabledtrueTurn it off and skinned armour shows only its own lore.

The lines themselves are armor-lore in messages.yml; %skin% is the skin's name. They are shown after the armour's own lore, separated by a blank line.

These lines never touch the item

They are written onto the copy that leaves the server, on every packet that carries the piece — worn, in the hotbar, in a chest or on the cursor. Any plugin reading the armour's lore finds exactly what the armour had, and /data get shows nothing extra.

Keys of behaviour#

Keys of behaviour
KeyDefaultWhat it does
modebothitem, wardrobe or both. See Set up the wardrobe.
consume-skin-itemtrueWhether the skin item is used up when it is applied. Off means one item skins any number of pieces.
consume-removertrueWhether the remover is used up when it removes a skin.
hide-without-permissiontrueWhether armour whose skin the wearer may no longer use — no node and no unlock — is drawn as the real piece. Checked when the piece is equipped and by /armorskinsadmin refresh.
disabled-worlds[]Worlds where skins are not shown: armour there is drawn as the real piece. Names are matched ignoring case.

Neither consume switch takes effect when the operation fails — a remover used on a player with a full inventory stays on the cursor. See Permissions for what hide-without-permission means in practice.

Keys of defaults#

Keys of defaults
yaml
defaults:
  helmet:
    - {permission: group.vip, cosmetic: galaxy}
    - {permission: '', cosmetic: ocean}

The skin a player wears on a piece they never chose one for, by rank. Each of helmet, chestplate, leggings and boots is a list read top to bottom: the first line the player qualifies for wins, an empty permission means everyone (keep that line last), and the skin none gives that group nothing. A default needs no permission or unlock and is never saved as the player's. In the wardrobe it is drawn as worn, marked with the wardrobe's default-marker; a player who takes a skin off keeps it off, the default included. Only used in wardrobe and both modes. A skin cannot be called none.

Keys of effects#

Keys of effects

Two moments that belong to the system rather than to a skin. Both are full ExyliaLib effects — title, action bar, boss bar, sound, particle and firework — and both are played to the player who did it.

KeyDefaultWhen
on-applyITEM_ARMOR_EQUIP_LEATHER, volume 0.7, pitch 1.2, category PLAYERSA skin was successfully dragged onto armour, or the 3D wardrobe saved.
on-removeITEM_BUNDLE_REMOVE_ONE, volume 0.7, pitch 1.0, category PLAYERSA skin was successfully taken off with a remover.

These quieter sounds are what 1.4 writes on a fresh install; a config.yml written by an earlier version keeps the sounds it has.

A refused apply plays nothing, and neither does a skin applied through the API. Effects a skin declares for itself — equip, unequip, ambient and the set bonus — live in skins.yml.

Keys of showcase#

Keys of showcase

Places that show skins off on their own, one after another, for whoever walks past: a lobby centrepiece. Nobody has to own anything or do anything.

KeyDefaultWhat it does
locations[]Where showcases stand, as server,world,x,y,z,yaw,pitch. Set them with /armorskinsadmin showcase add, which writes where you stand and the way you face.
pause-seconds3.0The rest between one skin and the next.
radius24.0How close a player has to be for a showcase to play and to see it, in blocks.
only[]The skin ids a showcase picks from. Empty picks from every skin.

Each turn a mannequin stands on the spot wearing the skin of a player watching, dressed in one skin on every piece it fits — built on plain leather, whatever the watcher really wears — with the skin's name floating above its head. It turns once, slowly, over six seconds so the skin is seen from every side, and ends facing the way the showcase was placed. An animated skin keeps animating and the skin's ambient particles are drawn around it; its sounds, titles and set messages are left out, because a showcase has no wearer to speak to.

With nobody inside radius nothing plays, so an empty lobby costs one distance check a second. A player whose cosmetics are hidden — staff on duty, for instance — is neither cast as the mannequin nor shown it.

Keys of crate and shop#

Keys of crate and shop

The crate's keys, rarities, reels and blocks, and the prices the wardrobe sells locked skins at, are covered in full on The crate.

Keys of menu#

Keys of menu
KeyDefaultWhat it does
styleCLASSICWhat /wardrobe opens. CLASSIC: the inventory menu. SPATIAL: the 3D wardrobe standing in the world, laid out in spatial/wardrobe.yml. /wardrobe 3d and /wardrobe classic open one or the other whatever this says.

ownership#

yaml
ownership:
  scope: global
  global-currencies: []

Where what a player unlocks here counts: global (every server, the default), server, default (this server's network group) or a group name. What was unlocked globally always counts. global-currencies lists currencies whose purchases count on every server whatever the scope. Restart to apply. New in v1.5.0

Every line of messages.yml#

Every line of messages.yml

Every line the plugin sends, in lang/<language>/messages.yml. %prefix% expands to the prefix value; %skin% is filled in on every message that names a skin.

KeyDefaultTokens
prefix{primary}&lE-SKINS {letters_black}•<reset>—
applied%prefix%{success}Skin {highlight}%skin% {success}applied.%skin%
removed%prefix%{success}Skin {highlight}%skin% {success}removed and returned to you.%skin%
not-armor%prefix%{error}That is not a piece of armor.—
unsupported-piece%prefix%{error}The skin {highlight}%skin% {error}does not fit that piece.%skin%
unknown-skin%prefix%{error}That skin no longer exists.%skin%
already-skinned%prefix%{warning}That armor already wears a skin. Use a remover first.—
no-skin%prefix%{warning}That armor wears no skin.—
inventory-full%prefix%{error}You need a free slot in your inventory.—
no-permission%prefix%{error}You do not own the skin {highlight}%skin%{error}.%skin%
given%prefix%{success}You received {highlight}%amount%x %skin%{success}.%skin%, %amount%
given-remover%prefix%{success}You received {highlight}%amount%x skin remover{success}.%amount%
list-header%prefix%{secondary}Available skins:—
list-entry {letters_black}▎ {info}%id% {letters_black}» {letters}%skin% {letters_black}(%pieces%)%id%, %skin%, %pieces%
list-empty%prefix%{muted}No skins are registered.—
refreshed%prefix%{success}Appearance synchronised.—
wardrobe-disabled%prefix%{error}The wardrobe is off on this server.—
feature-locked%prefix%{error}Your rank does not include that feature.—
wardrobe-cleared%prefix%{success}Your wardrobe is empty again.—
rewards-claimedItems kept for a player who had no room were handed over on join.%amount%
nothing-changedAn admin write left the wardrobe as it was.%player%
showcase-added · showcase-removed · showcase-missingshowcase add and remove.%location%
showcases-header · showcases-entry · showcases-empty · showcases-clearedshowcase list and clear.%location%, %amount%
keys-given · keys-takenkeys subcommands: to the admin, and to the player who lost keys.%player%, %amount%
unlock-granted · unlock-already · unlock-revoked · unlock-missingunlocks subcommands.%skin%, %player%
crate-block-* · crate-blocks-*crate block subcommands.%location%, %amount%
crate-descriptionThe line under a skin on the crate reels: {letters}Fits {info}%pieces%.%pieces%

Then the sections:

SectionWhat it holds
skin-item · remover-itemname and lore of the two items. %skin% and %pieces% on the skin item.
key-itemname and lore of the crate key that can be held.
armor-loreThe lines under skinned armour. %skin%.
wardrobeWhat the wardrobe calls things: full-set, helmet, chestplate, leggings, boots, empty, and piece-names — how a piece is written inside a sentence, such as the pieces a skin fits. See Set up the wardrobe.
spatialEvery word the 3D wardrobe draws, its chat lines (saved-message, save-blocked, discarded), the admin lines for placed wardrobes (spot-placed, spot-removed, spot-missing) and, under catalog, the button and status words: SAVE, BUY & SAVE, CONFIRM, revert, unequip, the crate and the tour.
crateThe crate's own lines: won, duplicate, no-keys, busy, empty, disabled, keys-received, rewards-claimed. See The crate.

What a purchase says — the confirmation, success, not enough money — is ExyliaLib's, under purchase in ExyliaLib's own messages.yml.

The prefix belongs to this plugin alone

prefix is registered with ExyliaLib on start and on every reload, so %prefix% written anywhere in this plugin's own text resolves to it. Another Exylia plugin using %prefix% gets its own — the two never collide.

The other files#

Skins live in skins.yml, animations in animations.yml, and the screens in lang/<language>/menus/: the wardrobe and the crate.

Something missing on this page? Tell us on Discord