Configuration
config.yml, the language, the module switches, the command gate, disabled commands, the in-game settings, the module files, the Discord webhooks, the sidebars, the menus and the database.
Everything is generated in plugins/ExyliaStaff/ on first boot, with comments. The core keeps
config.yml; every module keeps its settings under modules/<id>/, so an owner switching a feature
off never scrolls past its settings to find the switch. Text lives apart from settings, under
lang/<language>/: see Languages. Colours use palette tokens such as
{primary}, {error} or {highlight}, resolved by the library. A message may open with an effect
tag, [sound:NAME|volume|pitch], that plays to the receiver and never reaches the screen.
/staffadmin reload runs four steps: configs, modules, admin menus and command gate. The
hotbar is re-read and re-shown, the sidebars rebuilt, the mining ores re-indexed.
Every setting can also be changed in game: see In-game settings.
A network linked to Exylia Staff Web can hand config.yml and the modules' config.yml files over to
the web. A managed file says so in its header, and edits on disk are ignored. See
Exylia Staff Web.
config.yml#
language: default
modules:
vanish: true
staff-mode: true
freeze: true
staff-chat: true
global-chat: true
inspect: true
teleport: true
staff-list: true
scoreboard: true
reports: true
helpop: true
mining: true
inventory-restore: true
xray-vision: true
see-invisible: true
punishments: true
staff-log: true
staff-admin: true
afk: true
action-bar: true
item-revocation: false
replays: true
web: true
alts: true
anticheat: true
discord: true
two-factor: true
command-gate:
enabled: true
staff-only-commands:
- tp
- teleport
- tphere
- tpall
- inspect
- invsee
- gamemode
- gm
- gmc
- gms
- gmsp
- fly
- god
- vanish
- freeze
- ss
- echest
- enderchest
- kill
- clear
- give
- xray
- xrayvision
- seeinvis
- seeinvisible
- reveal
bypass-permission: exyliastaff.gate.bypass
hide-from-tab: true
disabled-commands: []Language#
default follows the language set in ExyliaLib's config.yml; en, es, pt, fr, ru or tr set this
plugin alone. See Languages.
Modules#
A module that is off registers nothing: no commands, no listeners, no tables. The ids used by
/staffadmin module are the code names, which do not always match the switch:
| Switch | Id | Page |
|---|---|---|
vanish | vanish | Vanish |
staff-mode | staffmode | Staff mode |
freeze | freeze | Freeze |
staff-chat, global-chat | staffchat, globalchat | Staff chat |
inspect | inspect | Inspect |
teleport | teleport | Teleport |
staff-list | stafflist | Staff list |
scoreboard | scoreboard | Sidebars |
reports, helpop | reports, helpop | Reports, Helpop |
mining | mining | Mining |
inventory-restore | restore | Inventory restore |
xray-vision | xrayvision | X-ray vision |
see-invisible | reveal | Reveal |
punishments | punishments | Punishments |
staff-log | stafflog | Staff log |
staff-admin | staffadmin | Audit and notes |
afk | afk | AFK |
action-bar | actionbar | Action bar |
item-revocation | revoke | Item revocation |
replays | replay | Replays |
web, alts, anticheat | web, alts, anticheat | Exylia Staff Web |
discord | discord | Discord webhooks |
two-factor | twofactor | Two-factor |
Item revocation is the one module off by default. A module whose dependency is off stays off too:
item revocation needs inventory restore, and alts need web. A module that throws on enable shows as
failed, keeps its commands off, and is retried on the next start. /staffadmin module enable|disable
and the admin hub's module list write the switch here, so it survives a restart.
Staff mode, x-ray vision and reveal need PacketEvents and stay off without it; vanish, freeze and inspect run without it, and replays need it to be watched. Staff mode looks vanish and the scoreboard up on every call, so switching either off at runtime simply makes staff mode stop vanishing or stop showing a board.
Command gate#
Commands in staff-only-commands may only be run in staff mode. The list is matched against each
command's registered name and every alias, so tp also gates teleport when that is an alias, and
against the plugin:name spellings. Out of staff mode the command is cancelled with
gate.blocked, removed from the client's command list and given no tab completions when
hide-from-tab is on. Players with bypass-permission are never gated. The gate does not check the
command's own permission: it asks only whether the player is in staff mode.
Disabled commands#
disabled-commands lists commands this plugin should not register, without the slash, while the rest
of their module keeps working. Each alias counts on its own: listing top frees /top for another
plugin and keeps /stafftop; listing tp and teleport leaves the vanilla teleport alone while
/stafftp still works.
disabled-commands:
- top
- tp
- teleportThe names are dropped before the server ever sees them, so restart after changing the list: the freed name then goes to the plugin that also registers it.
In-game settings#
/staffadmin settings, or Settings in the hub /staffadmin opens, is a hub of hand-written pages
for what an admin really tunes: the module switches (grouped as Moderation, Communication, Evidence
and Network), the command gate, and the pages of AFK, mining, vanish, staff mode, freeze, punishments,
replays, reports and helpop. Each card explains the value, shows the current one and its default, and
a click edits it (shift-right-click resets). A change is written straight to the file. It needs
exyliastaff.admin. Every file, the other modules' included, can still be edited in ExyliaLib's
/exylialib config and web editor.
A file Exylia Staff Web manages is left out of both, since the web writes over it on the next load.
messages.yml#
The core's lines, in lang/<language>/messages.yml.
prefix: '{primary}&lSTAFF {letters_black}•<reset>'
no-permission: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}You do not have permission to do that.'
player-only: '%prefix% {error}Only a player can run this command.'
player-not-found: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}{highlight}%player% {error}is not online.'
world-not-found: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}There is no world named {highlight}%world%{error}.'
module-disabled: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}The {highlight}%module% {error}module is off on this server.'
reload:
started: '%prefix% {muted}Reloading…'
done: '[sound:ENTITY_EXPERIENCE_ORB_PICKUP|1.0|1.2]%prefix% {success}Reloaded {highlight}%steps% {success}steps in {highlight}%ms%ms{success}.'
failed: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}Reload finished with errors. Check the console.'
modules:
header: '%prefix% {letters}Modules {letters_black}» {highlight}%enabled%{letters_black}/{muted}%total% {letters}running'
line: ' {muted}❙ %color%%module% {letters_black}» %state%'
enabled: '[sound:ENTITY_EXPERIENCE_ORB_PICKUP|1.0|1.2]%prefix% {success}Module {highlight}%module% {success}enabled.'
disabled: '%prefix% {warning}Module {highlight}%module% {warning}disabled.'
enable-failed: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}Module {highlight}%module% {error}could not start: it is already on, it failed, or a dependency is off.'
disable-failed: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}Module {highlight}%module% {error}is not enabled.'
unknown: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}No module named {highlight}%module%{error}.'
managed: '%prefix% {warning}The web panel manages this server''s modules: switch {highlight}%module% {warning}there too, or it returns to the panel''s value on the next restart.'
gate:
blocked: '[sound:ENTITY_VILLAGER_NO|1.0|1.0]%prefix% {error}Enable staff mode before using {highlight}/%command%{error}.'
redis:
server-id: '%prefix% {letters}Server {letters_black}» {highlight}%server%'
active: ' {muted}❙ {letters}Redis {letters_black}» {success}connected'
inactive: ' {muted}❙ {letters}Redis {letters_black}» {muted}off, local bus only'
stats: ' {muted}❙ {letters_black}%stats%'admin-menu holds the words the admin hub's module list shows: running, stopped, failed, and
enabled or disabled for the switch at startup. modules.managed is sent when a module switched in
game is managed by the web.
%prefix% expands to prefix in every message of the plugin, the modules' included. no-permission
and player-only are what the command framework sends; player-not-found is sent for any player
argument that does not resolve, and world-not-found for a world argument. The convention across every file: a refusal sounds
ENTITY_VILLAGER_NO, a success ENTITY_EXPERIENCE_ORB_PICKUP, attention BLOCK_NOTE_BLOCK_PLING.
Module files#
Each module page shows its own config.yml and lists its message keys.
| Where | Holds |
|---|---|
modules/<id>/config.yml | The module's settings. Every module but the scoreboard and inspect has one. |
lang/<language>/modules/<id>/messages.yml | The module's lines, titles, action bars and sounds. |
lang/<language>/modules/scoreboard/config.yml | The sidebars, which are text. |
lang/<language>/modules/inspect/config.yml | The window titles, which are text. |
lang/<language>/modules/staffmode/hotbar.yml | The staff hotbar. |
lang/<language>/modules/replay/hotbar.yml | The replay controls. |
Effect blocks such as effects.enter, alert or reminder are library effects with the sections
title, action-bar, boss-bar, sound and particle. A section left empty is not
written to the file; add it to use it. Their keys are on the
library's effects page.
Discord webhooks#
The discord module mirrors staff chat and staff events into Discord channels through webhooks. It
needs neither the web nor a bot, and sends nothing until a URL is set. Paste each URL (channel settings
» Integrations » Webhooks) into its key; an empty one sends nothing, and several keys may share a URL.
On a network every server posts what happens on it, so give each server the same URLs.
staff-chat: ''
punishments: ''
reports: ''
helpop: ''
alerts: ''
freeze: ''
staff-log: ''
replays: ''| Key | Posts |
|---|---|
staff-chat | Every staff chat line, under the sender's name and head. |
punishments | New and revoked punishments. |
reports | New player reports. |
helpop | New /helpop questions. |
alerts | Mining alerts and possible ban evasion. |
freeze | Players frozen and unfrozen. |
staff-log | Staff going on and off duty. |
replays | Replays saved by a capture rule. |
A URL Discord would refuse is reported once in the console on start and on reload, without printing it, since it holds the token. Events older than ten minutes, such as the rows of a ban plugin import, are not posted.
What each event posts lives in lang/<language>/modules/discord/messages.yml, one template per event in
the library's webhook template format. Staff chat posts
the plain line with %player% • %server% as the name and the player's head as the avatar; every other
event is a card coloured with a palette token, with %server% in the footer. Every template also takes
%server%, this server's redis.server-id.
| Template | Tokens |
|---|---|
staff-chat | %player% %player_head% %message% |
punishment | %id% %target% %type% %duration% %staff% %reason% |
punishment-revoked | %id% %staff% %reason% |
report | %reporter% %target% %reason% |
helpop | %player% %message% |
mining-alert | %player% %count% %ore% %minutes% %level% %world% %x% %y% %z% |
ban-evasion | %player% %banned% |
frozen, unfrozen | %target% %staff% %reason% |
duty-start, duty-end | %player% |
replay-rule | %player% %detail% (the rule and what set it off) %id% %seconds% |
Queues, Discord's rate limits and escaping are handled by the library.
Sidebars#
lang/<language>/modules/scoreboard/config.yml holds three boards: staff-mode, shown on duty; frozen, shown to
a frozen player; freezing, shown to the staff member holding one. Each has enabled, a title
list that animates when it has several entries, up to fifteen lines, and update.interval in ticks.
Boards stack: a freeze shown over the staff board hides it and gives it back on release.
{server-ip} on the last line is the address set once in ExyliaLib's colors.yml.
staff-mode:
enabled: true
title:
- '{primary}&lSTAFF'
lines:
- ''
- ' {muted}❙ {letters}Session {letters_black}» {highlight}%staff_staffmode_time%'
- ' {muted}❙ {letters}Vanish {letters_black}» %staff_vanish_status%'
- ' {muted}❙ {letters}Reports {letters_black}» {warning}%staff_reports_open%'
- ' {muted}❙ {letters}Help requests {letters_black}» {info}%staff_helpop_open%'
- ''
- ' {muted}❙ {letters}TPS {letters_black}» {info}%server_tps% {letters_black}· {letters}MSPT {letters_black}» {info}%server_mspt%ms'
- ' {muted}❙ {letters}CPU {letters_black}» {info}%server_cpu_process:percent% {letters_black}proc · {info}%server_cpu_system:percent% {letters_black}host'
- ' {muted}❙ {letters}RAM {letters_black}» {info}%server_ram_used%{letters_black}/{info}%server_ram_max% {letters_black}MB'
- ' {muted}❙ {letters}Ping {letters_black}» {info}%player_ping%ms'
- ''
- ' {muted}❙ {letters}Staff {letters_black}» {success}%staff_online% {letters_black}· {letters}Players {letters_black}» {success}%server_online%'
- ' {muted}❙ {letters}AFK {letters_black}» {warning}%staff_afk_count%'
- ''
- ' {highlight}{server-ip}'
update:
interval: 20
smart: true
frozen:
enabled: true
title:
- '{error}&lFROZEN'
lines:
- ''
- ' {muted}❙ {letters}A staff member is talking'
- ' {muted}❙ {letters}to you. Answer them.'
- ''
- ' {muted}❙ {letters}Staff {letters_black}» {highlight}%staff_freeze_by%'
- ' {muted}❙ {letters}Frozen for {letters_black}» {info}%staff_freeze_time%'
- ''
- ' {error}❙ Do not log out.'
- ''
- ' {highlight}{server-ip}'
update:
interval: 20
smart: true
freezing:
enabled: true
title:
- '{primary}&lFREEZING'
lines:
- ''
- ' {muted}❙ {letters}Target {letters_black}» {highlight}%staff_freeze_target%'
- ' {muted}❙ {letters}Frozen for {letters_black}» {info}%staff_freeze_time%'
- ''
- ' {highlight}{server-ip}'
update:
interval: 20
smart: trueMenus#
Every staff screen is a YAML file under lang/<language>/menus/<module>/: reports/ with
reasons, list, player and history; helpop/list; punishments/ with categories,
reasons, confirm and history; mining/ with suspicious and player; restore/ with
servers, list, backup, parts and log; replay/ with list and players;
revoke/quarantine; stafflog/ with sessions, summary and top; replay/events, the event
log; and admin/ with hub and modules, the screens /staffadmin opens. Their format is the
library's menu format.
They are yours to restyle, except admin/: those two are the plugin's and are rewritten from the jar on
every start and reload. A release only adds what your files are missing; a default that changed on
something you never edited waits in /exylialib updates, where you apply it or keep yours.
database.yml#
Engine and Redis, written by ExyliaLib. H2 by default. See Installation
for the engines and the tables, and the library's database page for every key,
redis.server-id among them, which is the name every alert and every staff chat line shows.
Something missing on this page? Tell us on Discord