Content generated with AI — it may contain mistakes.

ExyliaArmorSkin/Getting startedUpdated in v1.4.1

Installation

Dependencies, the files it writes on first start, the wardrobe table, and what updating covers.

Page 2 of 215 min read

Install the jars, start the server once, and ExyliaArmorSkin writes its files and is ready to give skins. This takes about two minutes.

Before you start#

RequirementNotes
Paper 1.21.1 or newerapi-version: '1.21'. Built against the Paper 1.21.4 API, and runs from 1.21.1 through ExyliaLib's version layer. Folia needs 1.21.4 or newer.
Java 21The jar is compiled for 21.
Paper, or FoliaIt uses Paper's armour-change event and sendEquipmentChange. Folia is supported (folia-supported: true).
ExyliaLibConfiguration, text, items, effects and tasks.
packeteventsRequired. Equipment, set-slot and window-items packets are rewritten through it.
PlaceholderAPIOptional. For %placeholders% inside the item name and lore, and for this plugin's own crate placeholders.
ExyliaEconomy or VaultOptional. The currency the wardrobe shop charges in. Without either, nothing is for sale.

Steps#

Drop in the jars

ExyliaArmorSkin.jar, plus ExyliaLib and packetevents, into plugins/. PlaceholderAPI is optional: it resolves %placeholders% written in the item names and lore, and serves this plugin's own placeholders. ExyliaEconomy or Vault is optional too: only the shop needs one.

Start the server

It writes config.yml, skins.yml, animations.yml and the lang/ folder under plugins/ExyliaArmorSkin/, and opens database.yml for the crate. While the wardrobe is on it also creates the wardrobe table.

Give yourself a skin

/armorskinsadmin give <you> galaxy, then drag the item onto a chestplate in your inventory.

Edit the files

Add or change skins in skins.yml and animations in animations.yml, then /armorskinsadmin reload.

packetevents is a hard dependency

It is declared as depend, so the server refuses to enable this plugin without it. The whole plugin is a packet rewrite — there is nothing it can do without it. ExyliaLib is declared as softdepend for load ordering, but the plugin is built on it and will not work without it either.

Check that it works#

The console shows ExyliaArmorSkin enabled with no errors, and plugins/ExyliaArmorSkin/ holds config.yml, skins.yml and animations.yml. /armorskinsadmin list lists the skins. Then do Your first skin.

Going further#

Update it#

Replace the jar and restart. /armorskinsadmin reload re-reads those files, rebuilds every skin and redraws everyone online, so a colour change is visible without anybody re-equipping.

Change the language#

language in config.yml picks the files under lang/. default follows ExyliaLib's language; English, Spanish, Portuguese, French, Russian and Turkish are shipped (en, es, pt, fr, ru, tr), and any other code starts from the English files.

Files it writes
FileContents
config.ymlThe language, how the items are drawn, the behaviour switches, the effects, showcases, the crate and the shop.
skins.ymlThe skins themselves, keyed by id, with their rarity and price.
animations.ymlNamed animations a skin can refer to.
lang/<language>/messages.ymlEvery line the plugin sends, the item names and lore, the armour lore and the wardrobe wording.
lang/<language>/menus/wardrobe.ymlThe wardrobe screen: the armour row, the skin grid, its templates and buttons. Loaded only while the wardrobe is on.
lang/<language>/menus/crate.yml · crate_open.ymlThe crate's two screens: how many to open, and the reels.
spatial/wardrobe.ymlWhere every piece of the 3D wardrobe stands.
spatial/crate.yml · spatial/spots.ymlThe 3D crate opening's look, written by ExyliaLib; the placed 3D wardrobes.
database.ymlWhere crate keys, unlocks and wardrobes are stored. H2 by default.

<language> is language in config.yml: default follows ExyliaLib's own language. English, Spanish, Portuguese, French, Russian and Turkish are shipped (en, es, pt, fr, ru, tr); any other code starts from the English files.

Coming from 1.0

1.0 kept its screen in menus/wardrobe.yml and every message in config.yml. On the first start of 1.2 the old menu moves to lang/custom/menus/ and language is set to custom, so the server keeps the screen it had edited. The item names and lore, the armour lore lines and the wardrobe wording move from config.yml into lang/custom/messages.yml with your values. The old messages: block is not carried over: those lines start again from the defaults, so copy any you had reworded. Set language to default or a code to switch to the shipped translations.

Where data is stored

armorskin_wardrobe, one row per player: the uuid and one column per piece — helmet, chestplate, leggings, boots — each holding a skin id or nothing.

It is only read and written while the wardrobe is on (behaviour.mode is wardrobe or both). On an item server the only thing written outside the files is the skin id on the armour itself.

A skin id in a column that skins.yml no longer declares simply draws nothing — the row is left alone, and the look returns if the skin comes back.

The crate keeps one row per player in exylia_crate_players, ExyliaLib's crate table, in this plugin's database: the keys they hold and the skins they unlocked. It is used in every mode.

Skin items, removers and keys that did not fit in an inventory wait in the reward queue in the same database and are handed over on the player's next join.

Something missing on this page? Tell us on Discord