# VelocityReport — Velocity 跨服举报插件 ![Version](https://img.shields.io/badge/version-2.1.1-green) ![Velocity](https://img.shields.io/badge/Velocity-3.x-blue) ![License](https://img.shields.io/badge/license-MIT-orange) >A Velocity proxy plugin supporting cross-server reporting and other features. Install on the proxy only—no sub-server installation required. > 一款轻量级、跨子服的玩家举报管理系统,支持SQLite、MySQL数据库，English、简体中文等语言。仅需安装在 Velocity 代理服务器上，无需后端子服务器插件。反馈BUG联系作者QQ:1464670605 邮箱:1464670605@qq.com --- ## 功能概览 | 功能 | 说明 | |------|------| | ✅ 跨服举报 | 举报任意子服的在线玩家 | | ✅ 原因选择菜单 | 点击聊天按钮选择举报原因，无需手动打字 | | ✅ 管理员管理 GUI | 基于点击聊天的举报历史管理，支持分页 | | ✅ 状态标记 | 标记已处理 / 重新打开，自动通知举报人 | | ✅ 管理员通知 | 新举报实时通知在线管理员 | | ✅ 权限控制 | 支持 LuckPerms，也支持 `staff-users` 名单 | | ✅ 双数据库 | 支持 SQLite 和 MySQL，配置文件可切换 | | ✅ 中文消息 | 全中文界面，支持 `&` 颜色代码 | | ✅ 服务器名映射 | 子服名可映射为自定义显示名称 | | ✅ 防刷机制 | 可配置举报冷却时间 | | ✅ 热重载 | `/reportreload` 无需重启代理 | | ✅ Tab 补全 | 输入/report 可以按TAB自动补全玩家名称 | --- ## Feature Overview | Feature | Description | | :--- | :--- | | ✅ **Cross-Server Reporting** | Report players online on any backend server. | | ✅ **Reason Selection Menu** | Select report reasons via clickable chat buttons—no manual typing required. | | ✅ **Admin Management GUI** | Manage report history through an interactive chat GUI with pagination support. | | ✅ **Status Tracking** | Mark reports as "Resolved" or "Reopen" them; reporters are notified automatically. | | ✅ **Admin Notifications** | Online admins receive real-time alerts for new reports. | | ✅ **Permission Control** | Supports LuckPerms integration or a simple `staff-users` list. | | ✅ **Dual Database Support** | Switch between SQLite and MySQL easily via the config file. | | ✅ **Localized Messages** | Full Simplified Chinese interface with `&` color code support. | | ✅ **Server Name Mapping** | Map internal sub-server names to custom display names. | | ✅ **Anti-Spam Cooldown** | Configurable cooldown timer to prevent report spamming. | | ✅ **Hot Reload** | Use `/reportreload` to apply config changes instantly—no proxy restart needed. | | ✅ **Tab Completion** | Auto-complete player names by pressing `TAB` after typing `/report`. | ## 安装 1. 下载 `Velocity-Report 最新版本jar文件` 2. 复制到 Velocity 的 `plugins/` 目录 3. 重启 Velocity 代理服务器插件首次启动会自动生成 `plugins/velocity-report/config.yml` 和 `plugins/velocity-report/reports.db`。 --- ## 🔧 配置文件 ```yaml # ── 语言设置 / Language ──────────────────────────────────── # 支持的语言 / Supported languages: # zh — 中文 (Chinese) # en — English language: zh # ── 数据库配置 ── database: type: sqlite # sqlite 或 mysql sqlite: filename: "reports.db" mysql: host: "127.0.0.1" port: 3306 database: "velocity_report" user: "root" password: "" # 举报冷却时间（秒），设为 0 关闭 # Report cooldown (seconds), set to 0 to disable cooldown-seconds: 60 # 每页显示数量 reports-per-page: 10 # ── 举报原因模板 / Report Reasons ────────────────────────── # 玩家输入 /report <玩家> 时将显示点击选择菜单 # When a player runs /report , a clickable menu will show # id: 原因标识符 / reason identifier # name: 显示名称（支持 & 颜色代码）/ display name (& color codes supported） # description: 悬停描述文本 / hover description # icon: 图标表情 / icon emoji report-reasons: - id: "hacking" name: "&cHacking / 外挂作弊" description: "KillAura, ESP, AutoClicker etc. / 透视、自瞄、连点等" icon: "⛏" - id: "chat" name: "&eChat Violation / 违规言论" description: "Swearing, spamming, advertising etc. / 骂人、刷屏、违规广告等" icon: "💬" - id: "griefing" name: "&6Griefing / 熊孩子" description: "Griefing builds, stealing etc. / 破坏建筑、偷东西等" icon: "💥" - id: "admin-abuse" name: "&5Admin Abuse / 管理员神权" description: "Admin abusing permissions / 管理员滥用权限" icon: "⚡" - id: "other" name: "&7Other / 其他" description: "Use /report to customize / 使用 /report <玩家> <原因> 自定义" icon: "📋" # 每页显示的举报数量 # Reports per page reports-per-page: 10 # 管理员名单（不区分大小写） # 未安装 LuckPerms 等权限插件时，在此处列出管理员用户名即可看到举报通知和后台命令 # Staff usernames (case-insensitive) # Used when no permission plugin (like LuckPerms) is installed staff-users: - "YuHongChen" # 服务器名称映射（原始名称 → 显示名称） # 用于在举报消息中将子服名显示为自定义文本 # 也支持 & 颜色代码（如 &e 黄色） # Server name aliases (raw name → display name) # Used to show custom server names in report messages # & color codes supported (e.g. &e for yellow) server-aliases: lobby: "&eLobby / 登录服" survival: "&aSurvival / 生存服" minigame: "&6Minigame / 小游戏" # 消息模板（支持 MiniMessage + &颜色代码） messages: prefix: "&c[举报]&r " report-sent: "&a你对 &e{reported} &a的举报已提交，感谢反馈。" # ... # ── 消息配置 / Messages ──────────────────────────────────── # 此处可覆盖语言文件中的特定消息，优先级高于语言文件 # Here you can override specific messages from the language file # These overrides take priority over the language file (lang_*.yml) # # 可用的消息键 / Available message keys: # prefix, report-sent, report-cooldown, self-report, player-not-found, # no-reports, report-list-header, report-entry, report-detail, # report-closed, staff-notify, staff-join-notify, invalid-report-id, already-closed # # 更多键请参见 lang_zh.yml 或 lang_en.yml # See lang_zh.yml or lang_en.yml for all available keys # messages: # prefix: "[Report] " # report-sent: "Your report against {reported} has been submitted." ``` 详情见 `config.yml` 完整注释。 --- ## 命令列表 ### 玩家命令 | 命令 | 权限 | 说明 | |------|------|------| | `/report <玩家>` | 所有人 | 打开举报原因选择菜单 | | `/report <玩家> <原因>` | 所有人 | 直接提交举报 | | `/rep <玩家> ...` | 所有人 | `/report` 的别名 | ### 管理命令 | 命令 | 权限 | 说明 | |------|------|------| | `/reports [页码]` | `velocityreport.staff` | 查看待处理举报 | | `/reportview <编号>` | `velocityreport.staff` | 查看举报详情 | | `/reportclose <编号> [说明]` | `velocityreport.staff` | 关闭举报 | | `/reportcd` | `velocityreport.staff` | 打开举报管理菜单 | | `/reportcd list [页码] [玩家]` | `velocityreport.staff` | 查看举报记录 | | `/reportcd view <编号>` | `velocityreport.staff` | 查看详情（含操作按钮） | | `/reportcd resolve <编号>` | `velocityreport.staff` | 标记已处理 | | `/reportcd reopen <编号>` | `velocityreport.staff` | 重新打开 | | `/reportreload` | `velocityreport.staff` | 热重载配置文件 | | `/closereport`, `/resolvereport` | `velocityreport.staff` | `/reportclose` 的别名 | ### 权限节点 | 权限 | 默认 | 说明 | |------|------|------| | `velocityreport.report` | 所有人 | 使用 `/report` | | `velocityreport.staff` | OP | 查看和管理举报 | | `velocityreport.notify` | OP | 接收举报通知 | | `velocityreport.bypasscooldown` | OP | 跳过冷却 | --- ## 使用流程 ### 玩家举报 ``` 1. 输入 /report Steve 2. 聊天框弹出原因选择菜单 3. 点击 "⛏ 外挂作弊" 4. ✓ 举报已提交 ``` ### 管理员处理 ``` 1. 收到通知：[举报] Alex 举报了 Steve 在 lobby: 外挂作弊 2. 输入 /reportcd 3. 点击举报记录查看详情 4. 点击 [✅ 标记已处理] 5. ✓ 举报人收到通知 ``` --- ## 数据库 ### SQLite（默认）数据文件位于 `plugins/velocity-report/reports.db`，零配置。 ### MySQL 修改 `config.yml` 中 `database.type` 为 `mysql`，并填写连接信息： ```yaml database: type: mysql mysql: host: "127.0.0.1" port: 3306 database: "velocity_report" user: "root" password: "your_password" ``` 首次使用需先创建数据库： ```sql CREATE DATABASE IF NOT EXISTS velocity_report DEFAULT CHARSET utf8mb4; ``` --- ### 依赖 | 依赖 | 用途 | |------|------| | Velocity API 3.3.0+ | 代理 API | | SQLite JDBC | SQLite 数据库驱动 | | MySQL Connector/J | MySQL 数据库驱动 | | SnakeYAML | YAML 配置解析 | | Maven Shade Plugin | 打包 fat JAR | --- ## 作者 **YuHongChen(LiquidTeam)** ## 许可 MIT License

Velocity-Report

Compatibility

Minecraft: Java Edition

Platforms

Links

Tags

Creators

Details