Customise the trim menu
The classic inventory screen: armor along the top, the patterns and then the materials in the grid, all of it editable in lang/<language>/menus/trims.yml.
Open the classic trim menu, see what each button does, and change its layout and words. It is one inventory window: the armor along the top, the patterns and then the materials below.
/armortrim opens it while behaviour.menu-style is classic, the default. With spatial it opens the 3D wardrobe instead, except for a client older than 1.21.4 or a player without exyliaarmortrims.wardrobe, who always get this screen.
Before you start#
behaviour.mode must be menu or both. With item there is no menu: /armortrim answers that it is off. See Choose how trims are worn. The player needs exyliaarmortrims.command.armortrim, which everybody has by default.
Steps#
Open the menu
Run /armortrim.
Choose what to engrave
Along the top, left click a piece, or FULL SET for all four. The marked one is being engraved. Right click a piece to take its trim off.
Pick a pattern
The grid opens on the patterns, never on the materials of a pattern chosen earlier. Left click one.
Pick a material
The grid moves to the materials, already previewed with that pattern. Left click one and the trim goes on. Click the material that is already worn to take it off.
Check that it works#
The armor along the top shows the trim you chose and the armor on your body shows it too. Close the menu and reopen it: your choice is still there. If entries are locked, you do not own them yet: see Common problems.
Going further#
The fixed buttons#
| Button | Slot | What it does |
|---|---|---|
| BARE EVERYTHING | 45 | Takes the trim off all four pieces. |
| PATTERN | 49 | The step the grid is on and the pattern chosen; a click goes back to the patterns. |
| FILTER | 52 | Switches the grid between every pattern and material and only the ones the player owns. The choice is remembered while the server runs. |
| TRIM CRATE | 53 | Opens the crate, showing the player's keys and how much of the catalogue they unboxed. |
| Previous / next | 48 / 50 | Grid pagination. |
There is no close button: ESC closes.
Change the layout or the words#
The window is drawn from lang/<language>/menus/trims.yml. Edit it and run /armortrimsadmin reload. An untouched file is replaced on update; an edited one waits in /exylialib updates. See Menus for the shared menu format.
The materials are drawn on the armor the player is really wearing, so a netherite chestplate previews the trim on netherite. The patterns are drawn as their own smithing template, because at that point no material has been picked. Swap %entry_icon% back to %preview_material%, with an armor_trim block, to preview them on armor too.
Screens instead of a chest#
On a server whose menu style is SCREEN (ExyliaLib's screens.yml), the same menu opens as a native screen read from screens/trims.html, with its words in lang/<language>/screens/trims.yml: the player's own armor stands in a window and tries on whatever trim is hovered. The crate and its opening are screens too. A file that cannot be read falls back to this chest menu.
Wording#
The few strings a template cannot spell out slot by slot live under menu in messages.yml:
menu:
full-set: "{primary}&lFULL SET"
helmet: "{primary}&lHELMET"
chestplate: "{primary}&lCHESTPLATE"
leggings: "{primary}&lLEGGINGS"
boots: "{primary}&lBOOTS"
empty: "{muted}Nothing"
custom-name: "{primary}&l%pattern% {letters_black}» {secondary}&l%material%"
piece-names:
helmet: "Helmet"
chestplate: "Chestplate"
leggings: "Leggings"
boots: "Boots"custom-name is what every trim is called. piece-names is how a piece is written inside a sentence or a list.
With mode: item the trim screen and the wardrobe do not exist. The crate's two screens, menus/crate.yml and menus/crate_open.yml, are there in every mode. See Set up the crate.
Sections, clicks and templates
| Section | Default slots | What it holds |
|---|---|---|
targets | 2,3,4,5,6 | FULL SET and the four pieces. The marked row is what is being engraved. |
grid | 10-16,19-25,28-34,37-43 | What can go on it: the patterns, then the materials. |
| Where | Click | Result |
|---|---|---|
| A piece along the top | Left | Engraves that piece from now on. |
| A piece along the top | Right | Takes its trim off. |
| A pattern in the grid | Left | Takes it as the first half and moves to the materials. |
| A material in the grid | Left | Puts that trim on, or takes it off when it was already the one worn. |
With FULL SET focused, the trim goes on all four pieces.
The first template of a list is what a row in no particular state uses, so item_template goes first.
| List | Templates |
|---|---|
targets | item_template, focused_template, set_template, focused_set_template |
grid pattern rows | pattern_template, pattern_selected_template, pattern_locked_template, pattern_purchasable_template |
grid material rows | material_template, material_selected_template, material_locked_template, material_purchasable_template |
locked is a half the player does not own. purchasable is a locked one the shop sells to them, with its price; clicking it buys it. A file edited before the shop existed has no purchasable templates, and draws those entries as locked. none_owned_template is what the grid shows when the owned-only filter leaves nothing.
Placeholders in the file
These are the menu'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 and then one row per piece, and each kind carries its own tokens.
| Placeholder | Where | What it draws |
|---|---|---|
%target% | targets, anywhere | What is being engraved: a piece key, or set for the full set. |
%target_name% | targets, anywhere | Its name from menu: full-set, or the piece's own name. |
%engraved% | targets, full-set row | How many of the four pieces carry a trim. |
%pieces% | targets, full-set row | How many pieces there are in total — four. |
%piece% | targets, piece rows | The piece's key: helmet, chestplate, leggings or boots. |
%piece_material% | targets, piece rows | The material the player is actually wearing in that slot. |
%trim_name% | targets, piece rows | The trim chosen for that piece, or menu.empty. |
%trim_pattern% | targets, piece rows | That trim's pattern, empty when the piece carries none. |
%trim_material% | targets, piece rows | That trim's metal, empty when the piece carries none. |
%entry_id% | grid | The row's id: a pattern id, or a pattern/material pair. |
%entry_name% | grid | Its display name. |
%entry_icon% | grid | The material the row is drawn as. |
%preview_material% | grid | The armor piece the row is previewed in. |
%trim_pattern% | grid | The pattern this row would engrave. |
%trim_material% | grid | The metal this row would engrave. |
%entry_worn% | grid | The pieces the player already wears it on, empty when none. |
%entry_worn_name% | grid | The same, but menu.empty when none. |
%price% | grid · purchasable | What it costs, written the way its currency writes it. |
%entry_buy% | grid · purchasable | The id armortrim:buy takes: pattern:<id> or material:<id>. |
%material_name% | grid · materials | The metal's display name. |
%pattern_name% | grid · materials, anywhere | The chosen pattern's display name, or menu.empty before one is chosen. |
%tab% | Anywhere | The step being shown: patterns or materials. |
%pattern% | Anywhere | The chosen pattern's id, empty before one is chosen. |
%filter_status% | Anywhere | What the filter shows now, as written under menu.filter-all and menu.filter-owned in messages.yml. |
%keys% | Anywhere | The crate keys the player holds. |
%unlocked_count% | Anywhere | How many prizes they unlocked. |
%catalogue_count% | Anywhere | How many prizes the crate holds. |
Actions
The verbs in the armortrim namespace:
| Action | What it does |
|---|---|
armortrim:open | Opens what /armortrim opens: the 3D wardrobe or this menu, as menu-style picks. |
armortrim:focus <piece|set> | Changes what is being engraved. |
armortrim:patterns | Goes back to the patterns. armortrim:tab, which files from before 1.5.0 call, does the same. |
armortrim:pattern <id> | Takes the first half and moves to the materials. |
armortrim:wear <pattern/material> | Puts that trim on, or takes it off. |
armortrim:clear <piece|set> | Takes the trim off one piece or all of them. |
armortrim:buy <id> | Buys a locked pattern or material: asks to confirm, charges and unlocks it, then reopens the screen. Needs exyliaarmortrims.buy. |
armortrim:filter | Switches the grid between everything and owned only. |
armortrim:crate | Opens the crate. |
The screen's own verbs act on the window the click came from, so a player with the menu open twice cannot move the wrong one.
Something missing on this page? Tell us on Discord