Handle player reports
Let players report each other, then review, resolve and dismiss reports from a queue ordered by priority.
A player runs /report <player> and picks a reason from a screen. Staff on every server get a clickable alert, and /reports lists what is open, highest priority first, so the worst case is never at the bottom.
Before you start#
- Players need
exyliastaff.report. Staff who review needexyliastaff.reports.manage. - The module switch is
modules.reportsinplugins/ExyliaStaff/config.yml. - Optional: the replay module attaches the last minute of the reported player to each report.
Steps#
A player reports
The player runs /report <player>. A menu titled "Report" followed by the player's name opens with one card per reason (Cheating, Exploiting, Griefing, Toxicity, Other by default), each with an icon and a line of description. Clicking a card files the report. Players on clients with screen menus get the same reasons as a screen instead of a chest menu. To skip the menu, write the reason: /report <player> cheating. Any other text is kept as written, without colours.
Staff are alerted
Every online staff member with exyliastaff.reports.manage, on any server, gets a message with three buttons: [ ✦ Open ] (that player's reports), [ ➥ Teleport ] (on duty, like /tpstaff) and [ ▶ Replay ]. Urgent reports play a different sound.
Review the queue
Run /reports, or click the blaze powder REPORTS (slot 12) in the staff mode hotbar. /reports <player> opens that player's open reports, online or not.
Close each report
Right click a report to resolve it, shift right click to dismiss it. Both remove it from the queue and record who did it.
Check that it works#
As a player run /report <someone online> and pick Toxicity. As staff you should see the alert, and /reports should list one head named after the reported player with the reason, priority and age on it.
Going further#
Who can be reported, and how often#
Only online players can be reported. A report is refused, in this order, when the reporter names themself, the target holds exyliastaff.staff and allow-report-staff is off, the reporter is still inside cooldown-seconds from their last report, or they already have max-open-per-reporter open reports. Nothing stops two players reporting the same target. A rank gets its own wait with exyliastaff.report.cooldown.<seconds>; the lowest one held wins.
Add or change a reason#
Reasons are reasons.<id> in modules/reports/config.yml: a name, a description, an icon (a material) and a weight from 1 to 5. Add a block, reload, and it appears as a card in the report screen. The punish-reasons list names punishment reason ids that Exylia Staff Web suggests when a report with this reason is acted on.
How priority is worked out#
A report's score is its reason's weight plus one per other open report on the same target, up to three extra. Free text weighs 1. The score is read when shown, never stored, so changing a weight reorders the queue at once.
| Score | Level |
|---|---|
| 7 or more | CRITICAL |
| 5 or 6 | HIGH |
| 3 or 4 | NORMAL |
| below 3 | LOW |
HIGH and CRITICAL reports play alert-urgent instead of alert.
Clicks in the menus#
| Screen | Clicks |
|---|---|
| Report list (REPORTS) | Left: that player's reports. Shift left: watch the replay. Right: resolve. Shift right: dismiss. |
| Player reports | Left: teleport, following them to their server. Shift left: teleport on duty. Right: resolve. Shift right: dismiss. Middle: everything ever filed against them. Drop (Q): watch the replay. |
The list also has Filter (type a name), History (type a name), Resolve all, Dismiss all and Order: left click for the next order, right click for the previous one. Orders are priority, newest, oldest and most reported (which groups reports on one player). Each staff member keeps their own, priority until they change it. The player screen has a Replays button for that player's whole replay list.
Replays#
With the replay module on, the minute before a report is saved when it is filed, if the reported player is on the reporter's server. Every replay button opens that one; if there is none (not recorded, or still being written) it opens the player's replay list instead. Watching needs exyliastaff.replay too.
What happens to old reports#
There is no claim step, and the reporter is not told when their report is closed. A report nobody handled closes itself after expire-days (default 3): it leaves the queue but stays in the player's history, so a repeat offender still shows it. 0 keeps reports open forever. Closed rows stay in the database.
Commands and permissions#
| Command | What it does | Permission |
|---|---|---|
/report <player> [reason] | Report a player. | exyliastaff.report |
/reports [player] | Open the report queue, optionally for one player. | exyliastaff.reports.manage |
/reports replay <id> | Watch the replay attached to a report. | exyliastaff.reports.manage |
| Permission | Who has it | What it allows |
|---|---|---|
exyliastaff.report | Everyone | Report a player with /report. |
Configuration and messages
reasons:
cheating:
name: Cheating
description: Hacks, macros or unfair clients.
icon: DIAMOND_SWORD
weight: 5
punish-reasons:
- hacks
- xray
exploiting:
name: Exploiting
description: Abusing bugs or glitches.
icon: COMMAND_BLOCK
weight: 4
punish-reasons:
- hacks
griefing:
name: Griefing
description: Destroying or stealing from others.
icon: TNT
weight: 3
punish-reasons:
- grief
toxicity:
name: Toxicity
description: Insults, harassment or spam.
icon: WRITABLE_BOOK
weight: 2
punish-reasons:
- toxicity
- spam
- advertising
other:
name: Other
description: Something else worth a look.
icon: PAPER
weight: 1
punish-reasons: []
cooldown-seconds: 60
allow-report-staff: false
max-open-per-reporter: 3
expire-days: 3
alert:
sound:
name: BLOCK_NOTE_BLOCK_PLING
pitch: 1.4
alert-urgent:
sound:
name: BLOCK_NOTE_BLOCK_BELL
pitch: 0.7| Key | Default | What it does |
|---|---|---|
reasons.<id>.name | Shown in the menu and stored on the report. Plain text. | |
reasons.<id>.weight | The base score, 1 to 5. | |
reasons.<id>.punish-reasons | Punishment reason ids suggested on the web, best match first. Empty suggests none. | |
cooldown-seconds | 60 | Wait between two reports by one player. Under five minutes it is not kept across a restart. |
allow-report-staff | false | Let players report somebody with exyliastaff.staff. |
max-open-per-reporter | 3 | Open reports one player may have. 0 for no limit. |
expire-days | 3 | Days before an unattended report closes itself. 0 never. |
alert, alert-urgent | Effects played for staff on every server. |
The report screen for clients with screen menus is screens/report_reasons.html in the plugin folder; its words are in lang/<language>/screens/report_reasons.yml, its look in theme.css, and your own rules go in custom.css (see ExyliaLib screens). It reads the reasons from this config, so it needs no edits of its own.
Messages are in lang/<language>/modules/reports/messages.yml: submitted, self, staff-protected, cooldown (%time%), too-many-open (%count%); alert-header, alert-line and alert-actions (%id%, %reporter%, %target%, %reason%, %server%, %priority%, %priority_score%; the last is a clickable row you may empty); resolved and dismissed (%id%); closed-all; not-found; target-offline, teleported, following; filter-prompt, history-prompt; no-reports, no-history; no-permission-for-player; no-handler; no-replay; and sorts, the names of the four orders. See ExyliaLib messages, menus and colours. Other plugins can file or refuse reports; see the API.
| Placeholder | Shows | Example |
|---|---|---|
%exyliastaff_staff_reports_open% | Open reports on the network. | 5 |
%exyliastaff_staff_reports_mine% | Open reports you handle. | 2 |
Something missing on this page? Tell us on Discord