AevorinReports

插件

· 作者 aiversity

Minecraft 服务器首选的 #1 /report 插件

0 本站下载 0 关注 更新于 1 个月前

最新 1.1.3 · 26.3 · Bukkit / Folia

一键开服(送7天)

AevorinReports Banner

官方文档

概述

AevorinReports 是一个现代且强大的举报系统,专为需要结构化管理流程的 Minecraft 服务器而设计。它允许玩家轻松提交举报,同时为工作人员提供强大的工具,以便高效地审查、管理和解决举报。该插件经过性能优化,支持多种 GUI 样式,集成了 Discord,并可在单服和网络中无缝扩展。


区域限制

AevorinReports 设计为全球使用;但请注意,位于 以色列 境内的服务器将受到限制,插件无法运行。此限制通过自动 IP/时区验证强制执行。

#FreePalestine


1. 核心功能

  • 交互式管理员 GUI – 使用简洁的点击式界面审查、管理和更新举报
  • 玩家举报历史 – 玩家可以使用 /reports 查看已提交的举报及其状态
  • 多种 GUI 类型 – 支持 书本 GUI 和 容器(箱子)GUI 样式
  • 实时工作人员警报 – 在提交举报时即时通知工作人员
  • 清晰的状态工作流 – 举报状态从 待处理 → 已解决 / 已拒绝 转换
  • 自定义举报理由 – 允许玩家通过聊天输入提供自定义理由
  • MiniMessage 支持 – 完全可自定义的消息,支持渐变、悬停事件和格式化
  • Discord 集成 – 专用的 Discord 机器人,支持嵌入内容和实时通知
  • 数据库支持 – SQLite(本地)和 MySQL(网络范围同步)
  • 优化性能 – 异步处理和智能缓存
  • 完整本地化支持 – 内置多语言系统,支持自定义语言包
  • PlaceholderAPI 支持 – 提供文档记录的举报统计占位符,详见 PlaceholderAPI wiki
  • bStats & FastStats 集成 – 匿名使用统计数据和高级遥测数据,以获取开发洞察

2. 命令

2.1 玩家命令

命令 描述 权限
/report <player> [reason] 对某名玩家提交举报 aevorinreports.report
/reports 查看你提交的举报及其状态 aevorinreports.report

备注:

  • 如果 /report 未提供理由,将打开一个 GUI
  • 可以通过聊天输入自定义理由

2.2 工作人员命令

命令 描述 权限
/reports 打开管理员举报管理 GUI aevorinreports.manage
/viewreport <id> 查看详细举报信息 aevorinreports.manage
/setreportstatus <id> to <status> 更新举报状态 aevorinreports.manage
/ar reload 重新加载插件配置 aevorinreports.reload

2.3 Discord 机器人命令

命令 描述
/reports 列出所有活跃的待处理举报
/lookup <id> 查看特定举报的完整详情
/resolve <id> 将举报标记为已解决
/reject <id> 将举报标记为已拒绝
/pending <id> 将举报标记为待处理
/help 查看机器人帮助菜单

3. 权限

3.1 基本权限

权限 描述 默认值
aevorinreports.report 允许玩家提交举报 true
aevorinreports.manage 允许工作人员管理举报并访问管理员 GUI op
aevorinreports.notify 在提交举报时接收通知 op
aevorinreports.reload 重新加载配置 op

3.2 通配符权限

权限 描述
aevorinreports.* 授予所有 AevorinReports 权限

4. 举报工作流

  1. 玩家使用 /report 提交举报
  2. 工作人员收到即时通知
  3. 举报被标记为 待处理
  4. 工作人员通过管理员 GUI 审查举报
  5. 举报被标记为 已解决 或 已拒绝

所有操作都会被记录,当使用 MySQL 时,跨服务器同步。


5. 配置 (config.yml)

本节记录 config.yml 中每个可用选项,解释其用途和推荐用法。


配置版本系统

# 请勿更改配置版本
config-version: 5

config-version 字段用于让 AevorinReports 在插件更新到需要更改 config.yml 的新版本时,自动管理和迁移您的配置。

