Installation
The jars, the files it writes, and the tables it uses.
Installing#
Drop in the jars
ExyliaKillEffect.jar and packetevents into plugins/. ExyliaLib is a soft depend — the
loader installs it on the first start if it is not there.
Start the server
It writes config.yml, database.yml and the lang/ folders with effects.yml, the menus and
messages in English, Spanish, Portuguese, French, Russian and Turkish, and creates its tables.
Grant the permissions
Nothing is usable until players can open the menu and own at least one effect. See Permissions.
Files#
| File | Contents |
|---|---|
config.yml | The language, behaviour, the items' materials, the crate, the shop, showcases, feedback and visibility. |
lang/<code>/effects.yml | The five categories and the 110 effects. Hand-written, not schema-managed: your comments and your layout survive a reload. |
lang/<code>/messages.yml | Every message, plus the items' names and lore, the weapon lines and the menu's wording. |
lang/<code>/menus/effects.yml | The main screen: tabs, grid, templates and buttons. |
lang/<code>/screens/effects.yml | The words of the screen the 3D-capable menu style draws. Styling is screens/effects.html and screens/theme.css. |
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/effects.yml | Where every piece of the 3D selector stands. |
database.yml | Where selections are stored. H2 by default. |
config.yml is written from a schema, so an unknown key is dropped and comments are regenerated.
effects.yml is not: it is a catalogue a server owner curates, and it is read exactly as written.
The tables#
killeffect_players, one row per player:
| Column | What it holds |
|---|---|
uuid | The player. |
name | Their last known name. |
killEffect | The effect they chose, random for the random choice, or empty. |
particleVisibility | ALL, NONE, SELF_ONLY or OTHERS_ONLY. |
favourites | The effects they starred, comma-separated, in their own order. |
unlocked / crate_keys | What the crate kept here before 1.7.0. Read once per player and never written again. |
created_at / updated_at | When the row was made and last written. |
Crate keys and the effects a player won or bought live in ExyliaLib's exylia_crate_players, in the
same database, one row per player per plugin. The first time a player is seen after updating, their
old crate_keys and unlocked are carried across, so nobody loses a key or an effect; the old
columns are left in place so a rollback still finds them.
Ids are stored lowercase and read back without regard to case, so a row written by an older version — which stored them in upper case — still resolves.
A starred id the catalogue no longer declares is kept in the column and dropped where it is drawn, so a typo in a reload does not empty anybody's shortlist.
killeffect_players is declared to ExyliaLib as @account data, owned by the uuid column, so
/exylialib resetplayer and /exylialib wipe cover it: removed only when @account is named, kept by a
season wipe. See ExyliaLib · Commands.
Updating#
Replace the jar and restart. /killeffectsadmin reload re-reads config.yml, the catalogue, the
messages and the menus without touching the rest of the server — it deliberately does not reload the library, which is
what /exylialib reload is for.
Check that it works#
The console shows ExyliaKillEffect enabled with no error, and /killeffectsadmin list prints the effects. If it does not load, see Common problems.
Something missing on this page? Tell us on Discord