Install ExyliaArrows
Drop in the jars, start the server and check the plugin is running. Includes the files it writes and the database tables it uses.
After this page ExyliaArrows is running on your server, with its menus and 120 effects written to disk and its database ready. Nothing needs editing for a first test.
Before you start#
You need a Paper server (see the requirements) and the packetevents plugin. ExyliaLib is installed for you on the first start if it is missing.
Steps#
Drop in the jars
Put ExyliaArrows.jar and packetevents into plugins/. ExyliaLib is a soft dependency: if it is not there, the loader installs it on the first start.
Start the server
The plugin 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.
Let players open the menu
Everybody can run /arrows by default, but a player owns no effect until you give one. Operators own all of them. See Your first effect and Permissions.
Check that it works#
Run /arrows as an operator. The effect menu opens. Then run /arrowsadmin list: it prints every effect the server declares. If the menu does not open or nothing is listed, see Common problems.
Going further#
- Change the language.
languageinconfig.ymlpicks the folder underlang/.defaultfollows ExyliaLib's own language. See Configuration. - Choose a database. H2 is the default and needs nothing. For MySQL, MariaDB, PostgreSQL or MongoDB see Database setup.
- Update. Replace the jar and restart.
/arrowsadmin reloadre-readsconfig.yml,effects.yml, the messages and the menus without touching the rest of the server. It does not reload the library: that is/exylialib reload.
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 you curate and it is read exactly as written. An update adds the effects it ships that your file does not have yet; a value you changed is never touched, and a shipped value that changed under one you left alone is listed in /exylialib updates for you to apply or keep.
Files the plugin writes
| File | Contents |
|---|---|
config.yml | The language, behaviour, projectiles, trails, the items' materials, rarities, the crate, the preview stage, showcases, feedback, visibility and the shop. |
lang/<code>/effects.yml | The six categories and the 120 effects, one catalogue per language. Hand-written, not schema-managed: your comments and layout survive a reload. A server that had effects.yml in the data folder keeps its edits: the file is adopted into the language folder on the first start. |
lang/<code>/messages.yml | Every message, plus the items' names and lore, the bow lines and the menu's wording. |
lang/<code>/menus/effects.yml | The main screen: tabs, grid, templates and buttons. |
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 each piece of the 3D selector stands. |
database.yml | Where data is stored. H2 by default. |
<code> is the language in config.yml.
Database tables
arrows_players, one row per player:
| Column | What it holds |
|---|---|
uuid | The player. |
name | Their last known name. |
effectId | 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 up to 1.3.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 from 1.3.0, their old crate_keys and unlocked are carried across, so nobody loses a key or an effect; the old columns stay so a rollback still finds them.
Both tables are classified as account data, so ExyliaLib's /exylialib wipe and /exylialib resetplayer cover them: that is how a player's choice, favourites, keys and unlocks are reset.
Ids are stored lowercase and read back without regard to case, so a row written by an older version 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.
Something missing on this page? Tell us on Discord