工作原理

  1. 插件加载时,会从现有的 config.yml 中读取 config-version 的值。
  2. 将该值与当前插件 .jar 内捆绑的版本进行比较。
  3. 如果两者匹配:无需进行迁移。插件将正常运行。
  4. 如果捆绑版本更高:插件会自动执行以下操作:
    • 将现有文件备份为 config.yml.old。
    • 将所有现有设置(服务器名称、数据库凭据、Discord Token 等)迁移到新的配置结构中。
    • 写入包含所有新必填字段的全新 config.yml,同时保留您的数据。

[!CAUTION] 切勿手动编辑 config-version 字段。 修改该值会导致插件跳过或重复执行迁移,从而损坏您的配置。如果需要重置配置,只需删除 config.yml 并重启服务器即可。

[!TIP] 在每次迁移运行之前,您的旧配置文件都会安全地备份为 config.yml.old。如果出现问题,您可以从该文件中恢复您的设置。


5.0 语言设置

language: "en_US"
  • 设置从 plugins/AevorinReports/lang/ 文件夹加载的活跃语言文件。
  • 该值必须与该文件夹内的 .yml 文件名匹配(不含扩展名)。
  • 内置语言(首次启动时自动提取):
    • en_US – 英语(默认)
    • it_IT – 意大利语
    • sk_SK – 斯洛伐克语
    • pl_PL – 波兰语
    • zh_CN – 简体中文
  • 自定义语言文件:您可以在 lang/ 文件夹内创建自己的 .yml 文件。
    • 自定义文件绝不会被插件更新覆盖。
    • 自定义文件中缺失的任何键将自动回退到 en_US 的值,因此插件不会因未翻译的字符串而崩溃。
    • 控制台警告将列出任何缺失的键,以帮助您保持翻译的更新。

5.1 服务器配置

server-name: "survival"
  • server-name:在多服务器环境中标识服务器。
    • 当多个服务器共享同一数据库时,必须唯一。
    • 显示在 Discord 嵌入和网络范围内的日志中。
    • 克隆服务器:在首次启动克隆服务器实例之前,请从其根目录中删除复制的 aevorin_server_token.dat 文件,以便生成新的、唯一的服务器身份令牌。

5.2 数据库配置

database:
  type: "file" # mysql or file

数据库类型

  • file:使用本地 SQLite 存储(推荐用于单服务器环境)。
  • mysql:启用网络中的跨服务器同步功能。

MySQL 设置

mysql:
  host: "localhost"
  port: 3306
  database: "aevorin_reports"
  username: "root"
  password: "password"
  • 仅在 type 设置为 mysql 时使用。
  • 所有服务器必须共享相同的凭据以实现同步。

文件存储

file:
  path: "database/reports.db"
  • SQLite 数据库文件的位置。

连接池(高级)

pool:
  minimum-idle: 5
  maximum-pool-size: 10
  connection-timeout: 30000
  • 优化数据库性能。
  • 除非需要调整,否则建议保留默认值。

5.3 举报设置

reports:
  allow-self-reporting: false
  • 禁用时,防止玩家举报自己。

GUI 配置

gui:
  type: "book" # book or container
  • book:经典的书籍风格界面。
  • container:现代的物品栏风格 GUI。

限制与冷却时间

cooldown: 300
max-active-reports: 3
  • cooldown:提交举报之间的间隔时间(秒)。
  • max-active-reports:每个玩家最大未解决的举报数量。

自定义原因

allow-custom-reasons: true
custom-reason-min-length: 10
custom-reason-max-length: 100
  • 允许玩家通过聊天提交自定义原因。
  • 长度限制可防止垃圾信息和滥用行为。

举报分类

categories:
  - "Hacking/Cheating"
  - "Harassment/Bullying"
  - "Spam/Advertisement"
  • 显示在举报 GUI 中。
  • 分类完全可自定义。

5.4 通知设置

notifications:
  new-report: true
  status-change: true
  sound: "BLOCK_NOTE_BLOCK_PLING"
  • new-report:当创建举报时通知工作人员。
  • status-change:当举报状态更改时通知工作人员。
  • sound:工作人员警报播放的声音(空字符串表示禁用)。

