Configuring

Modes and items

Where a piece's trim comes from — the item or the player — and what the trim item and remover do.

The three modes

behaviour.mode decides where the trim that gets drawn comes from:

Mode	Where it comes from	What it means
`item`	Only what a trim item wrote onto the armor.	The trim is traded, lost on death and sold as an item. No database and no menu are opened.
`menu`	Only what the player picked in `/armortrim`.	It follows the player, not the armor. Trim items do nothing.
`both`	The armor's own trim, and the menu's choice for armor that carries none.	The default.

In both the armor wins: an engraved piece is drawn with its own trim, and the menu's choice only fills the bare pieces.

config.yml

behaviour:
  mode: both
  consume-remover: true
  consume-trim-item: true
  require-permission: true
  hide-without-permission: true

The trim item

An item carrying a trim inside it. It is applied by dropping it onto a piece of armor in your own inventory: pick it up on the cursor and click the piece.

Rule	Detail
Armor only	Anything else is ignored, and the click carries on as normal.
One at a time	A piece that already carries a trim is refused: take it off with a remover first.
Supported pieces	A preset with a limited `pieces` list will not go onto a piece it does not fit.
Permission	With `require-permission` on the trim's node is needed; without it, anyone holding the item may use it.
Consumption	`consume-trim-item` decides whether it is used up. Off, the item is reusable.

What is written onto the armor is one value: exyliaarmortrims:trim, the preset id or the pattern/material pair. The vanilla trim and everything else are left alone; the engraving is drawn on the way to the client.

A trim item is not the item it is drawn as

Trim items and removers are inert: drawn as an ender pearl one cannot be thrown, drawn as food it cannot be eaten. Whatever it looks like, it can only be dropped onto armor.

The remover

Dropped the same way, onto a trimmed piece. The trim comes off and is handed back as a trim item to whoever removed it.

Rule	Detail
A free slot	Without a free inventory slot nothing happens and it says so: the armor is not touched until the item fits.
Consumption	`consume-remover` decides whether the remover is used up.
Unknown trim	A trim the registry no longer knows is refused rather than turned into nothing.

Both items are drawn from config.yml — trim-item and remover-item — and are recognised by their data, never by name or material, so renaming them breaks nothing.

Permissions and the look

Setting	What it does
`require-permission`	Whether wearing a trim needs its node. Commands and the API are never limited by this.
`hide-without-permission`	Whether armor whose trim the wearer may no longer use is shown as it really is.

With both on — the default — an expired rank stops seeing the trim but loses nothing: the value is still on the armor and in their row, and the look returns with the node.

Effects

One effect when a trim goes on and one when it comes off, for the menu and for the items alike:

config.yml

effects:
  on-apply:
    sound:
      name: BLOCK_SMITHING_TABLE_USE
      pitch: 1.2
  on-remove:
    sound:
      name: BLOCK_GRINDSTONE_USE

They are full ExyliaLib effects: title, action bar, boss bar, sound, particles and fireworks.

Something missing on this page? Tell us on Discord