Installation
Drop in two jars, start the server and have a working menu. The files it writes and the tables it uses.
Two jars and one restart give you a working /hiteffect menu with 90 effects. The only thing left is letting players own one.
Before you start#
You need Paper 1.21.1 or newer (Folia 1.21.4 or newer) and the packetevents jar. The full list is in Introduction.
Install it#
Drop in the jars
ExyliaHitEffect.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, effects.yml, database.yml and the lang/ folders with the menus and
messages in English, Spanish, Portuguese, French, Russian and Turkish, and creates its tables.
Grant the permissions
The menu, previews, favourites, random, visibility, the shop and the crate are open to everybody out of the box; what players still need is at least one effect, from a rank, the crate or the shop. See Permissions.
Check that it works#
- The console prints no error for ExyliaHitEffect and
plugins/ExyliaHitEffect/now holdsconfig.yml,database.ymland alang/folder. - In game,
/hiteffectopens the menu. - Give yourself an effect (a rank permission or a crate key) and hit a mob: the effect plays on it. The full walk-through is Your first hit effect.
Going further#
Edit in game#
Every setting in config.yml can be changed from a menu: the SETTINGS button in the admin hub
(/hiteffectsadmin) opens ExyliaLib's settings screens for this plugin. effects.yml is offered there
too, and in the browser through ExyliaLib's web editor
(/exylialib editor ExyliaHitEffect). In game exyliahiteffect.admin is enough; the browser editor
also needs ExyliaLib's exylialib.editor (op by default) for the catalogue. An edit to the catalogue is
checked with the plugin's own loader first: a change that would cost the file a category or an effect
is refused whole, and once applied the effects, the crate, the showcases and any open 3D selector pick
it up without a reload.
Update#
Replace the jar and restart. /hiteffectsadmin reload re-reads config.yml, effects.yml, the
messages, the menus and the 3D selector's layout without touching the rest of the server — it deliberately does not reload the library, which is
what /exylialib reload is for.
Files it writes
| File | Contents |
|---|---|
config.yml | The language, behaviour, the items' materials, the crate, the shop, showcases, feedback and visibility. |
lang/<code>/effects.yml | The six categories and the 90 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. |
spatial/crate.yml | The look of the 3D crate opening, used with crate.opening: SPATIAL. |
spatial/spots.yml | The 3D selectors placed in the world with /hiteffectsadmin spatial place. |
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.
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
hiteffect_players, one row per player:
| Column | What it holds |
|---|---|
uuid | The player. |
name | Their last known name. |
hitEffect | The effect they chose, 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.4.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.
Both tables are classified as @account data, so ExyliaLib's
/exylialib wipe and
/exylialib resetplayer cover them. A season wipe
(@season) leaves them alone: name @account to take a player's effects, keys and unlocks.
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.
Something missing on this page? Tell us on Discord