# \ud83d\udee1\ufe0f Report System for Velocity<\/p>\n
A powerful, high-performance reporting solution for Velocity proxy servers, seamlessly integrated with **Discord** and **MariaDB**. This plugin bridges the gap between your Minecraft server and staff team by creating dedicated Discord channels for every report.<\/p>\n
—<\/p>\n
## \ud83d\ude80 Key Features<\/p>\n
* **Discord Integration:** Automatically creates a unique text channel for every new report.
\n* **Web Transcripts:** Generate and host professional chat transcripts (including media\/images) when a report is closed.
\n* **Advanced Rate Limiting:** Prevent spam with a “Greedy Token” system.
\n* **Fully Customizable:** Every message, sound, and permission node can be edited in the `config.yml`.
\n* **Staff Protection:** Optional settings to prevent players from reporting administrators.
\n* **Cross-Server Sync:** As a Velocity plugin, it handles reports across your entire network.<\/p>\n
—<\/p>\n
## \ud83d\udee0\ufe0f Installation & Requirements<\/p>\n
### Pre-requisites
\n1. **MariaDB Database:** Required for persistent data storage.
\n2. **Discord Bot:** A registered application on the Discord Developer Portal.
\n3. **Discord Server**<\/p>\n
### Setup Guide
\n1. **Bot Setup:** Create a bot on the Discord portal, reset the token, and copy both the **Token** and **Application ID**.
\n2. **Discord Layout:** Create a category where the bot will spawn report channels and a specific channel for the **Audit Log**.
\n3. **Initial Run:** Place the plugin in your Velocity `plugins` folder and start the server to generate the default configuration.
\n4. **Configuration:** * Input your MariaDB credentials.
\n * Fill in the `discord-bot` section (Token, Guild ID, Category ID, etc.).
\n5. **Restart:** Restart the proxy to initialize the bot and database connection.<\/p>\n
—<\/p>\n
## \ud83d\udcdd Transcripts Setup<\/p>\n
To enable web-based transcripts for closed reports: <\/p>\n<\/details>\n —<\/p>\n ## \u2328\ufe0f Commands & Permissions<\/p>\n ### Player Commands ### Staff & Admin Commands [status]` | View reports a specific player has sent | `reports.admin.view` | [status]` | View reports filed against a specific player | `reports.admin.view` | ` | Block a player from using `\/report` | `reports.admin.ban` | ` | Restore a player’s ability to report | `reports.admin.ban` |<\/p>\n —<\/p>\n ### Feature request<\/p>\n Create an issue using the issue tracker link and briefly describe what would you like to add<\/p>\n —<\/p>\n “`yaml require-permission: false # Permission: reports.report<\/p>\n notify-sound: “entity.experience_orb.pickup” close-comment-required: false # Require a comment when closing a report # Rate limit \/report command? discord-bot: transcripts: Report System plugin for Velocity server with discord bot integration<\/p>\n","protected":false},"featured_media":132242,"template":"","meta":{"_minecraft_slug":"reports","_minecraft_project_id":"GgAd83ot","_minecraft_author":"xap3y","_minecraft_license":"LicenseRef-Custom-Personal-Use-and-Non-Commercial-License","_minecraft_downloads":10,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"reports.zip","_minecraft_size_bytes":18283538,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T23:09:16.055147Z","_minecraft_date_created":"2026-04-16T23:18:11.768802Z","_minecraft_date_modified":"2026-03-24T20:34:01.283510Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/reports","_minecraft_icon_attachment_id":132242,"_minecraft_imported_at":"2026-06-07T19:14:08+00:00","_minecraft_import_hash":"ca51081977483fb519fefc555a63286c","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,867,92,985],"mod_loader":[986],"minecraft_version":[62,40,41],"class_list":["post-132241","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-social","mod_category-utility","mod_category-velocity","mod_loader-velocity","minecraft_version-1-21","minecraft_version-1-21-10","minecraft_version-1-21-11"],"yoast_head":"\n
\n1. Generate an API key at space.xap3y.eu.
\n2. In `config.yml`, set `discord-bot.transcripts.enabled` to `true`.
\n3. Paste your key into `key` and `media-save-api-key`.
\n4. *(Optional)* Enable `save-media` to archive images\/videos sent in the Discord report channel.<\/p>\nPreview<\/summary>\n
\n| Command | Description | Permission |
\n| :— | :— | :— |
\n| `\/report
\n| `\/reports` | Open the report management list | `None` |
\n| `\/reports view-open` | View your own open reports | `None` |<\/p>\n
\n| Command | Description | Permission |
\n| :— | :— | :— |
\n| `\/reports reload` | Reload config and language files | `reports.reload` |
\n| `\/reports info
\n| `\/reports close
\n| `\/reports delete
\n| `\/reports admin view-open` | View all open reports on the network | `reports.admin.view` |
\n| `\/reports admin view-closed` | View all closed reports on the network | `reports.admin.view` |
\n| `\/reports admin view-player sent <\/p>\n
\n| `\/reports admin view-player received <\/p>\n
\n| `\/reports admin ban-session <\/p>\n
\n| `\/reports admin unban-session <\/p>\n\u2699\ufe0f Configuration Preview<\/summary>\n
\nprefix: “&7[&cReports&7] &r”<\/p>\n
\nnotify-sound-source: “MASTER”
\nnotify-on-join: true
\nnotify-delay-seconds: 5
\nannounce-solved: false # Reply to reporter when their report is closed
\nmax-open-reports: 10 # Max open reports per player, set to 0 for unlimited
\nreports-per-page: 5 # Number of reports to show per page in the \/reports
\nprotect-staff: true # Prevent players from reporting staff members
\nprotect-permission: “reports.protect” # Permission to bypass staff protection<\/p>\n
\nmin-close-comment-length: 10 # Minimum length for close comment<\/p>\n
\nrate-limit: # refillGreedy
\n enabled: true
\n time-seconds: 180 # Time to refill in seconds
\n tokens: 5 # Max reports allowed in the time above
\n refill-tokens: 5 # Number of tokens to refill after each time
\n can-bypass: true
\n bypass-permission: “reports.bypassratelimit”<\/p>\n
\n log-startup: true # Log startup to discord audit log channel
\n token: “EXAMPLE_TOKEN”
\n channel-id: 1111111111111111111 # Audit log channel
\n app-id: 1111111111111111111 # Discord app ID
\n guild-id: 1111111111111111111 # Discord server ID
\n category-id: 1111111111111111111 # Category for report channels
\n activity: “ReportSystem v{version}” # Discord presence
\n channel-template: “report-{reporter}” # Channel name template. Vars: {reporter}, {target}, {id}
\n channel-message: “|| <@&ROLE_ID> ||” # Message to be sent in the report channel
\n suppress_notifications: false # Send with @silent<\/p>\n
\n enabled: false
\n url: “https:\/\/call.xap3y.eu\/v1\/discord\/transcript\/upload”
\n url-get: “https:\/\/space.xap3y.eu\/mc\/report\/”
\n key: “example_key” # Generate here: https:\/\/space.xap3y.eu\/mc\/report\/get-key
\n media-save-api-key: “example_key” # Same key as above
\n file-save: false # Save a local copy of the transcript file
\n save-media: false # Save media files (images,videos,gifs)
\n media-save-api: “https:\/\/call.xap3y.eu\/v1\/image\/upload\/url”
\n user-agent: “ReportSystem\/1.0”
\n media-timeout: 5 # http timeout in seconds for media upload
\n res-json-template: “\/message\/urlSet\/rawUrl” # Json template to extract url from space api, dont change
\n“`<\/p>\n<\/details>\n","protected":false},"excerpt":{"rendered":"