一个专为服务器管理团队设计的现代化游戏内玩家举报系统。
玩家可以轻松举报违规行为,而管理员则可以通过直观的图形用户界面(GUI)在游戏内直接审查、筛选和处理举报,拥有强大的工具支持。
4.0.0 版本是一次完全重写,引入了现代化的举报工作流、改进的管理工具、数据库支持、Discord 集成以及更多功能。
几乎所有的功能、消息和视觉元素都可以在配置文件中自定义!
- 现代化的游戏内举报系统
- 通过
/report 轻松进行玩家举报
- 可选的理由 GUI 和确认系统
- 面向工作人员的先进管理 GUI
- 将管理员指定为举报处理人
- 在游戏内直接筛选和排序举报
- 传送至被举报玩家或保存的位置
- 对有效举报的玩家给予奖励
- 支持在线与离线领取奖励
- Discord Webhook 集成用于接收举报和更新通知
- 支持 PlaceholderAPI 用于统计数据和集成
- 存储支持 YAML 或 MySQL
- 按玩家、ID、理由或处理人搜索举报
- 面向工作人员的通知系统
- 自动清理旧举报
- 高度可配置的消息、GUI 和行为
- 轻量级且针对性能进行了优化
- 支持 Folia
PlayerReport 旨在帮助工作人员快速高效地管理举报——直接在游戏中完成。
快速,如何实现? → 举报可以即时审查和更新。
高效,如何实现? → 轻量级设计配合优化的存储方案。
有效,如何实现? → 清晰的管理工作流并支持可选奖励。
举报将在完全可配置的 GUI 中显示。
工作人员可以:
- 审查举报
- 更改举报状态
- 分配处理人
- 传送到涉事玩家(举报者和被举报者)
- 删除举报
筛选和排序选项帮助管理员高效处理大量举报。
当玩家的举报被确认时,他们可以选择获得奖励。
奖励支持:
- 命令奖励
- 物品奖励
- 离线奖励存储
- 通过
/reports claim 领取奖励
由于支持命令奖励,此功能与其他插件兼容,例如将投票钥匙作为奖励发出,或者基本上任何其他命令。
这允许服务器鼓励玩家帮助维护公平的游戏环境。
命令
| 命令 |
权限 |
描述 |
/report <player> <reason> |
playerreport.report |
为玩家创建举报。 |
/reports |
playerreport.admin |
打开管理 GUI 以查看和管理举报。 |
/reports help |
playerreport.admin |
显示所有可用的 PlayerReport 命令。 |
/reports search user <player> |
playerreport.admin |
搜索由特定玩家创建或针对特定玩家的举报。 |
/reports search id <reportId> |
playerreport.admin |
通过唯一 ID 查找举报。 |
/reports search reason <text> |
playerreport.admin |
搜索包含特定理由的举报。 |
/reports search handler <player> |
playerreport.admin |
显示分配给特定管理员的举报。 |
/reports sethandler <reportId> <player|none> |
playerreport.admin.handler.set |
分配或移除管理员作为举报的处理人。 |
/reports clear |
playerreport.admin.clear |
清除过时或删除的举报。 |
/reports claim |
playerreport.claim |
领取已确认举报的奖励。 |
/reports on |
playerreport.admin.notify.toggle |
启用举报通知。 |
/reports off |
playerreport.admin.notify.toggle |
禁用举报通知。 |
/reports reload |
playerreport.reload |
重新加载插件配置文件。 |
权限
| 权限 |
描述 |
playerreport.* |
授予所有 PlayerReport 权限的访问权。 |
playerreport.report |
允许玩家使用 /report 创建举报。 |
playerreport.bypass.cooldown |
绕过举报冷却时间。 |
playerreport.immune |
防止玩家被举报。 |
playerreport.admin |
允许访问管理 GUI (/reports)。 |
playerreport.admin.handler.set |
允许分配或移除举报处理人。 |
playerreport.admin.clear |
允许使用 /reports clear 清除过时举报。 |
playerreport.admin.notify.toggle |
允许使用 /reports on/off 切换举报通知。 |
playerreport.reload |
允许使用 /reports reload 重新加载插件配置。 |
playerreport.update.notify |
在插件有可用更新时接收通知。 |
playerreport.claim |
允许玩家领取成功举报的奖励。 |
config.yml
# =========================================================
# PlayerReport - config.yml
# 基于 Paper 1.21.x 构建 (api-version: 1.20)
#
# 颜色代码:
# 使用 & 表示普通 Minecraft 颜色(例如:&a, &c, &7)
# lang.yml 中的 HEX 颜色支持通过 &#RRGGBB 或 #RRGGBB
# =========================================================
# =========================================================
# 举报设置
# 创建举报的相关设置
# =========================================================
reporting:
# 如果为 true,被举报玩家必须当前在线
# 才能被举报。
requireOnlineTarget: false
# 单个举报者同时拥有的最大未结举报数量。
maxOpenReportsPerReporter: 5
# 创建举报之间的冷却时间(秒)。
cooldownSeconds: 10
定义如何处理举报原因。
可用模式:
- FREETEXT = 玩家输入任意原因
- PREDEFINED = 玩家必须使用预定义的原因之一
- BOTH = 允许两种系统
reasonMode: FREETEXT
当启用 PREDEFINED 或 BOTH 时使用的预定义原因列表。
predefinedReasons:
- "作弊"
- "滥用漏洞"
- "骚扰"
用于选择预定义原因的 GUI。
reasonGui:
# 启用原因选择 GUI。
enabled: false
# 如果为 true,即使启用了原因 GUI,玩家仍可以通过命令直接输入原因。
allowCommandReason: true
# 原因选择 GUI 的物品栏标题。
title: "&c选择针对 &f%target% 的原因"
# 原因选择 GUI 的物品栏大小。
# 应为有效的箱子大小(9, 18, 27, 36, 45, 54)。
size: 27
filler:
# 如果为 true,空的 GUI 槽位将填充填充物品。
enabled: true
# 用于填充槽位的材料。
material: GRAY_STAINED_GLASS_PANE
reasonItem:
# 每个可选原因使用的材料。
material: PAPER
# 原因物品的显示名称。
name: "&a%reason%"
# 每个原因物品显示的说明文本。
lore:
- "&7举报 &f%target% &7原因:&b%reason%"
- ""
- "&e点击继续"
# 提交举报前显示的确认 GUI。
confirm:
# 确认 GUI 的标题。
title: "&c举报 &f%target% &c原因是 &b%reason%&c?"
filler:
# 用于确认 GUI 中空槽位的材料。
material: GRAY_STAINED_GLASS_PANE
yes:
# 确认按钮的材料。
material: LIME_WOOL
# 确认按钮的显示名称。
name: "&a是"
no:
# 取消按钮的材料。
material: RED_WOOL
# 取消按钮的显示名称。
name: "&c否"
=========================================================
认领
认领/处理程序行为的设置
=========================================================
claims:
如果为 true,当举报状态变为 IN_PROGRESS 时,管理员将自动认领该举报。
autoClaimOnInProgress: true
=========================================================
时间戳
显示日期和时间值的格式
=========================================================
timestamps:
用于举报时间戳的时区。
timezone: "Europe/Berlin"
日期格式模式。
dateFormat: "dd.MM.yyyy"
时间格式模式。
timeFormat: "HH:mm:ss"
最终显示格式。
可用占位符:{date}, {time}
displayFormat: "{date} {time}"
=========================================================
消息
通用消息显示设置
=========================================================
messages:
headerFooter:
# 启用消息中的可选页眉/页脚格式。
enabled: false
=========================================================
通知
工作人员通知设置
=========================================================
notifications:
如果为 true,通知切换状态将被持久存储。
persist: true
toggleCommand:
# 启用 /reports on 和 /reports off 命令。
enabled: true
=========================================================
删除/保留
控制已删除举报的处理方式
=========================================================
delete:
删除模式:
- TAG = 举报被标记为已删除
- PURGE = 永久移除举报
mode: TAG
已删除举报的保留期限。
0 通常意味着不进行基于保留期的清理。
retention: 0
=========================================================
更新
更新通知设置
=========================================================
updates:
如果为 true,拥有相应权限的玩家在加入服务器时会收到有关可用更新的通知。
notifyOnJoin: true
=========================================================
PlaceholderAPI
占位符扩展设置
=========================================================
placeholderapi:
如果安装了 PlaceholderAPI,则启用其支持。
enabled: true
=========================================================
存储
举报和待处理奖励的后端存储
支持的类型:
- YAML = 本地文件存储
- MYSQL = MySQL / MariaDB 数据库
=========================================================
storage:
reports:
# 用于举报的存储类型。
type: YAML
pendingRewards:
# 用于待处理奖励的存储类型。
type: YAML
mysql:
# MySQL 服务器主机。
host: "127.0.0.1"
# MySQL 服务器端口。
port: 3306
# 数据库名称。
database: "playerreport"
# 数据库用户名。
username: "root"
# 数据库密码。
password: ""
# 附加到连接 URL 的可选 JDBC 参数。
params: "useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=UTC"
=========================================================
奖励
举报人的奖励系统
奖励本身在 rewards.yml 中定义
=========================================================
rewards:
启用奖励系统。
enabled: false
如果为 true:
当举报设置为 CLOSED 时,奖励会自动添加到举报人手中。
如果举报被标记为 FALSE,它将被删除以防止发放奖励。
simpleReportHandling: false
=========================================================
Discord Webhook
将举报事件发送到 Discord
=========================================================
discord:
webhook:
# 启用 Discord Webhook 集成。
enabled: false
# Discord Webhook URL。
url: ""
events:
# 当创建新报告时发送 webhook。
onReportCreated: true
# 当报告状态更改时发送 webhook。
onStatusChanged: true
# 当处理人更改时发送 webhook。
onHandlerChanged: true
# Discord 中显示的自定义 webhook 用户名。
username: "PlayerReport"
# webhook 的可选头像 URL。
avatarUrl: ""
# 如果为 true,webhook 消息将以嵌入形式发送。
useEmbeds: true
# 可选的提及文本,例如:
# "@everyone" 或 "<@&roleId>"
mention: ""
=========================================================
报告 GUI
主要管理界面
=========================================================
GUI:
报告 GUI 的标题。
占位符:
%filter%, %sort%, %page%, %pages%
Name: '&cReports &7(%filter% &8|&7 %sort% &8|&7 %page%/%pages%&7)'
报告 GUI 的物品栏大小。
Size: 54
Filter-Item:
# 过滤项在 GUI 中的槽位。
Slot: 49
OPEN:
# 当 OPEN(未关闭)过滤器处于活动/可选状态时显示的材料。
Material: GREEN_TERRACOTTA
# OPEN 过滤器的显示名称。
Name: '&a Open Reports'
# OPEN 过滤器的描述。
Lore:
- '&7Shows open & in-progress reports'
- ''
- '&eClick to switch filter'
CLOSED:
# 当 CLOSED(已关闭)过滤器处于活动/可选状态时显示的材料。
Material: RED_TERRACOTTA
# CLOSED 过滤器的显示名称。
Name: '&c Closed Reports'
# CLOSED 过滤器的描述。
Lore:
- '&7Shows closed reports'
- ''
- '&eClick to switch filter'
DELETED:
# 当 DELETED(已删除)过滤器处于活动/可选状态时显示的材料。
Material: BROWN_TERRACOTTA
# DELETED 过滤器的显示名称。
Name: '&6 Deleted Reports'
# DELETED 过滤器的描述。
Lore:
- '&7Shows deleted reports'
- ''
- '&eClick to switch filter'
Sort-Item:
# 排序项在 GUI 中的槽位。
Slot: 45
# 排序项的材料。
Material: COMPARATOR
# 排序项的显示名称。
Name: '&bSort: &f%sort%'
# 排序项的描述。
Lore:
- '&7Filter: &f%filter%'
- ''
- '&7Modes:'
- '&f- NEWEST / OLDEST'
- '&f- STATUS_OPEN_FIRST / STATUS_IN_PROGRESS_FIRST (only in OPEN tab)'
- ''
- '&eClick to change sorting'
Navigation:
Prev:
# 上一页按钮的槽位。
Slot: 48
# 上一页按钮的材料。
Material: ARROW
# 上一页按钮的显示名称。
Name: '&a← Previous page'
# 上一页按钮的描述。
Lore:
- '&7Click to go back'
Next:
# 下一页按钮的槽位。
Slot: 50
# 下一页按钮的材料。
Material: ARROW
# 下一页按钮的显示名称。
Name: '&aNext page →'
# 下一页按钮的描述。
Lore:
- '&7Click to go forward'
始终显示在最末尾的槽位(右下角)。
切换 GUI 是否仅显示当前查看者作为处理人的报告。
My-Handler-Only:
# 切换项的材料。
Material: NAME_TAG
# 切换项的显示名称。
Name: '&bOnly my handled reports: &f%state%'
# 切换项的描述。
Lore:
- '&7Click to toggle'
- '&7When enabled, you will only'
- '&7see reports where you are'
- '&7the handler.'
Default-Item:
# 用于 GUI 中报告条目的材料。
Material: PAPER
# 报告条目的显示名称。
# 占位符包括与报告相关的值,如 %id%, %reported% 等。
Name: '&a %reported% &7(#%id%)'
# 报告条目的描述。
Lore:
- ''
- ' &eCreated: &7%created%'
- ' &eStatus: &7%status%'
- ' &eHandler: &7%handler%'
- ''
- ' &eReporter: &b%reporter%'
- ' &eReported: &c%reported%'
- ''
- ' &eReason: &b%reason%'
- ''
- '&aLeft-Click &7→ Open report'
- '&eMiddle-Click &7→ Change Status'
- '&cRight-Click &7→ Remove'
Player-Commands:
# 针对不同点击类型触发的命令。
# 留空括号 [] 以禁用。
LEFT: []
MIDDLE: []
RIGHT: []
=========================================================
GUI 默认设置
报告 GUI 的默认过滤和排序方式
=========================================================
gui:
打开报告 GUI 时的默认过滤器。
可用选项:OPEN, CLOSED, DELETED
defaultFilter: OPEN
打开报告 GUI 时的默认排序模式。
可用选项:
- NEWEST
- OLDEST
- STATUS_OPEN_FIRST
- STATUS_IN_PROGRESS_FIRST
defaultSort: NEWEST
</details>
<details>
<summary><strong>lang.yml</strong></summary>
```yaml
prefix: "&8[&bPlayerReport&8]&r "
header: "&8&m------------------------"
footer: "&8&m------------------------"
only-in-game: "{prefix}&cThis command can only be used in-game."
no-permission: "{prefix}&cYou don’t have permission."
usage-report: "{prefix}&7Usage: &f/report <name> <reason>"
missing-reason: "{prefix}&cPlease provide a reason."
player-not-found: "{prefix}&cPlayer not found: &f{target}"
target-must-be-online: "{prefix}&cThis player must be online to be reported: &f{target}"
report-self-not-allowed: "{prefix}&cYou cannot report yourself."
report-target-immune: "{prefix}&cThis player cannot be reported: &f{target}"
report-cooldown: "{prefix}&c请等待 &f{seconds}&c 秒后再提交新的举报。"
target-cooldown: "{prefix}&c该玩家最近已被举报。请在再次举报 &f{target}&c 前等待 &f{seconds}&c 秒。"
report-limit-reached: "{prefix}&c已达到上限。最多允许 &f{limit} &c个活跃举报。"
report-saved: "{prefix}&a举报已保存。"
report-failed: "{prefix}&c无法创建举报。"
report-select-reason: "{prefix}&7请选择举报 &f{target}&7 的原因。"
report-reason-not-allowed: "{prefix}&c自由文本原因已禁用。请选择预设的原因之一。"
report-command-reason-disabled: "{prefix}&c通过命令举报已禁用。请使用 GUI 举报 &f{target}&c。"
admin-notify: "{prefix}&c{reporter} &7举报了 &c{target}&7:&f{reason}"
reports-search-usage: "{prefix}&7用法:&f/reports search user <name>&7 | &f/reports search id <id>&7 | &f/reports search reason <reason>&7 | &f/reports search handler <name>"
reports-notify-on: "{prefix}&a通知已启用。"
reports-notify-off: "{prefix}&c通知已禁用。"
reports-toggle-disabled: "{prefix}&c切换命令在配置中已禁用。"
reports-clear-failed: "{prefix}&c无法清除举报。"
reports-cleared: "{prefix}&a已清除 &f{amount}&a 条举报。"
usage-sethandler: "{prefix}&7用法:&f/reports sethandler <id> <player|none>"
report-not-found: "{prefix}&c未找到举报:&f{id}"
report-not-found-generic: "{prefix}&c未找到举报。"
handler-set: "{prefix}&a举报 &f#{id} &a的处理人已设置为 &f{handler}&a。"
handler-cleared: "{prefix}&e举报 &f#{id} &e的处理人已清除。"
reload-success: "{prefix}&a已重新加载 config.yml 和 lang.yml。"
reload-failed: "{prefix}&c重新加载失败。请检查控制台。"
rewards-disabled: "{prefix}&c奖励功能已禁用。"
rewards-nothing: "{prefix}&7你没有可领取的奖励。"
rewards-claimed: "{prefix}&a已领取 &f{amount}&a 份奖励。"
rewards-claim-in-progress: "{prefix}&e请稍候,你之前的奖励领取仍在处理中。"
rewards-load-failed: "{prefix}&c暂时无法加载你待处理的奖励。"
rewards-claim-partial-restored: "{prefix}&c发放奖励时发生错误。剩余奖励已恢复。"
reward-granted: "{prefix}&a举报者已获得奖励。"
reward-not-granted: "{prefix}&e未存储奖励(已发放或缺少举报者/奖励配置)。"
reward-skipped: "{prefix}&7不会发放任何奖励。"
rewards-available: "{prefix}&a你有 &f{amount}&a 份可用奖励!使用 &f/reports claim&a 来领取它们。"
report-marked-false: "{prefix}&e举报被标记为虚假并删除。"
update-available: "{prefix}&e有更新可用:&f{current} &7-> &a{latest}\n{prefix}&7Spigot:&b{url}"
reports-gui-delete-failed: "{prefix}&c无法删除举报。"
reports-gui-status-update-failed: "{prefix}&c无法更新举报状态。"
location-player-offline: "{prefix}&c位置:N/A(玩家离线)"
location-not-available: "{prefix}&c位置:N/A"
teleported: "{prefix}&a已传送。"
gui:
shared:
filler-name: " "
report-reason:
title: "&c选择举报 &f{target} &c的原因"
reason-item:
name: "&a{reason}"
lore:
- "&7因以下原因举报 &f{target} &7:&b{reason}"
- ""
- "&e点击继续"
report-confirm:
title: "&c是否举报 &f{target} &c,原因:&b{reason}&c?"
yes:
name: "&a是"
no:
name: "&c否"
reward-decision:
title: "&b是否发放奖励? &7(# {id})"
yes: "&a是,发放奖励"
no: "&c否,不发放奖励"
reports:
shared:
back:
name: "&c返回"
state-on: "&a开启"
state-off: "&c关闭"
not-available: "N/A"
location: "&7位置:&f{location}"
filter:
open: "开放"
closed: "已关闭"
deleted: "已删除"
sort:
newest: "最新"
oldest: "最旧"
status-open-first: "优先显示开放状态"
status-in-progress-first: "优先显示进行中状态"
status:
open: "开放"
in-progress: "进行中"
closed: "已关闭"
deleted: "已删除"
list:
title: "&c举报 &7(%filter% &8|&7 %sort% &8|&7 %page%/%pages%&7)"
only-my-handler:
name: "&b仅显示我处理的举报: &f{state}"
lore:
- "&7点击切换"
- "&7启用后,您将仅"
- "&7查看您作为处理人的"
- "&7举报。"
filter:
open:
name: "&a 打开的举报"
lore:
- "&7显示已打开 & 处理中的举报"
- ""
- "&e点击切换筛选条件"
closed:
name: "&c 已关闭的举报"
lore:
- "&7显示已关闭的举报"
- ""
- "&e点击切换筛选条件"
deleted:
name: "&6 已删除的举报"
lore:
- "&7显示已删除的举报"
- ""
- "&e点击切换筛选条件"
sort:
name: "&b排序: &f{sort}"
lore:
- "&7筛选: &f{filter}"
- ""
- "&7模式:"
- "&f- 最新 / 最旧"
- "&f- 状态优先(OPEN在前)/ 状态优先(IN_PROGRESS在前)(仅限 OPEN 标签页)"
- ""
- "&e点击更改排序方式"
navigation:
prev:
name: "&a← 上一页"
lore:
- "&7点击返回"
next:
name: "&a下一页 →"
lore:
- "&7点击前进"
search:
user: "用户: {value}"
id: "ID: {value}"
reason: "原因: {value}"
handler: "处理人: {value}"
entry:
name: "&a %reported% &7(#%id%)"
lore:
- ""
- " &e创建时间: &7%created%"
- " &e状态: &7{status_display}"
- " &e处理人: &7%handler%"
- ""
- " &e举报者: &b%reporter%"
- " &e被举报者: &c%reported%"
- ""
- " &e原因: &b%reason%"
- ""
- "&a左键单击 &7→ 打开举报详情"
- "&e中键单击 &7→ 更改状态"
- "&c右键单击 &7→ 删除"
confirm-delete:
title: "&c删除举报?"
confirm:
name: "&a确认"
cancel:
name: "&c取消"
info:
name: "&7目标: &f{target}"
details:
title: "&c举报 #{id}"
teleport-click: "&7点击传送"
teleport-reporter-current:
name: "&a传送至:举报者(当前位置)"
teleport-reporter-snapshot:
name: "&a传送至:举报者(举报时位置)"
teleport-target-current:
name: "&e传送至:被举报者(当前位置)"
teleport-target-snapshot:
name: "&e传送至:被举报者(举报时位置)"
status:
name: "&b设置状态"
lore-created: "&7创建时间: &f{created}"
lore-current: "&7当前状态: &f{status}"
lore-handler: "&7处理人: &f{handler}"
lore-click: "&7点击选择"
back:
lore: "&7返回 /reports"
status-select:
title: "&b设置状态 #{id}"
open:
name: "&a已打开"
lore-1: "&7将状态设置为 &a已打开"
lore-2: "&7(处理人将被清除)"
in-progress:
name: "&e处理中"
lore-1: "&7将状态设置为 &e处理中"
closed:
name: "&c已关闭"
lore-1: "&7将状态设置为 &c已关闭"
back:
lore: "&7返回详情页"
discord:
report-created:
title: "新举报 #{id}"
description: "**举报者:** {reporter}\n**被举报者:** {target}\n**原因:** {reason}\n**状态:** {status}"
status-changed:
title: "举报 #{id} 状态已更改"
description: "**操作者:** {actor}\n**被举报者:** {target}\n**从:** {old_status}\n**到:** {new_status}\n**处理人:** {handler}"
handler-changed:
title: "举报 #{id} 处理人已更新"
description: "**操作者:** {actor}\n**被举报者:** {target}\n**处理人:** {handler}\n**状态:** {status}"
占位符
| 占位符 |
描述 |
%playerreport_reports_total% |
服务器上存储的举报总数。 |
%playerreport_reports_open% |
当前已打开的举报总数。 |
%playerreport_reports_in_progress% |
当前正在处理的举报总数。 |
%playerreport_reports_closed% |
已关闭的举报总数。 |
%playerreport_reports_deleted% |
已删除的举报总数。 |
%playerreport_reports_created% |
由该玩家创建的举报数量。 |
%playerreport_reports_against% |
针对该玩家的举报数量。 |
%playerreport_reports_handled% |
由该玩家(作为管理员)处理的举报数量。 |
%playerreport_reports_open_for_player% |
由该玩家创建的已打开举报数量。 |
%playerreport_reports_handled_open% |
当前分配给该玩家作为处理人的已打开举报数量。 |
请**不要**因问题留下差评。
如果您遇到问题,请通过私信、讨论区或 Discord 服务器联系我。
谢谢!
A modern in-game player reporting system designed for server moderation teams.
Players can easily report rule violations while moderators receive powerful tools to review, filter and process reports directly in-game using intuitive GUIs.
Version 4.0.0 is a complete rewrite, introducing a modern report workflow, improved moderation tools, database support, Discord integration and much more.
Almost every feature, message and visual can be configured in the config!
- Modern in-game reporting system
- Easy player reporting via
/report
- Optional reason GUI and confirmation system
- Advanced moderation GUI for staff
- Assign moderators as report handlers
- Filter and sort reports directly in-game
- Teleport to reported players or saved locations
- Reward players for valid reports
- Supports online & offline reward claiming
- Discord webhook integration for reports and updates
- PlaceholderAPI support for statistics and integrations
- Storage support for YAML or MySQL
- Search reports by player, ID, reason or handler
- Notification system for staff members
- Automatic cleanup for old reports
- Highly configurable messages, GUIs and behavior
- Lightweight and optimized for performance
- Supports Folia
PlayerReport was built to help staff manage reports quickly and efficiently — directly in game.
Quick, how? → Reports can be reviewed and updated instantly.
Efficiently, how? → Lightweight design with optimized storage.
Effectively, how? → Clear moderation workflow with optional rewards.
Reports are displayed inside a fully configurable GUI.
Staff members can:
- review reports
- change report status
- assign handlers
- teleport to involved players (reporting and reported player)
- remove reports
Filtering and sorting options help moderators handle large amounts of reports efficiently.
Players can optionally receive rewards when their reports are confirmed.
Rewards support:
- command rewards
- item rewards
- offline reward storage
- reward claiming via
/reports claim
Due to the support of command rewards, this feature is compatible with other plugins, such as giving out vote keys as rewards or basically any other command.
This allows servers to encourage players to help maintain a fair environment.
Commands
| Command |
Permission |
Description |
/report <player> <reason> |
playerreport.report |
Create a report for a player. |
/reports |
playerreport.admin |
Open the moderation GUI to view and manage reports. |
/reports help |
playerreport.admin |
Shows all available PlayerReport commands. |
/reports search user <player> |
playerreport.admin |
Search reports created by or against a specific player. |
/reports search id <reportId> |
playerreport.admin |
Find a report by its unique ID. |
/reports search reason <text> |
playerreport.admin |
Search reports containing a specific reason. |
/reports search handler <player> |
playerreport.admin |
Show reports assigned to a specific moderator. |
/reports sethandler <reportId> <player|none> |
playerreport.admin.handler.set |
Assign or remove a moderator as the handler of a report. |
/reports clear |
playerreport.admin.clear |
Clear outdated or deleted reports. |
/reports claim |
playerreport.claim |
Claim rewards for confirmed reports. |
/reports on |
playerreport.admin.notify.toggle |
Enable report notifications. |
/reports off |
playerreport.admin.notify.toggle |
Disable report notifications. |
/reports reload |
playerreport.reload |
Reload the plugin configuration files. |
Permissions
| Permission |
Description |
playerreport.* |
Grants access to all PlayerReport permissions. |
playerreport.report |
Allows players to create reports using /report. |
playerreport.bypass.cooldown |
Bypasses the report cooldown. |
playerreport.immune |
Prevents a player from being reported. |
playerreport.admin |
Allows access to the moderation GUI (/reports). |
playerreport.admin.handler.set |
Allows assigning or removing report handlers. |
playerreport.admin.clear |
Allows clearing outdated reports using /reports clear. |
playerreport.admin.notify.toggle |
Allows toggling report notifications using /reports on/off. |
playerreport.reload |
Allows reloading the plugin configuration with /reports reload. |
playerreport.update.notify |
Receive notifications when a plugin update is available. |
playerreport.claim |
Allows players to claim rewards for successful reports. |
config.yml
# =========================================================
# PlayerReport - config.yml
# Built for Paper 1.21.x (api-version: 1.20)
#
# Color codes:
# Use & for normal Minecraft colors (example: &a, &c, &7)
# HEX colors in lang.yml are supported via &#RRGGBB or #RRGGBB
# =========================================================
# =========================================================
# Reporting
# Settings for creating reports
# =========================================================
reporting:
# If true, the reported player must currently be online
# to be reported.
requireOnlineTarget: false
# Maximum number of open reports a single reporter
# can have at the same time.
maxOpenReportsPerReporter: 5
# Cooldown in seconds between creating reports.
cooldownSeconds: 10
# Defines how report reasons are handled.
# Available modes:
# - FREETEXT = players type any reason
# - PREDEFINED = players must use one of the predefined reasons
# - BOTH = both systems are allowed
reasonMode: FREETEXT
# List of predefined reasons used when PREDEFINED or BOTH is enabled.
predefinedReasons:
- "Cheating"
- "Bug abuse"
- "Harassment"
# GUI for selecting predefined report reasons.
reasonGui:
# Enables the reason selection GUI.
enabled: false
# If true, players may still enter a reason directly by command,
# even when the reason GUI is enabled.
allowCommandReason: true
# Inventory title of the reason selection GUI.
title: "&cSelect a reason for &f%target%"
# Inventory size of the reason selection GUI.
# Should be a valid chest size (9, 18, 27, 36, 45, 54).
size: 27
filler:
# If true, empty GUI slots are filled with the filler item.
enabled: true
# Material used for filler slots.
material: GRAY_STAINED_GLASS_PANE
reasonItem:
# Material used for each selectable reason.
material: PAPER
# Display name of a reason item.
name: "&a%reason%"
# Lore shown on each reason item.
lore:
- "&7Report &f%target% &7for: &b%reason%"
- ""
- "&eClick to continue"
# Confirmation GUI shown before the report is submitted.
confirm:
# Title of the confirmation GUI.
title: "&cReport &f%target% &cfor &b%reason%&c?"
filler:
# Material used for empty slots in the confirmation GUI.
material: GRAY_STAINED_GLASS_PANE
yes:
# Material of the confirmation button.
material: LIME_WOOL
# Display name of the confirmation button.
name: "&aYes"
no:
# Material of the cancel button.
material: RED_WOOL
# Display name of the cancel button.
name: "&cNo"
# =========================================================
# Claims
# Settings for claim / handler behavior
# =========================================================
claims:
# If true, a report will automatically be claimed by the
# moderator when its status changes to IN_PROGRESS.
autoClaimOnInProgress: true
# =========================================================
# Timestamps
# Formatting for displayed date and time values
# =========================================================
timestamps:
# Timezone used for report timestamps.
timezone: "Europe/Berlin"
# Date format pattern.
dateFormat: "dd.MM.yyyy"
# Time format pattern.
timeFormat: "HH:mm:ss"
# Final display format.
# Available placeholders: {date}, {time}
displayFormat: "{date} {time}"
# =========================================================
# Messages
# General message display settings
# =========================================================
messages:
headerFooter:
# Enables optional header/footer formatting in messages.
enabled: false
# =========================================================
# Notifications
# Staff notification settings
# =========================================================
notifications:
# If true, notification toggle states are stored persistently.
persist: true
toggleCommand:
# Enables the /reports on and /reports off commands.
enabled: true
# =========================================================
# Delete / Retention
# Controls how deleted reports are handled
# =========================================================
delete:
# Delete mode:
# - TAG = report is marked as deleted
# - PURGE = report is permanently removed
mode: TAG
# Retention period for deleted reports.
# 0 usually means no retention-based cleanup.
retention: 0
# =========================================================
# Updates
# Update notification settings
# =========================================================
updates:
# If true, players with the proper permission are notified
# on join when an update is available.
notifyOnJoin: true
# =========================================================
# PlaceholderAPI
# Placeholder expansion settings
# =========================================================
placeholderapi:
# Enables PlaceholderAPI support if PlaceholderAPI is installed.
enabled: true
# =========================================================
# Storage
# Storage backend for reports and pending rewards
#
# Supported types:
# - YAML = local file storage
# - MYSQL = MySQL / MariaDB database
# =========================================================
storage:
reports:
# Storage type used for reports.
type: YAML
pendingRewards:
# Storage type used for pending rewards.
type: YAML
mysql:
# MySQL server host.
host: "127.0.0.1"
# MySQL server port.
port: 3306
# Database name.
database: "playerreport"
# Database username.
username: "root"
# Database password.
password: ""
# Optional JDBC parameters appended to the connection URL.
params: "useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=UTC"
# =========================================================
# Rewards
# Reward system for reporters
# Rewards themselves are defined in rewards.yml
# =========================================================
rewards:
# Enables the reward system.
enabled: false
# If true:
# when a report is set to CLOSED, rewards are automatically
# added to the reporter.
#
# If a report is marked as FALSE, it will be deleted
# to prevent rewards.
simpleReportHandling: false
# =========================================================
# Discord Webhook
# Sends report events to Discord
# =========================================================
discord:
webhook:
# Enables Discord webhook integration.
enabled: false
# Discord webhook URL.
url: ""
events:
# Send a webhook when a new report is created.
onReportCreated: true
# Send a webhook when a report status changes.
onStatusChanged: true
# Send a webhook when a handler changes.
onHandlerChanged: true
# Custom webhook username shown in Discord.
username: "PlayerReport"
# Optional avatar URL for the webhook.
avatarUrl: ""
# If true, webhook messages are sent as embeds.
useEmbeds: true
# Optional mention text, for example:
# "@everyone" or "<@&roleId>"
mention: ""
# =========================================================
# Reports GUI
# Main moderation GUI
# =========================================================
GUI:
# Title of the reports GUI.
# Placeholders:
# %filter%, %sort%, %page%, %pages%
Name: '&cReports &7(%filter% &8|&7 %sort% &8|&7 %page%/%pages%&7)'
# Inventory size of the reports GUI.
Size: 54
Filter-Item:
# Slot of the filter item in the GUI.
Slot: 49
OPEN:
# Material shown when the OPEN filter is active/selectable.
Material: GREEN_TERRACOTTA
# Display name of the OPEN filter item.
Name: '&a Open Reports'
# Lore of the OPEN filter item.
Lore:
- '&7Shows open & in-progress reports'
- ''
- '&eClick to switch filter'
CLOSED:
# Material shown when the CLOSED filter is active/selectable.
Material: RED_TERRACOTTA
# Display name of the CLOSED filter item.
Name: '&c Closed Reports'
# Lore of the CLOSED filter item.
Lore:
- '&7Shows closed reports'
- ''
- '&eClick to switch filter'
DELETED:
# Material shown when the DELETED filter is active/selectable.
Material: BROWN_TERRACOTTA
# Display name of the DELETED filter item.
Name: '&6 Deleted Reports'
# Lore of the DELETED filter item.
Lore:
- '&7Shows deleted reports'
- ''
- '&eClick to switch filter'
Sort-Item:
# Slot of the sort item in the GUI.
Slot: 45
# Material of the sort item.
Material: COMPARATOR
# Display name of the sort item.
Name: '&bSort: &f%sort%'
# Lore of the sort item.
Lore:
- '&7Filter: &f%filter%'
- ''
- '&7Modes:'
- '&f- NEWEST / OLDEST'
- '&f- STATUS_OPEN_FIRST / STATUS_IN_PROGRESS_FIRST (only in OPEN tab)'
- ''
- '&eClick to change sorting'
Navigation:
Prev:
# Slot of the previous-page button.
Slot: 48
# Material of the previous-page button.
Material: ARROW
# Display name of the previous-page button.
Name: '&a← Previous page'
# Lore of the previous-page button.
Lore:
- '&7Click to go back'
Next:
# Slot of the next-page button.
Slot: 50
# Material of the next-page button.
Material: ARROW
# Display name of the next-page button.
Name: '&aNext page →'
# Lore of the next-page button.
Lore:
- '&7Click to go forward'
# Always shown in the very last slot (bottom-right).
# Toggles whether the GUI should only show reports
# where the current viewer is the handler.
My-Handler-Only:
# Material of the toggle item.
Material: NAME_TAG
# Display name of the toggle item.
Name: '&bOnly my handled reports: &f%state%'
# Lore of the toggle item.
Lore:
- '&7Click to toggle'
- '&7When enabled, you will only'
- '&7see reports where you are'
- '&7the handler.'
Default-Item:
# Material used for report entries in the GUI.
Material: PAPER
# Display name of a report entry.
# Placeholders include report-related values like %id%, %reported%, etc.
Name: '&a %reported% &7(#%id%)'
# Lore of a report entry.
Lore:
- ''
- ' &eCreated: &7%created%'
- ' &eStatus: &7%status%'
- ' &eHandler: &7%handler%'
- ''
- ' &eReporter: &b%reporter%'
- ' &eReported: &c%reported%'
- ''
- ' &eReason: &b%reason%'
- ''
- '&aLeft-Click &7→ Open report'
- '&eMiddle-Click &7→ Change Status'
- '&cRight-Click &7→ Remove'
Player-Commands:
# Commands triggered for the different click types.
# Leave empty brackets [] to disable.
LEFT: []
MIDDLE: []
RIGHT: []
# =========================================================
# GUI Defaults
# Default filter and sorting for the reports GUI
# =========================================================
gui:
# Default filter when opening the reports GUI.
# Available: OPEN, CLOSED, DELETED
defaultFilter: OPEN
# Default sorting mode when opening the reports GUI.
# Available:
# - NEWEST
# - OLDEST
# - STATUS_OPEN_FIRST
# - STATUS_IN_PROGRESS_FIRST
defaultSort: NEWEST
lang.yml
prefix: "&8[&bPlayerReport&8]&r "
header: "&8&m------------------------"
footer: "&8&m------------------------"
only-in-game: "{prefix}&cThis command can only be used in-game."
no-permission: "{prefix}&cYou don’t have permission."
usage-report: "{prefix}&7Usage: &f/report <name> <reason>"
missing-reason: "{prefix}&cPlease provide a reason."
player-not-found: "{prefix}&cPlayer not found: &f{target}"
target-must-be-online: "{prefix}&cThis player must be online to be reported: &f{target}"
report-self-not-allowed: "{prefix}&cYou cannot report yourself."
report-target-immune: "{prefix}&cThis player cannot be reported: &f{target}"
report-cooldown: "{prefix}&cPlease wait &f{seconds}&c seconds before creating another report."
target-cooldown: "{prefix}&cThis player was reported recently. Please wait &f{seconds}&c seconds before reporting &f{target}&c again."
report-limit-reached: "{prefix}&cYou reached the limit. Max &f{limit} &cactive reports."
report-saved: "{prefix}&aReport saved."
report-failed: "{prefix}&cCould not create report."
report-select-reason: "{prefix}&7Select a reason for reporting &f{target}&7."
report-reason-not-allowed: "{prefix}&cFree-text reasons are disabled. Please pick one of the predefined reasons."
report-command-reason-disabled: "{prefix}&cReporting via command is disabled. Please use the GUI to report &f{target}&c."
admin-notify: "{prefix}&c{reporter} &7reported &c{target}&7: &f{reason}"
reports-search-usage: "{prefix}&7Usage: &f/reports search user <name>&7 | &f/reports search id <id>&7 | &f/reports search reason <reason>&7 | &f/reports search handler <name>"
reports-notify-on: "{prefix}&aNotifications enabled."
reports-notify-off: "{prefix}&cNotifications disabled."
reports-toggle-disabled: "{prefix}&cToggle command disabled in config."
reports-clear-failed: "{prefix}&cCould not clear reports."
reports-cleared: "{prefix}&aCleared &f{amount}&a reports."
usage-sethandler: "{prefix}&7Usage: &f/reports sethandler <id> <player|none>"
report-not-found: "{prefix}&cReport not found: &f{id}"
report-not-found-generic: "{prefix}&cReport not found."
handler-set: "{prefix}&aHandler for report &f#{id} &aset to &f{handler}&a."
handler-cleared: "{prefix}&eHandler for report &f#{id} &ecleared."
reload-success: "{prefix}&aReloaded config.yml and lang.yml."
reload-failed: "{prefix}&cReload failed. Check console."
rewards-disabled: "{prefix}&cRewards are disabled."
rewards-nothing: "{prefix}&7You have no rewards to claim."
rewards-claimed: "{prefix}&aClaimed &f{amount}&a rewards."
rewards-claim-in-progress: "{prefix}&ePlease wait, your previous reward claim is still being processed."
rewards-load-failed: "{prefix}&cCould not load your pending rewards right now."
rewards-claim-partial-restored: "{prefix}&cAn error occurred while giving your rewards. Remaining rewards were restored."
reward-granted: "{prefix}&aReward has been stored for the reporter."
reward-not-granted: "{prefix}&eNo reward stored (already granted or missing reporter/reward config)."
reward-skipped: "{prefix}&7No reward will be given."
rewards-available: "{prefix}&aYou have &f{amount}&a reward(s) available! Use &f/reports claim&a to collect them."
report-marked-false: "{prefix}&eReport marked as false and deleted."
update-available: "{prefix}&eUpdate available: &f{current} &7-> &a{latest}\n{prefix}&7Spigot: &b{url}"
reports-gui-delete-failed: "{prefix}&cReport could not be deleted."
reports-gui-status-update-failed: "{prefix}&cReport status could not be updated."
location-player-offline: "{prefix}&cLocation: N/A (player offline)"
location-not-available: "{prefix}&cLocation: N/A"
teleported: "{prefix}&aTeleported."
gui:
shared:
filler-name: " "
report-reason:
title: "&cSelect a reason for &f{target}"
reason-item:
name: "&a{reason}"
lore:
- "&7Report &f{target} &7for: &b{reason}"
- ""
- "&eClick to continue"
report-confirm:
title: "&cReport &f{target} &cfor &b{reason}&c?"
yes:
name: "&aYes"
no:
name: "&cNo"
reward-decision:
title: "&bGive reward? &7(# {id})"
yes: "&aYes, give reward"
no: "&cNo, don't give reward"
reports:
shared:
back:
name: "&cBack"
state-on: "&aON"
state-off: "&cOFF"
not-available: "N/A"
location: "&7Location: &f{location}"
filter:
open: "OPEN"
closed: "CLOSED"
deleted: "DELETED"
sort:
newest: "NEWEST"
oldest: "OLDEST"
status-open-first: "STATUS_OPEN_FIRST"
status-in-progress-first: "STATUS_IN_PROGRESS_FIRST"
status:
open: "OPEN"
in-progress: "IN_PROGRESS"
closed: "CLOSED"
deleted: "DELETED"
list:
title: "&cReports &7(%filter% &8|&7 %sort% &8|&7 %page%/%pages%&7)"
only-my-handler:
name: "&bOnly my handled reports: &f{state}"
lore:
- "&7Click to toggle"
- "&7When enabled, you will only"
- "&7see reports where you are"
- "&7the handler."
filter:
open:
name: "&a Open Reports"
lore:
- "&7Shows open & in-progress reports"
- ""
- "&eClick to switch filter"
closed:
name: "&c Closed Reports"
lore:
- "&7Shows closed reports"
- ""
- "&eClick to switch filter"
deleted:
name: "&6 Deleted Reports"
lore:
- "&7Shows deleted reports"
- ""
- "&eClick to switch filter"
sort:
name: "&bSort: &f{sort}"
lore:
- "&7Filter: &f{filter}"
- ""
- "&7Modes:"
- "&f- NEWEST / OLDEST"
- "&f- STATUS_OPEN_FIRST / STATUS_IN_PROGRESS_FIRST (only in OPEN tab)"
- ""
- "&eClick to change sorting"
navigation:
prev:
name: "&a← Previous page"
lore:
- "&7Click to go back"
next:
name: "&aNext page →"
lore:
- "&7Click to go forward"
search:
user: "User: {value}"
id: "ID: {value}"
reason: "Reason: {value}"
handler: "Handler: {value}"
entry:
name: "&a %reported% &7(#%id%)"
lore:
- ""
- " &eCreated: &7%created%"
- " &eStatus: &7{status_display}"
- " &eHandler: &7%handler%"
- ""
- " &eReporter: &b%reporter%"
- " &eReported: &c%reported%"
- ""
- " &eReason: &b%reason%"
- ""
- "&aLeft-Click &7→ Open report"
- "&eMiddle-Click &7→ Change Status"
- "&cRight-Click &7→ Remove"
confirm-delete:
title: "&cRemove report?"
confirm:
name: "&aConfirm"
cancel:
name: "&cCancel"
info:
name: "&7Target: &f{target}"
details:
title: "&cReport #{id}"
teleport-click: "&7Click to teleport"
teleport-reporter-current:
name: "&aTeleport: reporter (current)"
teleport-reporter-snapshot:
name: "&aTeleport: reporter (at report)"
teleport-target-current:
name: "&eTeleport: reported (current)"
teleport-target-snapshot:
name: "&eTeleport: reported (at report)"
status:
name: "&bSet status"
lore-created: "&7Created: &f{created}"
lore-current: "&7Current: &f{status}"
lore-handler: "&7Handler: &f{handler}"
lore-click: "&7Click to choose"
back:
lore: "&7Return to /reports"
status-select:
title: "&bSet status #{id}"
open:
name: "&aOPEN"
lore-1: "&7Set status to &aOPEN"
lore-2: "&7(Handler will be cleared)"
in-progress:
name: "&eIN_PROGRESS"
lore-1: "&7Set status to &eIN_PROGRESS"
closed:
name: "&cCLOSED"
lore-1: "&7Set status to &cCLOSED"
back:
lore: "&7Return to details"
discord:
report-created:
title: "New report #{id}"
description: "**Reporter:** {reporter}\n**Reported:** {target}\n**Reason:** {reason}\n**Status:** {status}"
status-changed:
title: "Report #{id} status changed"
description: "**Actor:** {actor}\n**Reported:** {target}\n**From:** {old_status}\n**To:** {new_status}\n**Handler:** {handler}"
handler-changed:
title: "Report #{id} handler updated"
description: "**Actor:** {actor}\n**Reported:** {target}\n**Handler:** {handler}\n**Status:** {status}"
Placeholders
| Placeholder |
Description |
%playerreport_reports_total% |
Total number of reports stored on the server. |
%playerreport_reports_open% |
Total number of currently open reports. |
%playerreport_reports_in_progress% |
Total number of reports currently being handled. |
%playerreport_reports_closed% |
Total number of closed reports. |
%playerreport_reports_deleted% |
Total number of deleted reports. |
%playerreport_reports_created% |
Number of reports created by the player. |
%playerreport_reports_against% |
Number of reports made against the player. |
%playerreport_reports_handled% |
Number of reports handled by the player (as moderator). |
%playerreport_reports_open_for_player% |
Number of open reports created by the player. |
%playerreport_reports_handled_open% |
Number of open reports currently assigned to the player as handler. |
Please DO NOT leave bad reviews for issues.
If you encounter problems, please contact me via PM, the discussion tab or the Discord server.
Thank you!
评论 0
登录后参与评分
还没有评论,来抢沙发吧