Content generated with AI — it may contain mistakes.

ExyliaShields/Getting startedUpdated in v1.5.0

Install ExyliaShields

Put the jars in, start the server and know which files the plugin writes.

Page 2 of 202 min read

Players can open /shields as soon as it starts, but they own no patterns or colours yet. Do Your first shield next.

Requirements#

ServerPaper 1.21.1 or newer, or Folia 1.21.4 or newer.
Requiredpacketevents.
RecommendedExyliaLib: the plugin loads without it, but the shared crate, shop, web editor and /exylialib commands come from it.
OptionalPlaceholderAPI, 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#

FileContents
config.ymlThe language, the force system, editor defaults, showcases, the crate, the shop and which menus /shields opens.
shields.ymlmax_layers, the 43 patterns and the 16 colours, each with its rarity.
lang/<code>/shields.ymlThe 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.ymlThe 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.ymlEvery message, plus the words the menus draw and the crate key's name and lore.
lang/<code>/menus/slots.ymlThe slot screen.
lang/<code>/menus/design_editor.ymlThe editor.
lang/<code>/menus/color_picker.ymlThe colour picker.
lang/<code>/menus/community_browser.ymlThe shared library.
lang/<code>/menus/crate.ymlThe crate's first screen: how many to open at once.
lang/<code>/menus/crate_open.ymlThe reels falling, one column per crate.
spatial/designer.yml, spatial/wardrobe.yml, spatial/community.ymlThe 3D menus' layouts.
spatial/crate.ymlThe 3D crate opening's layout, written the first time it is used.
database.ymlWhere everything is stored. H2 by default.

Tables#

TableHolds
player_shield_dataEach player's slots and which one is active.
shield_design_libraryDesigns registered for sharing, with an owner and a use count.
shield_design_usesWho has used which library design.
exylia_crate_playersExyliaLib'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