Audit staff and keep notes
Use the admin hub to switch modules and change settings in game, read the audit of what staff did and write notes on a staff member's file.
Three jobs live here. The admin hub, /staffadmin, switches modules and changes the settings worth tuning without opening a file. The audit records what staff do: every action the modules announce, every command a staff member runs and the items they move on duty. Notes and strikes are the written record you keep on a staff member.
Before you start#
- Opening the hub, the module list and the settings needs
exyliastaff.admin. Reading notes needsexyliastaff.admin.panel, writing themexyliastaff.admin.notes. All op by default. - The audit and notes belong to the
staffadminmodule (modules.staff-admin). Turning it off stops the record, which is how an owner who does not want conduct kept says so once. - The team reads the audit and notes with filters on Exylia Staff Web; in game,
/notesis the quick look before acting on a report.
Steps#
Open the admin hub
Run /staffadmin in game. The top card shows the open reports, the staff in staff mode and the frozen players on this server. Below it are three buttons: Modules, Settings and Reload. From the console, /staffadmin lists the modules in chat instead.
Switch a module
Click Modules. Every module is one card with its state now (running, stopped, failed) and its switch at startup. Click a stopped one to start it, a running one to stop it. The switch is written to config.yml, so it stays after a restart. A module that Exylia Staff Web manages shows as locked. The same thing from chat: /staffadmin module enable <module> and /staffadmin module disable <module>.
Change a setting
Click Settings. One card per theme opens a page of the settings people tune most: Modules (every switch, grouped by theme), Vanish, Staff mode, Freeze, Reports, Helpop, Punishments, Replays, Command filter, AFK and Mining alerts. On a card, left click moves a switch or choice to its next value and right click to the previous one, shift multiplies a number by ten, Q (drop) lets you type an exact value, and shift right click puts the default back. Every change is saved and applied at once.
Write a note
Run /notes add <player> <text> for a note or /notes strike <player> <text> for a strike. Run /notes <player> to read the file: each line has its id, author, date and text. /notes delete <id> removes one. The author's name and the date are kept, also when the console writes it.
Read the audit
The audit is on Exylia Staff Web, where you can filter by staff member, flag and date. Nothing needs switching on: it records from the first start.
Check that it works#
Run /notes add <some staff member> test, then /notes <that member>: one line with your name and today's date. Delete it with /notes delete <id>. Then open /staffadmin, click Modules and confirm every module shows a state.
Going further#
What the audit records#
Three kinds of rows land in the audit:
- Actions the modules announce: a freeze, an inspection, a resolved report, a punishment.
- Commands run by anyone holding
exyliastaff.staff, with the full line, whilelog-commandsis on and the command is not inignored-commands. - Items dropped, picked up or taken out of a container by somebody in staff mode, while
log-itemsis on.
Rows older than keep-days (90) are deleted once a day; 0 keeps everything. With the network linked every row is also sent to the web. Two-factor commands are stored without their arguments, so no code or key is ever kept.
Flags that make a row easy to find#
A command row is flagged by its first word. A flag is not an accusation, only the reason the row is easy to find again.
| Flag | When |
|---|---|
self_give | A give-commands command whose item went to the sender, to @s, or to no player name. |
give | Any other give-commands command. |
creative | A gamemode-commands command that sets creative: gmc, or an argument of creative, c or 1. |
revoke | A revoke-commands command. |
item | An item row. |
sensitive | A sensitive-commands command. |
Edit the lists in modules/staffadmin/config.yml to match the commands your server really uses, then run /staffadmin reload.
Clear a player's data#
/staffadmin history clear <player>, /staffadmin reports clear <player> and /staffadmin notes clear <player> empty one kind of record for one player and ask for confirm first. See Commands. Notes are never purged on their own.
Technical details
keep-days: 90
log-commands: true
log-items: true
ignored-commands: [staffadmin, msg, r, tell, helpop, report, list, spawn]
give-commands: [give, i, item]
gamemode-commands: [gamemode, gm, gmc]
revoke-commands: [unban, pardon, unmute, untempban, unpunish, revoke]
sensitive-commands: [op, deop, ban, tempban, mute, kick, clear, setblock, fill, effect, enchant]| Key | Default | What it does |
|---|---|---|
keep-days | 90 | Audit rows older than this are deleted once a day. 0 keeps everything. |
log-commands | true | Record every command a staff member runs. Without it the audit only holds what the modules announce. |
log-items | true | Record items dropped, picked up or taken from a container on duty. |
ignored-commands | see above | Commands never recorded. |
give-commands, gamemode-commands, revoke-commands, sensitive-commands | see above | The lists the flags read. |
Tables: staff_audit and staff_notes. Messages: lang/<language>/modules/staffadmin/messages.yml (never-played, notes-header, note-line with %id%, %author%, %date%, %text% and %kind%, notes-empty, notes-usage, note-added, note-removed, note-not-found). The hub and module list are lang/<language>/menus/admin/, rewritten from the jar on every start and reload; edit the settings pages through the hub, not the files.
| Command | What it does | Permission |
|---|---|---|
/notes <player> | Read the notes on a player's file. | exyliastaff.admin.panel |
/notes add <player> <text> | Add a note to a player's file. | exyliastaff.admin.notes |
/notes strike <player> <text> | Add a strike to a player's file. | exyliastaff.admin.notes |
/notes delete <id> | Delete a note by its number. | exyliastaff.admin.notes |
| Permission | Who has it | What it allows |
|---|---|---|
exyliastaff.admin.panel | Admins (op) | Read the notes on a staff member's file with /notes, and its audit pages on the web. |
exyliastaff.admin.notes | Admins (op) | Write on a staff member's file. |
| Command | What it does | Permission |
|---|---|---|
/staffadmin | Open the admin hub: modules, settings and reload. | exyliastaff.admin |
/staffadmin settings | Open the in-game settings screens. | exyliastaff.admin |
/staffadmin reload | Reload the configuration. | exyliastaff.admin.reload |
/staffadmin modules | List the modules and whether they run. | exyliastaff.admin.modules |
/staffadmin module enable <module> | Turn a module on. | exyliastaff.admin.modules |
/staffadmin module disable <module> | Turn a module off. | exyliastaff.admin.modules |
/staffadmin info | Read the plugin's status and diagnostics. | exyliastaff.admin.info |
/staffadmin redis | Check the Redis connection used for network features. | exyliastaff.admin |
/staffadmin import [plugin] | Import the history of another punishment plugin. | exyliastaff.admin |
/staffadmin history clear <player> [reason] [confirm] | Delete a player's punishment history, or one reason. Shows a preview until you add confirm. | exyliastaff.admin.history.clear |
/staffadmin reports clear <player> [confirm] | Delete a player's reports. Preview until confirm. | exyliastaff.admin.reports.clear |
/staffadmin notes clear <player> [confirm] | Delete a player's notes. Preview until confirm. | exyliastaff.admin.notes.clear |
Something missing on this page? Tell us on Discord