?️ Velocity 报告系统
一款功能强大、高性能的报告解决方案,专为 Velocity 代理服务器设计,与 Discord 和 MariaDB 无缝集成。该插件通过为每份报告创建专用的 Discord 频道,架起了 Minecraft 服务器与工作人员团队之间的桥梁。
? 主要特性
- Discord 集成: 自动为新报告创建唯一的文本频道。
- 网页转录: 在报告关闭时生成并托管专业的聊天记录转录(包括媒体/图片)。
- 高级速率限制: 通过“贪婪令牌”系统防止垃圾信息。
- 完全可定制:
config.yml 中的每条消息、音效和权限节点均可编辑。
- 员工保护: 可选设置,防止玩家举报管理员。
- 跨服务器同步: 作为 Velocity 插件,它处理整个网络中的所有报告。
?️ 安装与要求
前置条件
- MariaDB 数据库: 用于持久化数据存储。
- Discord Bot: 一个在 Discord Developer Portal 注册的机器人应用。
- Discord 服务器
设置指南
- Bot 设置: 在 Discord 门户创建机器人,重置令牌,并复制 Token 和 Application ID。
- Discord 布局: 创建一个类别,机器人将在其中生成报告频道,以及一个用于 审计日志 的特定频道。
- 首次运行: 将插件放入 Velocity 的
plugins 文件夹中,启动服务器以生成默认配置。
- 配置: * 输入您的 MariaDB 凭据。
- 填写
discord-bot 部分(Token、Guild ID、Category ID 等)。
- 重启: 重启代理以初始化机器人和数据库连接。
? 转录设置
要为已关闭的报告启用基于网页的转录:
- 在 space.xap3y.eu 生成 API 密钥。
- 在
config.yml 中,将 discord-bot.transcripts.enabled 设置为 true。
- 将您的密钥粘贴到
key 和 media-save-api-key 中。
- (可选) 启用
save-media 以归档发送到 Discord 报告频道的图片/视频。
预览

