Content generated with AI — it may contain mistakes.

ExyliaArmorTrims/Getting startedUpdated in v1.5.1

Install ExyliaArmorTrims

Dependencies, the files it writes, and what it keeps in the database.

Page 2 of 214 min read

You will end with ExyliaArmorTrims running, its files written and the first trim ready to give. Nothing needs editing: the defaults work.

Before you start#

A Paper 1.21.1+ or Folia 1.21.4+ server, and the packetevents jar. ExyliaLib is installed for you if it is missing.

Steps#

Drop the jars in

Put ExyliaArmorTrims.jar and packetevents in plugins/. ExyliaLib is a soft depend: if it is missing, the loader installs it on the first start.

Start the server

It writes config.yml, trims.yml and the language files under lang/.

Pick the mode

behaviour.mode in config.yml is both by default. Leave it unless you want only items (item) or only the menu (menu). See Choose how trims are worn.

Grant the permissions

Everybody can open the menu, the wardrobe, the crate and the shop by default. Patterns and materials stay locked until a node, a crate unlock or a purchase hands them over. See Permissions.

Check that it works#

Run /armortrimsadmin give <your name> sentry/netherite 1 in game, pick the item up on the cursor and click a piece of armor in your inventory. You should see the trim on it, and the item is used up. Then /armortrim opens the menu. See Your first trim.

Going further#

Change the language#

language in config.yml is default, which follows ExyliaLib's language. en, es, pt, fr, ru and tr ship; any other code starts from the English files. Each one is a folder under lang/ you can edit.

Update the plugin#

Replace the jar and restart. /armortrimsadmin reload re-reads config.yml, messages.yml, trims.yml and the menus, and redraws everybody online.

Coming from 1.4 or older

The first start of 1.5.0 moves the presets: section out of trims.yml into legacy-presets.yml. Armor and rows carrying a preset id keep its look, and crate unlocks of a preset become unlocks of its two halves. Preset permission nodes are no longer read: grant the pattern and material nodes instead. See Coming from presets.

Coming from 1.1 or older

The first start sets language: custom and moves menus/trims.yml to lang/custom/. The strings that lived in config.yml (messages, item names and lore, armor lore, menu wording and the placeholder fallback) move to lang/custom/messages.yml, so nothing you edited is lost. Set language to default to use the shipped translations instead.

Files it writes
FileContents
config.ymlThe language, the mode, how the items are drawn, effects, showcases, the crate and the shop.
trims.ymlThe patterns and materials on offer, and each one's rarity and price.
lang/<language>/messages.ymlEvery line the plugin sends, the items' names and lore, and the menu wording.
lang/<language>/menus/trims.ymlThe classic trim screen.
lang/<language>/menus/crate.yml, crate_open.ymlThe crate's two screens.
spatial/wardrobe.ymlWhere each piece of the 3D wardrobe stands. Its words are in messages.yml.
spatial/spots.ymlThe wardrobes placed in the world with /armortrimsadmin wardrobe place.
legacy-presets.ymlWritten once when a server coming from 1.4 or older starts: the presets trims.yml had, as pattern/material. Data, not configuration: do not edit it.
database.ymlWhere the rows below are stored. H2 by default.

<language> is language in config.yml, or ExyliaLib's own when that is default.

The database

Opened in every mode: crate keys and unlocks live in ExyliaLib's exylia_crate_players table, and items that did not fit in an inventory wait in exylia_pending_rewards until the player's next join.

With menu or both, choices also live in the armortrim_selection table, one row per player:

ColumnWhat it holds
uuidThe player.
helmet, chestplate, leggings, bootsA pattern/material pair, such as sentry/netherite.

A row written while presets existed still holds a preset's bare id; it is rewritten to the look that preset stood for the first time the row loads. A value the catalogue does not know, such as a pattern you removed from trims.yml, is not drawn and is not cleaned up. It comes back the day the entry does.

Wipes and player resets

Every table declares what it holds, so ExyliaLib's /exylialib wipe and /exylialib resetplayer cover them without a command of this plugin's own.

TableKind
armortrim_selection@account: a player's choices survive a season.
exylia_crate_players@account: crate keys and unlocks.
exylia_pending_rewards@progress: items waiting for a join.

A plain resetplayer clears progress, world and cache only, so a player's trims and unlocks stay. Name @account to take them too: /exylialib resetplayer Steve ExyliaArmorTrims @account. See Commands in ExyliaLib.

Something missing on this page? Tell us on Discord