Content generated with AI — it may contain mistakes.

ExyliaArmorTrims/ReferenceUpdated in v1.6.0

Configuration

Every block of config.yml and messages.yml, with what they ship with.

Page 12 of 217 min read
      - {permission: group.vip, cosmetic: silence/gold}    - {permission: '', cosmetic: sentry/iron}      

config.yml holds the settings and lang/<language>/messages.yml everything a player reads. The trims themselves live in trims.yml — see Trims.

language#

yaml
language: default

Which folder under lang/ the menus and messages are read from. default follows the language set in ExyliaLib's own config.yml; en, es, pt, fr, ru or tr set this plugin alone. A server that ran the plugin before it was translated has its old messages and menus/ moved to lang/custom/, and language: custom is written so nothing it edited is lost.

behaviour#

yaml
behaviour:
  mode: both
  consume-remover: true
  consume-trim-item: true
  hide-without-permission: true
  disabled-worlds: []
  menu-style: classic
KeyDefaultWhat it does
modebothWhere a trim comes from: item, menu or both.
consume-trim-itemtrueWhether the trim item is used up when applied.
consume-removertrueWhether the remover is used up when it removes a trim.
hide-without-permissiontrueWhether armor whose trim the wearer does not own is shown as it really is.
disabled-worlds[]Worlds where trims are not shown: armor there looks as it really is. Names are matched ignoring case.
menu-styleclassicWhat /armortrim opens: classic, the inventory menu, or spatial, the 3D wardrobe. /armortrim wardrobe opens the 3D one either way.

Covered in Modes and items.

require-permission is gone

The menu always asks whether the player owns a trim, and a trim item never does: holding one is the proof of ownership. A require-permission key left in an older file is dropped on load.

defaults#

yaml
defaults:
  helmet:
    - {permission: group.vip, cosmetic: silence/gold}
    - {permission: '', cosmetic: sentry/iron}
  chestplate: []
  leggings: []
  boots: []

The trim a player wears on a piece they never picked one for, by rank. Each piece reads its list top to bottom and the first line the player qualifies for wins. An empty permission is everyone; a cosmetic of none gives that group nothing. A cosmetic is pattern/material. Nothing is stored or unlocked: the rank is read each time the trim is drawn, the player can still pick their own or take it off, and the trim shows even if they do not own it. All four lists are empty by default. It applies when behaviour.mode is menu or both (in both, only on armor without a trim of its own). The menu marks a piece wearing its default.

trim-item and remover-item#

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

yaml
trim-item:
  material: NETHERITE_UPGRADE_SMITHING_TEMPLATE
  glow: true
 
remover-item:
  material: SCRAPE_POTTERY_SHERD
  glow: true
KeyWhat it does
materialThe icon.
glowThe enchantment shimmer.

If the icon is a piece of armor it is painted with the trim it carries, so the item previews itself.

armor-lore#

yaml
armor-lore:
  enabled: true

Whether lines are added under trimmed armor. The lines themselves are armor-lore in messages.yml. Only the client sees them: they travel on the visual and are never written to the real item, so a plugin reading the armor's lore finds exactly what it had.

effects#

yaml
effects:
  on-apply:
    sound:
      name: BLOCK_SMITHING_TABLE_USE
      volume: 1.0
      pitch: 1.2
      category: PLAYERS
  on-remove:
    sound:
      name: BLOCK_GRINDSTONE_USE

ExyliaLib effects: title, actionbar, bossbar, sound, particle and firework. They play to whoever put the trim on or took it off, from the menu or with an item.

showcase#

How to place them and what they do is in Add trim showcases.

Places that show trims off on their own, one after another, for whoever walks past: a lobby centrepiece rather than something a player asked for.

yaml
showcase:
  locations: []
  pause-seconds: 3.0
  radius: 24.0
  only: []
KeyDefaultWhat it does
locations[]Where showcases stand. Set them with /armortrimsadmin showcase add, which writes where you stand and the way you face.
pause-seconds3.0The rest between one turn ending and the next starting.
radius24.0How close a player has to be for a showcase to play and to be seen, in blocks.
only[]The trims a showcase picks from, as pattern/material. Empty picks from every combination the catalogue offers.

Each turn a body wearing a watcher's skin stands on the spot in a full diamond set wearing one trim, turns once on the spot over six seconds and ends facing the crowd, with the trim's name floating above it. Only the players within radius see it, and a player whose cosmetics are hidden is neither cast as the body nor shown one. With nobody near, nothing plays.

Preset ids in only

A list written before 1.5.0 with preset ids — only: [shogun] — matches nothing any more, and the showcase stays empty. Rewrite it as pattern/material values, or empty it.

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.6.0

crate and shop#

The crate's settings — crate.enabled, keys, reward, the reels or the 3D opening, the bound blocks, the key item and the rarities under crate.tiers — and the shop block that sells locked entries for currency are covered in The crate.

messages.yml#

lang/<language>/messages.yml holds every line the plugin sends and every word on its items. Chat lines start with %prefix%.

KeyWhen it shows
prefixThe prefix the others use.
applied · removedA trim put on or taken off. %trim%.
not-armorAn item was dropped onto something that is not armor.
unknown-trimThe trim no longer exists.
already-trimmedThe piece already carries a trim: use a remover first.
no-trimThe piece carries nothing to remove.
inventory-fullA free slot is needed to hand the item back.
no-permissionThe player does not own that trim.
feature-lockedA feature node is denied: the wardrobe, the shop or the crate.
given · given-removergive and remover. %amount%, %trim%.
refreshedrefresh.
menu-disabledThe menu is off because of the mode.
clearedclear left the armor bare.
nothing-changedset or clear left the player's trims as they were. %player%.
rewards-claimedItems that were waiting were handed over on join. %amount%.
showcase-* · showcases-*The showcase subcommands. %location%, %amount%.
keys-given · keys-takenThe keys subcommands. %player%, %amount%.
unlock-granted · unlock-already · unlock-revoked · unlock-missingThe unlocks subcommands. %trim%, %player%.
crate-block-* · crate-blocks-*The crate block subcommands. %location%, %amount%.
crate-pattern-name · crate-material-nameWhat the crate calls a pattern or a material it hands out on its own. %name%.
crate-pattern-description · crate-material-descriptionThe line under a prize on the reels.
trim-item · remover-item · key-itemEach item's name and lore. The trim item takes %trim%, %pattern% and %material%.
armor-loreThe lines under trimmed armor. %trim%.
menuThe words the trim screen fills in — see The menu.
placeholders.noneWhat any %exyliaarmortrims_...% with nothing to answer returns. None.
wardrobeEvery word of the 3D wardrobe, its admin lines, and the centre stage's under wardrobe.stage.
crateThe crate's own lines: won, duplicate, no-keys, busy, empty, disabled, keys-received.

English, Spanish, Portuguese, French, Russian and Turkish ship; a line a translation leaves out arrives in English.

Unknown keys are removed

A key the file does not declare is dropped on load and reported once. It keeps the files clean between versions, and it is why your own keys do not survive in them.

Something missing on this page? Tell us on Discord