⌨️ 命令与权限
玩家命令
| 命令 |
描述 |
权限 |
/report <player> <reason> |
提交新报告 |
默认 (或 reports.report) |
/reports |
打开报告管理列表 |
无 |
/reports view-open |
查看您自己的未结报告 |
无 |
员工与管理员命令
| 命令 |
描述 |
权限 |
/reports reload |
重载配置文件和语言文件 |
reports.reload |
/reports info <id> |
查看详细报告数据 |
reports.info |
/reports close <id> |
关闭活动报告 |
reports.close |
/reports delete <id> |
从数据库中删除报告 |
reports.delete |
/reports admin view-open |
查看网络上所有未结报告 |
reports.admin.view |
/reports admin view-closed |
查看网络上所有已关闭报告 |
reports.admin.view |
/reports admin view-player sent <p> [status] |
查看特定玩家发送的报告 |
reports.admin.view |
/reports admin view-player received <p> [status] |
查看针对特定玩家的投诉 |
reports.admin.view |
/reports admin ban-session <p> |
阻止玩家使用 /report |
reports.admin.ban |
/reports admin unban-session <p> |
恢复玩家的报告能力 |
reports.admin.ban |
功能请求
使用问题跟踪器链接创建 Issue,并简要描述您想要添加的内容
⚙️ 配置预览
prefix: "&7[&cReports&7] &r"
enabled: true
require-permission: false # 权限: reports.report
notify-sound: "entity.experience_orb.pickup"
notify-sound-source: "MASTER"
notify-on-join: true
notify-delay-seconds: 5
announce-solved: true # 当报告关闭时回复举报者
max-open-reports: 10 # 每个玩家的最大未结报告数,设为 0 表示无限制
reports-per-page: 5 # /reports 中每页显示的报告数量
protect-staff: true # 防止玩家举报员工
protect-permission: "reports.protect" # 绕过员工保护的权限
# 实时网站控制面板。API 密钥在空白时回退到 discord-bot.transcripts.key。
# 此密钥与转录密钥不同!!!
portal:
enabled: false
debug: false # 记录 WebSocket 详细信息,包括 API 密钥;故障排除后请禁用
websocket-url: "wss://call.xap3y.eu/ws/mc-reports"
user-agent: "ReportSystem/{version}"
api-key: "" # 在 discord 上联系我获取密钥: xap3y
reconnect-seconds: 10
close-comment-required: false # 关闭报告时需要评论
min-close-comment-length: 10 # 关闭评论的最小长度
# 是否对 /report 命令进行速率限制?
rate-limit: # refillGreedy
enabled: true
time-seconds: 180 # 填充时间(秒)
tokens: 5 # 在上述时间内允许的最大报告数
refill-tokens: 5 # 每次时间后重新填充的令牌数量
can-bypass: true
bypass-permission: "reports.bypassratelimit"
# 限制同一举报者举报同一玩家的频率。
same-player-rate-limit:
enabled: true
max-reports: 1
time-seconds: 600 # 10 分钟
discord-bot:
log-startup: true # 将启动日志记录到 Discord 审计日志频道
token: "EXAMPLE_TOKEN"
guild-id: 1111111111111111111 # Discord 服务器 ID
channel-id: 1111111111111111111 # 审计日志频道
app-id: 1111111111111111111 # Discord 应用 ID
category-id: 1111111111111111111 # 举报频道的分类
use-topic: false
channel-topic: "topic" # {open} | {closed} | {total}
activity: "ReportSystem v{version}" # Discord 在线状态
channel-template: "report-{reporter}" # {reporter}, {target}, {id}
channel-message: "|| <@&ROLE_ID> ||" # 发送到举报频道的消息
suppress-notifications: false # 使用 @silent 发送
send-chat-history: true
chat-history-messages-per-page: 20
admin-role-ids:
- 1111111111111111111
- 2222222222222222222
transcripts:
enabled: false
url: "https://call.xap3y.eu/v1/discord/transcript/upload"
url-get: "https://space.xap3y.eu/mc/report/"
url-get-ending: "?ref=test"
key: "example_key" # 在此生成:https://space.xap3y.eu/mc/report/get-key
media-save-api-key: "example_key" # 与上方相同的密钥
file-save: false # 保存转录文件的本地副本
save-attachments: true # 在 CDN 链接过期前保存所有 Discord 附件
media-save-api: "https://call.xap3y.eu/v1/image/upload/url"
user-agent: "ReportSystem/1.5.0"
media-timeout: 10 # 附件上传的 HTTP 超时时间(秒)
res-json-template: "/message/urlSet/rawUrl" # 从 space api 提取 URL 的 JSON 模板,请勿更改
database:
host: "localhost"
port: 3306
database: "reports_db"
username: "reports_user"
password: "securepassword"
max-pool-size: 10
minIdle: 2
pool-refresh: true # 每 30 分钟刷新连接池
refresh-interval: 600000 # 毫秒(10 分钟)- 多久从数据库刷新当前打开的报告
lang:
only-player: "&c此命令只能由玩家执行。"
no-permission: "&c你没有权限执行此命令。"
reload: "&a配置已成功重新加载。"
plugin-disabled: "&cReportSystem 当前已禁用。"
fail: "&c处理你的请求时发生错误。"
report-usage: "&c用法:/report <player> <reason>"
report-success: "&a你已成功举报 &c{target}。"
report-yourself: "&c你不能举报自己。"
report-cooldown: "&c你处于冷却时间中。请稍后再试。"
report-rate-limit: "&c你操作太快了。请在 {sec} 秒后重试。"
report-same-player-rate-limit: "&c你最近举报该玩家的次数过多。请在 {minutes} 分钟后重试。"
report-announce: "&c{reporter} &a已举报 &c{target} &a原因是 &c{reason}&a。"
report-join-notify: "&c目前有 &e&l{count} &r&c个已打开的举报!"
report-max-reports: "&c你同时不能拥有超过 &f{max} &c个打开的举报。"
report-no-reason: "&c用法错误!&f/report <player> <reason>"
report-no-player: "&c用法错误!&f/report <player> <reason>"
player-not-found: "&c未找到玩家 &c。"
report-close-no-id: "&c用法错误!&f/reports close <id> [reason]"
report-close-no-reason: "&c你必须提供关闭举报的原因。&f/reports close <id> <reason>"
report-delete-no-id: "&c用法错误!&f/reports delete <id>"
report-info-no-id: "&c用法错误!&f/reports info <id>"
report-not-found: "&c未找到 ID 为 &f{id} &c的举报。"
report-already-closed: "&cID 为 &f{id} &c的举报已关闭。"
report-closed: "&a你已成功关闭 ID 为 &c{id} &a的举报"
report-close-discord-error: "&c在 Discord 中关闭举报时发生错误。"
report-deleted: "&a你已成功删除 ID 为 &c{id} &a的举报"
report-delete-discord-error: "&c在 Discord 中删除举报时发生错误。"
report-already-deleted: "&cID 为 &f{id} &c的举报已删除。"
no-reports-found: "&c未找到任何举报。"
closed-reports-header: "&c已关闭的举报"
report-ban: "&c你无法提交举报。"
report-ban-already: "&c你已被禁止向 &f{player}&c 提交举报。"
report-unban-already: "&c玩家 &f{player}&c 未被禁止提交举报。"
report-ban-success: "&a你已成功禁止 &f{player}&a 提交举报。"
report-unban-success: "&a你已成功解除对 &f{player}&a 的举报提交禁令。"
report-close-reason-too-short: "&c关闭原因必须至少包含 &f{min} &c个字符。"
open-reports-header: "&a打开的举报"
new-report: "新举报"
page: "页"
time: "时间"
reason: "原因"
reported-player: "被举报玩家"
reported-by: "举报者"
closed-by: "关闭者"
deleted-by: "删除者"
report-is-closed: "举报已关闭"
report-is-deleted: "举报已删除"
closed-at: "关闭于"
comment: "评论"
view: "查看"
prev: "上一页"
next: "下一页"
close-report: "关闭举报"
close-reason: "关闭原因"
close-reason-lore: "关闭举报的原因(可选)"
close-report-lore: "点击关闭此举报。"
report-solved-announce: "&a你的 ID 为 &c{id} &a的举报已被关闭。"
report-solved-details-button: "查看"
report-solved-details-hover: "&7关闭原因:&e{reason}\n&7关闭者:&e{closer}\n&7关闭时间:&e{time}"
report-solved-no-reason: "未提供原因"
report-solved-unknown-closer: "未知"
report-solved-unknown-time: "未知"
page-out-of-range: "&4内部错误:页码超出范围。"
report-protected: "&c你不能举报该玩家。"
# Discord 本地化
no-permission-button: "你没有权限与此按钮交互。"
no-permission-modal: "你没有权限提交此表单。"
no-permission-command: "你没有权限执行此命令。"
close-button: "关闭"
delete-button: "删除"
chatlog-title: "聊天记录"
chatlog-empty: "此报告没有可用的聊天记录。"
delete-btn-save-no-reason: "保存记录(无理由)"
delete-btn-save-reason: "保存记录(有理由)"
delete-btn-no-save-no-reason: "仅删除(无理由)"
delete-btn-no-save-reason: "仅删除(有理由)"
delete-btn-cancel: "取消"
delete-prompt: "确定要删除报告 #{id} 吗?\n请在下方选择一个选项:"
delete-cancelled: "已取消删除。"
delete-reason-lore: "删除报告的理由"
delete-report: "删除报告"
delete-reason: "删除原因"
?️ Report System for Velocity
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.
? Key Features
- Discord Integration: Automatically creates a unique text channel for every new report.
- Web Transcripts: Generate and host professional chat transcripts (including media/images) when a report is closed.
- Advanced Rate Limiting: Prevent spam with a "Greedy Token" system.
- Fully Customizable: Every message, sound, and permission node can be edited in the
config.yml.
- Staff Protection: Optional settings to prevent players from reporting administrators.
- Cross-Server Sync: As a Velocity plugin, it handles reports across your entire network.
?️ Installation & Requirements
Pre-requisites
- MariaDB Database: Required for persistent data storage.
- Discord Bot: A registered application on the Discord Developer Portal.
- Discord Server
Setup Guide
- Bot Setup: Create a bot on the Discord portal, reset the token, and copy both the Token and Application ID.
- Discord Layout: Create a category where the bot will spawn report channels and a specific channel for the Audit Log.
- Initial Run: Place the plugin in your Velocity
plugins folder and start the server to generate the default configuration.
- Configuration: * Input your MariaDB credentials.
- Fill in the
discord-bot section (Token, Guild ID, Category ID, etc.).
- Restart: Restart the proxy to initialize the bot and database connection.
? Transcripts Setup
To enable web-based transcripts for closed reports:
- Generate an API key at space.xap3y.eu.
- In
config.yml, set discord-bot.transcripts.enabled to true.
- Paste your key into
key and media-save-api-key.
- (Optional) Enable
save-media to archive images/videos sent in the Discord report channel.
Preview

