# Report System<\/p>\n
ReportSystem is a structured reporting framework designed to bridge the gap between players and the staff team. ReportSystem has a simple GUI, Discord webhook integration, and persistent database tracking. ReportSystem makes a simple reporting process all without cluttering your server.<\/p>\n
ReportSystem also includes a suspicious player tracking system, giving staff a dedicated space to flag players based on same IP’s or fast rejoining. Combined with user management tools, punishment history records (ReportSystem punishments. Not any third party punishment plugins), and per-player reports. This means it provides staff with the best possible context you can get from a in game simple report (another reporting system for proofs is recommended, this plugin is mostly for in game active staff.) <\/p>\n
Made for 1.17-26.1.2 | Tested versions: 1.19.2, 1.21.8, 1.21.11, 26.1.2.<\/p>\n – Full GUI report submission with reason selection and extra fields (and options for custom fields) “` ## Commands<\/p>\n | Command | Description | “` # Cross-server sync # Database backend. # Redis pub\/sub – live notifications to online staff when a report is filed # Server IP tagging. # Use & for color codes. # Discord webhook integration. # Automatic priority assignment based on LuckPerms groups. # Reasons players can select when submitting a report. # Server selector shown in the report form. # Suspicious player detection settings. # Sounds played on various GUI actions. ## 1. Shared MySQL Database<\/p>\n Every server must point to the same MySQL instance. In each server’s config.yml: database: ## 2.Redis (Live Staff Notifications)<\/p>\n Without Redis, staff only see reports when they manually open \/reports. With Redis, staff get instant chat notifications when a report is filed or updated on any server.<\/p>\n “` ## 3. Server IP Tagging (Optional) “` ## 4. Per-Server Config Summary<\/p>\n | Setting | Server 1 | Server 2 | Server 3 |Key Features<\/summary>\n
\n– Full report management. Open, high\/low prioritys, and closed states.
\n– Live Discord webhook embeds
\n– Suspicious player tracking system separate from the report queue. Marks same IP and fast rejoining as suspicious (Shared Local IP’s such as 192 or 127 are not saved)
\n– Player report and punishment history viewers
\n– Staff tools like the report detail GUI with close reason categorization
\n– Timeout and block system for users who abuse \/report
\n– Chat input capture for extra detail or note entry
\n– MySQL and SQLite storage with async database
\n– Configurable colors, titles, webhook appearance, and confirmation messages
\n– Sound and visual feedback throughout all GUI interactions<\/p>\n<\/details>\nPermissions<\/summary>\n
\n\/report | reportsystem.report
\n\/reports | reportsystem.reports
\n\/suspicious | reportsystem.suspicious
\n\/rsreload | reportsystem.reload
\nreportsystem.bypass (cooldown bypass if applicable)
\n“`<\/p>\n<\/details>\n
\n|———-|————-|
\n| \/report | Opens the report form GUI |
\n| \/reports | Opens the staff report management GUI |
\n| \/suspicious | Opens the suspicious tracking GUI |
\n| \/rsreload | Reloads plugin config |<\/p>\nconfig.yml<\/summary>\n
\n# Timezone for report timestamps.
\n# Use full zone IDs: America\/New_York, America\/Chicago, America\/Denver,
\n# America\/Los_Angeles, Europe\/London, Europe\/Paris, Asia\/Tokyo, UTC, etc.
\ntimezone: America\/New_York<\/p>\n
\n# Share reports across multiple servers. All servers must point to the same MySQL instance.
\nsync:
\n # Display name of THIS server shown in cross-server notifications (e.g. “NA”, “EU”, “US-East”).
\n server-name: “Server-1”<\/p>\n
\n # sqlite local file (default, no sharing)
\n # mysql shared database (required for cross-server reports)
\n database:
\n type: sqlite
\n mysql:
\n host: localhost
\n port: 3306
\n database: reportsystem
\n username: root
\n password: “”
\n # Number of connections in the pool (raise for many concurrent moderators)
\n pool-size: 5<\/p>\n
\n # or updated on ANY server in the network.
\n # Only useful when database.type is mysql so all servers share the same data.
\n redis:
\n enabled: false
\n host: localhost
\n port: 6379
\n password: “”
\n # Channel name – must be identical on every server in the network.
\n channel: reportsystem-sync<\/p>\n
\n# When enabled, the IP of THIS server is silently attached to every report so
\n# staff can see which physical server the report originated from.
\n# Useful for networks running multiple servers against a shared MySQL database.
\nserver-ip:
\n enabled: false
\n # Leave blank to auto-detect. Set this if auto-detection returns the wrong IP
\n # (e.g. a container private IP instead of the public address).
\n ip-override: “”
\n # Map raw IPs to friendly display names shown in the report detail GUI and
\n # in Discord embeds. If an IP is not listed here the raw IP is shown instead.
\n # Add as many entries as you have servers.
\n server-names:
\n “192.168.1.100”: “Survival”
\n “192.168.1.101”: “Creative”
\n “192.168.1.102”: “Skyblock”
\n # Whether to include the origin server as a field in Discord webhook embeds.
\n show-in-discord: true
\n # Label used for the field in the report detail GUI and Discord embed.
\n label: “Origin Server”<\/p>\n
\nconfirmation-message: “&aYour report has been submitted!”<\/p>\n
\n# A message is posted to this webhook every time a report is submitted.
\n# The message is automatically edited whenever the report is updated or closed.
\ndiscord-webhook:
\n enabled: false
\n url: “”
\n # Embed colors (hex, e.g. #FF4444)
\n # White (#FFFFFF) is the default \u2014 it looks clean and neutral in Discord.
\n color-open: “#FFFFFF”
\n color-closed: “#44BB44”
\n color-priority: “#FFAA00”
\n color-low-priority: “#AAAAAA”
\n # Embed title \u2014 use {id} for the report ID
\n title: “Report #{id}”
\n # Footer text (leave blank to hide)
\n footer: “ReportSystem”
\n # Show an ISO-8601 timestamp in the embed footer
\n show-timestamp: true
\n # Show the reported player’s Minecraft head as a thumbnail in the embed
\n thumbnail-enabled: true
\n # Toggle individual embed fields on or off
\n fields:
\n show-reported-player: true
\n show-reporter: true
\n show-reason: true
\n show-discord: true
\n show-server: false
\n show-notes: true
\n show-status: true
\n show-priority: true
\n show-server-ip: true
\n # Custom display labels for each field
\n labels:
\n reported-player: “Reported Player”
\n reporter: “Reporter”
\n reason: “Reason”
\n discord: “Discord Contact”
\n server: “Server”
\n notes: “Notes”
\n status: “Status”
\n priority: “Priority”
\n server-ip: “Origin Server”<\/p>\n
\n# Disabled by default. Enable and set group names to activate.
\n# high-priority-groups: players in these groups will have their reports auto-marked as High Priority.
\n# low-priority-groups: players in these groups will have their reports auto-marked as Low Priority.
\n# If a player is in both, high priority takes precedence.
\nauto-priority:
\n enabled: false
\n high-priority-groups:
\n – “vip”
\n – “premium”
\n low-priority-groups:
\n – “new”
\n – “trial”<\/p>\n
\n# Use & for color codes. These also appear as filter options in \/reports.
\nreasons:
\n – “&cCheating \/ Hacking”
\n – “&6Harassment \/ Toxicity”
\n – “&eGriefing”
\n – “&bSpamming”
\n – “&dInappropriate Name \/ Skin”
\n – “&aRule Breaking”
\n – “&fExploiting Bugs”<\/p>\n
\n# Set enabled: true to allow reporters to specify which server the incident occurred on.
\nserver-selector:
\n enabled: false
\n options:
\n option-1:
\n display: “&aSurvival”
\n option-2:
\n display: “&bCreative”
\n option-3:
\n display: “&cSkyblock”<\/p>\n
\nsuspicious:
\n fast-rejoin:
\n enabled: true
\n # Flag a player if they rejoin this many times…
\n times: 4
\n # …within this many seconds.
\n seconds: 60
\n same-ip:
\n enabled: true<\/p>\n
\n# Use Minecraft sound names (e.g. UI_BUTTON_CLICK, ENTITY_PLAYER_LEVELUP).
\n# You can use any valid MC sound key. Set to ” to disable a sound.
\nsounds:
\n # Played when clicking a standard button
\n button-click: UI_BUTTON_CLICK
\n # Played when cycling through options (reason slider, sort mode, etc.)
\n cycle: ITEM_BOOK_PAGE_TURN
\n # Played when a report is successfully submitted
\n submit: ENTITY_PLAYER_LEVELUP
\n # Played when cancelling or going back
\n cancel: BLOCK_NOTE_BLOCK_BASS
\n # Played when toggling priority
\n priority: BLOCK_ANVIL_USE
\n # Played when deleting a report or dismissing a suspicious player
\n delete: ENTITY_ITEM_BREAK
\n # Played when opening a GUI via command
\n open: BLOCK_CHEST_OPEN
\n“`<\/p>\n<\/details>\nSetting Up Cross Server ReportSystem<\/summary>\n
\n“`
\nsync:
\n server-name: “US-East” # unique name per server | shows in notifications<\/p>\n
\n type: mysql # change from sqlite to mysql
\n mysql:
\n host: 192.168.1.50 # your MySQL server IP
\n port: 3306
\n database: reportsystem
\n username: root
\n password: “yourpassword”
\n pool-size: 5
\n“`<\/p>\n
\nsync:
\n redis:
\n enabled: true
\n host: 192.168.1.50 # your Redis server IP
\n port: 6379
\n password: “” # leave blank if no auth
\n channel: reportsystem-sync # must be IDENTICAL on every server
\n“`<\/p>\n
\nShows which server a report came from in the GUI and Discord embeds:<\/p>\n
\nserver-ip:
\n enabled: true
\n server-names:
\n “192.168.1.100”: “Survival”
\n “192.168.1.101”: “Creative”
\n “192.168.1.102”: “Skyblock”
\n show-in-discord: true
\n label: “Origin Server”
\n“`<\/p>\n
\n|———|———-|———-|———-|
\n| server-name | “Survival” | “Creative” | “Skyblock” |
\n| database.mysql.host | same IP | same IP | same IP |
\n| redis.enabled | true | true | true |
\n| redis.channel | reportsystem-sync | reportsystem-sync | reportsystem-sync |<\/p>\n<\/details>\n