Install ExyliaShields
Put the jars in, start the server and know which files the plugin writes.
Players can open /shields as soon as it starts, but they own no patterns or colours yet. Do Your first shield next.
Requirements#
| Server | Paper 1.21.1 or newer, or Folia 1.21.4 or newer. |
| Required | packetevents. |
| Recommended | ExyliaLib: the plugin loads without it, but the shared crate, shop, web editor and /exylialib commands come from it. |
| Optional | PlaceholderAPI, and ExyliaEconomy or Vault for the shop. |
Install#
Drop in the jars
ExyliaShields.jar, plus packetevents and, recommended, ExyliaLib, into plugins/.
Start the server
It writes config.yml, shields.yml, database.yml, the spatial/ layouts and the lang/
folders with the menus and messages in English, Spanish, Portuguese, French, Russian and Turkish,
and creates its tables.
Give them a palette
Every player can already open /shields with one slot. Next, give them a palette: see Your first shield.
Files#
| File | Contents |
|---|---|
config.yml | The language, the force system, editor defaults, showcases, the crate, the shop and which menus /shields opens. |
shields.yml | max_layers, the 43 patterns and the 16 colours, each with its rarity. |
lang/<code>/shields.yml | The pattern and colour names in that language, laid over the English ones. A server that already has its own shields.yml keeps its edits. |
screens/*, lang/<code>/screens/main.yml | The shield screens used when ExyliaLib's menu style is SCREEN, and their words. A file that cannot be read falls back to the inventory menus. |
lang/<code>/messages.yml | Every message, plus the words the menus draw and the crate key's name and lore. |
lang/<code>/menus/slots.yml | The slot screen. |
lang/<code>/menus/design_editor.yml | The editor. |
lang/<code>/menus/color_picker.yml | The colour picker. |
lang/<code>/menus/community_browser.yml | The shared library. |
lang/<code>/menus/crate.yml | The crate's first screen: how many to open at once. |
lang/<code>/menus/crate_open.yml | The reels falling, one column per crate. |
spatial/designer.yml, spatial/wardrobe.yml, spatial/community.yml | The 3D menus' layouts. |
spatial/crate.yml | The 3D crate opening's layout, written the first time it is used. |
database.yml | Where everything is stored. H2 by default. |
Tables#
| Table | Holds |
|---|---|
player_shield_data | Each player's slots and which one is active. |
shield_design_library | Designs registered for sharing, with an owner and a use count. |
shield_design_uses | Who has used which library design. |
exylia_crate_players | ExyliaLib's: each player's crate keys and the patterns and colours they won or bought. |
Every table is classified as account data, so ExyliaLib's /exylialib wipe and
/exylialib resetplayer cover them. See ExyliaLib's commands.
Updating#
Replace the jar and restart. /shieldsadmin reload re-reads this plugin's own files, the messages and menus
of the language in use included.
Something missing on this page? Tell us on Discord