聊天前缀

出现在大多数插件消息之前的聊天前缀在语言文件中进行配置,以支持本地化品牌标识。

# Found in lang/en_US.yml
messages:
  prefix: "&8[&bAevorinReports&8]&r "

5.5 更新检查器

update-checker:
  check-interval: 60
  notify-on-join: true
  • 自动检查新的插件版本。
  • 在玩家加入时通知有权限的玩家。

5.6 调试设置

debug:
  enabled: false
  log-queries: false
  • enabled:启用详细的调试日志记录。
  • log-queries:记录数据库查询(不建议在生产环境中使用)。

5.7 消息自定义

messages:
  report-created: "&aYour report has been submitted successfully!"
  • 完全可自定义的消息。
  • 支持颜色代码 (&) 和占位符。
  • 在适用的情况下支持 MiniMessage。
  • PlaceholderAPI 占位符可用于支持的 GUI 文本中,包括容器 GUI 标题、物品名称和描述。
  • 请参阅官方 AevorinReports PlaceholderAPI 占位符列表。

5.8 Discord 集成

discord:
  enabled: false

网络模式(多服务器)

network-mode:
  enabled: false # set to true on ONE server only in a network
  poll-interval: 10 # how often to sync reports from the database (seconds)
  • enabled:如果为 true,此服务器将轮询数据库中来自所有服务器的举报。
  • poll-interval:数据库检查的频率。建议值:5-10。

核心设置

bot-token: "YOUR_BOT_TOKEN_HERE"
channel-id: "YOUR_CHANNEL_ID_HERE"
log-channel-id: "YOUR_LOG_CHANNEL_ID_HERE"
  • 将报告和处理状态更新直接发送至 Discord。

管理员权限

staff-role-id: ""
  • 可选的角色限制,用于 Discord 管理命令。

机器人外观

bot-settings:
  status: "ONLINE"
  activity:
    type: "WATCHING"
    message: "Reports | %online_players% players online"

Discord 通知

notifications:
  title: "New Report (#%id%)"
  color: "#ff5555"
  footer: "AevorinReports • %date%"
  • 完全可自定义的嵌入格式。

6. Discord 功能

  • 提交报告的通知
  • 状态更新提醒
  • 带有玩家头像的嵌入消息
  • 显示服务器和报告元数据

7. GUI 预览

AevorinReports Book GUI


8. 技术特性

  • 异步数据库操作
  • 线程安全的报告处理
  • 高效的缓存系统
  • 模块化且可扩展的架构
  • 安全的热重载处理

9. 依赖项

可选

  • MySQL – 跨网络报告同步
  • Discord API (JDA) – Discord 机器人集成

注意:

  • 这些可选依赖项已内置在插件中,可以从 config.yml 启用

10. 安装指南

  1. 从 Modrinth 页面下载 AevorinReports
  2. 将 .jar 文件放入 /plugins/ 目录
  3. 重启服务器以生成配置文件
  4. 配置 config.yml 和数据库设置
  5. (可选)配置 Discord 集成
  6. 重载或重启服务器

11. 分析与遥测

FastStats & bStats

Servers & Players

FastStats

AevorinReports 还使用 FastStats 进行高级实时插件分析。以下自定义指标被用于指导未来的开发:

指标 描述
pending_reports 服务器上当前待处理的报告数量
total_reports 服务器上创建的报告总数
gui_provider 服务器使用的 GUI 类型 (book 或 container)
db_backend 正在使用的数据库后端 (file 或 mysql)
configured_categories 服务器设置的报告类别数量
discord_integration Discord 机器人是否启用 (true/false)

所有遥测数据均为匿名收集——从不收集任何玩家数据、用户名、IP 地址或个人身份信息。


12. 许可证

AevorinReports 根据 MIT License 许可。

您可以自由使用、修改、分发和再许可本软件,前提是所有副本中均包含原始版权声明和许可证声明。


致谢

由 Aevorin Studios 开发

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源