⌨️ Commands & Permissions
Player Commands
| Command |
Description |
Permission |
/report <player> <reason> |
Submit a new report |
Default (or reports.report) |
/reports |
Open the report management list |
None |
/reports view-open |
View your own open reports |
None |
Staff & Admin Commands
| Command |
Description |
Permission |
/reports reload |
Reload config and language files |
reports.reload |
/reports info <id> |
View detailed report data |
reports.info |
/reports close <id> |
Close an active report |
reports.close |
/reports delete <id> |
Remove report from database |
reports.delete |
/reports admin view-open |
View all open reports on the network |
reports.admin.view |
/reports admin view-closed |
View all closed reports on the network |
reports.admin.view |
/reports admin view-player sent <p> [status] |
View reports a specific player has sent |
reports.admin.view |
/reports admin view-player received <p> [status] |
View reports filed against a specific player |
reports.admin.view |
/reports admin ban-session <p> |
Block a player from using /report |
reports.admin.ban |
/reports admin unban-session <p> |
Restore a player's ability to report |
reports.admin.ban |
Feature request
Create an issue using the issue tracker link and briefly describe what would you like to add
⚙️ Configuration Preview
prefix: "&7[&cReports&7] &r"
enabled: true
require-permission: false # Permission: reports.report
notify-sound: "entity.experience_orb.pickup"
notify-sound-source: "MASTER"
notify-on-join: true
notify-delay-seconds: 5
announce-solved: true # Reply to reporter when their report is closed
max-open-reports: 10 # Max open reports per player, set to 0 for unlimited
reports-per-page: 5 # Number of reports to show per page in the /reports
protect-staff: true # Prevent players from reporting staff members
protect-permission: "reports.protect" # Permission to bypass staff protection
# Live website control portal. The API key falls back to discord-bot.transcripts.key when blank.
# This key is different from transcripts key!!!
portal:
enabled: false
debug: false # Logs WebSocket details including the API key; disable after troubleshooting
websocket-url: "wss://call.xap3y.eu/ws/mc-reports"
user-agent: "ReportSystem/{version}"
api-key: "" # Message me on discord for key: xap3y
reconnect-seconds: 10
close-comment-required: false # Require a comment when closing a report
min-close-comment-length: 10 # Minimum length for close comment
# Rate limit /report command?
rate-limit: # refillGreedy
enabled: true
time-seconds: 180 # Time to refill in seconds
tokens: 5 # Max reports allowed in the time above
refill-tokens: 5 # Number of tokens to refill after each time
can-bypass: true
bypass-permission: "reports.bypassratelimit"
# Limit how often one reporter can report the same player.
same-player-rate-limit:
enabled: true
max-reports: 1
time-seconds: 600 # 10 minutes
discord-bot:
log-startup: true # Log startup to discord audit log channel
token: "EXAMPLE_TOKEN"
guild-id: 1111111111111111111 # Discord server ID
channel-id: 1111111111111111111 # Audit log channel
app-id: 1111111111111111111 # Discord app ID
category-id: 1111111111111111111 # Category for report channels
use-topic: false
channel-topic: "topic" # {open} | {closed} | {total}
activity: "ReportSystem v{version}" # Discord presence
channel-template: "report-{reporter}" # {reporter}, {target}, {id}
channel-message: "|| <@&ROLE_ID> ||" # Message to be sent in the report channel
suppress-notifications: false # Send with @silent
send-chat-history: true
chat-history-messages-per-page: 20
admin-role-ids:
- 1111111111111111111
- 2222222222222222222
transcripts:
enabled: false
url: "https://call.xap3y.eu/v1/discord/transcript/upload"
url-get: "https://space.xap3y.eu/mc/report/"
url-get-ending: "?ref=test"
key: "example_key" # Generate here: https://space.xap3y.eu/mc/report/get-key
media-save-api-key: "example_key" # Same key as above
file-save: false # Save a local copy of the transcript file
save-attachments: true # Save all Discord attachments before their CDN links expire
media-save-api: "https://call.xap3y.eu/v1/image/upload/url"
user-agent: "ReportSystem/1.5.0"
media-timeout: 10 # HTTP timeout in seconds for attachment upload
res-json-template: "/message/urlSet/rawUrl" # Json template to extract url from space api, dont change
database:
host: "localhost"
port: 3306
database: "reports_db"
username: "reports_user"
password: "securepassword"
max-pool-size: 10
minIdle: 2
pool-refresh: true # Refresh the connection pool every 30 minutes
refresh-interval: 600000 # milliseconds (10 minutes) - how often to refresh current open reports from the database
lang:
only-player: "&cThis command can only be executed by a player."
no-permission: "&cYou do not have permission to execute this command."
reload: "&aConfiguration reloaded successfully."
plugin-disabled: "&cReportSystem is currently disabled."
fail: "&cAn error occurred while processing your request."
report-usage: "&cUsage: /report <player> <reason>"
report-success: "&aYou have successfully reported &c{target}."
report-yourself: "&cYou cannot report yourself."
report-cooldown: "&cYou are on cooldown. Please wait and try again later."
report-rate-limit: "&cYou're doing that too fast. Try again in {sec} seconds."
report-same-player-rate-limit: "&cYou have reported this player too many times recently. Try again in {minutes} minutes."
report-announce: "&c{reporter} &ahas reported &c{target} &afor &c{reason}&a."
report-join-notify: "&cThere are &e&l{count} &r&copened reports!"
report-max-reports: "&cYou cannot have more than &f{max} &copen reports at the same time."
report-no-reason: "&cWrong usage! &f/report <player> <reason>"
report-no-player: "&cWrong usage! &f/report <player> <reason>"
player-not-found: "&cPlayer &cnot found."
report-close-no-id: "&cWrong usage! &f/reports close <id> [reason]"
report-close-no-reason: "&cYou must provide a reason for closing the report. &f/reports close <id> <reason>"
report-delete-no-id: "&cWrong usage! &f/reports delete <id>"
report-info-no-id: "&cWrong usage! &f/reports info <id>"
report-not-found: "&cReport with ID &f{id} &cnot found."
report-already-closed: "&cReport with ID &f{id} &cis already closed."
report-closed: "&aYou have successfully closed report ID &c{id}"
report-close-discord-error: "&cAn error occurred while closing the report in Discord."
report-deleted: "&aYou have successfully deleted report ID &c{id}"
report-delete-discord-error: "&cAn error occurred while deleting the report in Discord."
report-already-deleted: "&cReport with ID &f{id} &cis already deleted."
no-reports-found: "&cNo reports found."
closed-reports-header: "&cClosed Reports"
report-ban: "&cYou cannot submit a report."
report-ban-already: "&cYou are already banned &f{player}&c from submitting reports."
report-unban-already: "&cPlayer &f{player}&c is not banned from submitting reports."
report-ban-success: "&aYou have successfully banned &f{player}&a from submitting reports."
report-unban-success: "&aYou have successfully unbanned &f{player}&a from submitting reports."
report-close-reason-too-short: "&cThe close reason must be at least &f{min} &ccharacters long."
open-reports-header: "&aOpen Reports"
new-report: "New Report"
page: "Page"
time: "Time"
reason: "Reason"
reported-player: "Reported Player"
reported-by: "Reported By"
closed-by: "Closed By"
deleted-by: "Deleted By"
report-is-closed: "Report Closed"
report-is-deleted: "Report Deleted"
closed-at: "Closed At"
comment: "Comment"
view: "View"
prev: "Prev"
next: "Next"
close-report: "Close Report"
close-reason: "Close Reason"
close-reason-lore: "Reason for closing the report (optional)"
close-report-lore: "Click to close this report."
report-solved-announce: "&aYour report with ID &c{id} &ahas been closed."
report-solved-details-button: "view"
report-solved-details-hover: "&7Close reason: &e{reason}\n&7Closed by: &e{closer}\n&7Closed at: &e{time}"
report-solved-no-reason: "No reason provided"
report-solved-unknown-closer: "Unknown"
report-solved-unknown-time: "Unknown"
page-out-of-range: "&4Internal error: Page number out of range."
report-protected: "&cYou cannot report this player."
# Discord Locale
no-permission-button: "You do not have permission to interact with this button."
no-permission-modal: "You do not have permission to submit this form."
no-permission-command: "You do not have permission to execute this command."
close-button: "Close"
delete-button: "Delete"
chatlog-title: "Chat Log"
chatlog-empty: "No chat history is available for this report."
delete-btn-save-no-reason: "Save Transcript (No Reason)"
delete-btn-save-reason: "Save Transcript (With Reason)"
delete-btn-no-save-no-reason: "Delete Only (No Reason)"
delete-btn-no-save-reason: "Delete Only (With Reason)"
delete-btn-cancel: "Cancel"
delete-prompt: "Are you sure you want to delete report #{id}?\nPlease select an option below:"
delete-cancelled: "Cancelled deletion."
delete-reason-lore: "Reason for deleting the report"
delete-report: "Delete Report"
delete-reason: "Delete Reason"
评论 0
登录后参与评分
还没有评论,来抢沙发吧