Content generated with AI — it may contain mistakes.

ExyliaStaff/Getting startedUpdated in v1.8.0

Installation

Install ExyliaStaff on Paper or Folia, pick the optional plugins, check it started and point it at a shared database.

Page 2 of 385 min read

By the end of this page ExyliaStaff is running, its modules are on, and you know where its database lives.

Before you start#

  • Paper 1.21.1 or newer, or Folia, with Java 21.
  • ExyliaLib, which the loader installs. ExyliaStaff always builds against the newest ExyliaLib release, so update both together.

Optional plugins, all listed under softdepend in plugin.yml unless noted:

  • PacketEvents for the packet-drawn parts. Without it the plugin still loads: staff mode, x-ray vision and reveal stay off, vanish falls back to Bukkit's hidePlayer, freeze to movement checks, and replays are saved but cannot be watched.
  • ExyliaLink to approve staff logins from Discord, see Two-factor.
  • PlaceholderAPI to use the plugin's placeholders outside it.
  • LuckPerms, or any permission plugin, for the exyliastaff.vanish.level.<n> rank nodes.
  • LiteBans, AdvancedBan, LibertyBans or BanManager, unless punishments enforces them itself with engine: exylia. With the default engine: commands it runs commands, and the defaults are the command names LiteBans and AdvancedBan use. LibertyBans and BanManager are not in softdepend; the module still recognises them. With observe on, what these plugins do is recorded in the history.
  • GrimAC, Vulcan or Matrix to forward their alerts to Exylia Staff Web.
  • Redis, configured in ExyliaLib's database.yml, for the cross-server parts: staff chat, network chat, alerts, the staff list and vanish state on the next server. Without Redis every channel still delivers on the local server.
ExyliaLib is listed as soft

plugin.yml names ExyliaLib under softdepend on purpose: the loader that installs ExyliaLib has to load first for that install to happen. The plugin still needs it to run.

Steps#

Drop in the jars

Copy the ExyliaStaff loader jar into the server's plugins/ folder, with the optional plugins you want.

Start the server

The first boot generates config.yml, one folder per module under modules/, the menus and messages under lang/, and the database tables.

Grant the staff node

exyliastaff.staff is what makes a player staff for every module. Without it nobody sees vanished players, receives alerts or can enter staff mode. Give it to your team in your permission plugin, then follow First steps.

Check that it works#

In the console you should see one Module enabled: <id> line per module that is on, and a closing line ExyliaStaff enabled with N/27 modules. A module that threw on enable is reported there with its reason and shows as failed in /staffadmin modules; the next start retries it.

In game, as an operator, run /staffadmin modules: every module shows a state. Then, as a player with exyliastaff.staff, run /staff (staff mode needs PacketEvents) and the staff hotbar appears. If something is off, see Common problems.

Database#

By default the plugin uses H2: a file inside the plugin folder, with no server, no installation and no maintenance. To share sessions, reports, punishments and the log across servers, point every server at the same database:

plugins/ExyliaStaff/database.yml
yaml
database:
  type: mysql
  mysql:
    host: 127.0.0.1
    port: 3306
    database: minecraft
    username: root
    password: ""

Supported engines: h2, mysql, mariadb, postgresql and mongodb. The file is ExyliaLib's; its full reference, including the redis block, is in the library's database page.

The link to Exylia Staff Web, replays, the restore queue and two-factor sessions are read across the network from this database, which is one more reason to share it between every server.

Every table declares what it holds, so ExyliaLib's /exylialib resetplayer and /exylialib wipe cover the plugin's data. See Commands.

Tables the plugin creates

staff_prefs, staff_sessions, staff_vanish, staff_freeze, staff_reports, staff_helpop, staff_mining, staff_punishments, staff_punishment_requests, staff_log_sessions, staff_log_daily, staff_audit, staff_notes, staff_restores, staff_restore_queue, staff_restore_log, staff_replays, staff_replay_data, staff_replay_chunks, staff_revoked_items, staff_revoked_hits, staff_alts and staff_2fa, plus web_link, web_lease, web_outbox and web_commands_done for Exylia Staff Web. Inventory snapshots for staff mode and freeze use the library's exylia_snapshots.

Generated files

All of them live in plugins/ExyliaStaff/.

FileContents
config.ymlThe language, the module switches, the command gate and disabled-commands.
modules/<id>/config.ymlOne per module, its settings only.
lang/<language>/messages.ymlThe core's lines: prefix, no-permission, reload, module list, gate, Redis.
lang/<language>/modules/<id>/messages.ymlOne per module that sends messages.
lang/<language>/modules/staffmode/hotbar.ymlThe staff hotbar.
lang/<language>/modules/scoreboard/config.ymlThe three sidebars: staff mode, frozen, freezing.
lang/<language>/menus/<id>/The staff screens of each module.
lang/<language>/menus/admin/The hub and module list /staffadmin opens. Rewritten from the jar on every start and reload.
web/managed.jsonThe last configuration Exylia Staff Web sent, when the network is linked and the web manages files.
database.ymlDatabase engine and Redis, written by ExyliaLib.

Every file under lang/ but menus/admin/ is yours to edit, in every language: see Languages.

Updating#

Replace the jar and restart. Your edits are kept: a release only adds the keys and files you are missing, and a default that changed on something you never edited waits in /exylialib updates.

Updating from 1.3 or older

The first start of 1.4.0 moves your messages.yml, every modules/<id>/messages.yml, the sidebars, the hotbar and menus/ into lang/custom/ and sets language: custom, so nothing on screen changes. Switch to en, es, pt, fr, ru or tr for the shipped files. See Languages.

Something missing on this page? Tell us on Discord