OrzMC

插件

· 作者 wangzhizhou

一款基于 Paper 的服务器管理插件,通过 EasyBot 实现多平台机器人控制。

0 本站下载 0 关注 更新于 2 天前

最新 1.0.31-dev.435 · 26.3 · Folia / Paper

一键开服(送7天)

OrzMC

Pull Request Build Check Dependabot Updates Publish

一款 Paper 服务器管理插件,通过 EasyBot 网关统一 QQ、Telegram、Discord、飞书和微信机器人,或通过其内置的直接通道进行连接,并开箱即用地提供双语(英文 / 中文)界面。

🌐 English | 简体中文

本插件专为 PaperMC 服务器构建,同时可在 Folia 上运行(通过 folia-supported: true 声明)。由于 PaperAPI 兼容 BukkitAPI 和 SpigotAPI,它对拥有 Bukkit 和 Spigot 插件开发经验的开发者也非常友好。

它目前在我的 私人服务器 上运行以协助 管理,并已发布在 Hangar 和 Modrinth。

功能特性

功能 描述
权限系统 (等级与审核) 基于 LuckPerms 的 4 级玩家等级链(默认 → 成员 → 建造者 → 管理员,“默认”显示名为 guest/访客),支持自动升级、申请与审核流程(/apply / /review / $v),以及手动升降级($p)。零配置:启动时自动创建轨道和缺失的组;当缺少 LuckPerms 时优雅降级。
白名单管理 控制服务器访问权限。管理员通过机器人命令($a / $r / $w)添加/移除玩家;不活跃玩家会自动清理;被踢出的非白名单玩家会收到友好的提示。
多平台机器人系统 通过 EasyBot 网关统一 QQ、Telegram、Discord、飞书和微信,或直接使用内置通道连接各平台 API(QQ / 飞书 / Telegram / Discord,无需额外进程)—— 通过 im.yml → backend 选择一种方式(通道对比)。提供 11 个用于玩家管理、查询和交互的机器人命令;控制台命令($e)将完整输出返回至群组 —— 包括通过日志窗口捕获的异步插件输出(例如 Essentials/LuckPerms),具有噪音过滤和 30 行截断功能;50+ 可自定义的消息模板将服务器事件推送至匹配的群组或频道。
多语言 (i18n) 内置英文 / 中文消息包覆盖游戏内反馈、机器人回复、事件通知和 /config 面板;游戏内文本跟随每位玩家的客户端区域设置,机器人回复可按平台配置,服务器所有者可以通过 messages_custom_<lang>.yml 覆盖任何消息。
跨服传送门 管理员创建或删除传送门;玩家踏上传送门即可在不同服务器间传输。可选的 LoginSecurity 验证后再进行传输。
TNT 保护 限制 TNT 的放置位置,支持按区域白名单豁免;向群聊发送爆炸通知;控制重生锚爆炸行为。爆发式爆炸聚合为单一警报(×N 附带首个事件坐标),防止发射器/爆炸刷屏导致群聊混乱。
安全控制 按 GeoIP 国家限制加入;IP 黑名单模式(精确 IP / CIDR / 通配符);玩家名称拒绝规则(精确 / 前缀 / 后缀 / 包含 / 通配 / 正则);可选的 LoginSecurity 二次验证。
传送弓 射击箭矢以传送到落点,并自动检测安全着陆;飞行路径上的区块会被强制加载,确保远程射击总能着陆;可配置的实体传送策略(默认受限 —— 仅允许白名单中的被动/中立实体被命令/插件传送;下界传送门穿越始终允许)。
世界维护 一键备份或优化世界,并实时报告进度;服务器列表 MOTD 会在维护期间自动切换。
插件自更新 定期检查 Hangar 上的新版本(发布 / 测试频道),验证 sha256 并自动下载至 plugins/update/ —— 重启服务器即可完成升级。管理员也可以运行 /update check 进行查询,运行 /update now 手动下载。
玩家通知 将加入/退出/踢出详情(世界、坐标、在线人数、权限组)推送至群聊;在线列表显示每位玩家的游戏模式和等级组。
指南书 首次加入的玩家自动接收一本指南书。内容采用极简 YAML 格式(一行 = 一句话,一页 = 一个列表,**粗体** / [文本](网址) 标记);编辑后执行 /orzmc config reload 即可生效(3 分钟指南,中文)。
运行时配置 使用 /config 在游戏内管理 29 个配置选项;更改热重载,无需重启服务器。
OrzMC 菜单 打开游戏内的功能菜单,快速访问所有操作(开发中)。

完整功能列表请参阅 docs/features.md。

安装

下载插件,将其放入 PaperMC(或 Folia)服务器的 plugins/ 目录中,然后启动服务器。插件在首次运行时会在同级目录下创建一个同名的数据目录。运行期间,配置会加载到内存中,并在服务器停止时写回配置文件。

Folia:插件声明了 folia-supported: true,可在 Paper 和 Folia 上使用同一个 JAR 文件运行。CI 中的 folia-smoke 任务会在每个 PR 提交时启动一个真实的 Folia 服务器,以捕获单线程单元测试/集成测试无法发现的区域线程回归问题。

可选依赖:LuckPerms (v5.5+) 启用排名与评价权限系统。若无此插件,本体仍可正常运行,但权限功能将被禁用。当存在 LuckPerms 时,插件会在启动时自动创建 rank 轨道及缺失的组——无需手动配置 LuckPerms。

机器人设置

OrzMC 支持两种可互换的 IM 频道,通过 im.yml 中的全局 backend 选项进行选择:外部 EasyBot 网关(默认)或内置直连频道(QQ / 飞书 / Telegram / Discord,无需额外进程)。差异、权衡及多实例注意事项见:频道对比。

选项 A — EasyBot 网关(默认)

所有 OrzMC 机器人功能均通过外部 EasyBot IM 网关连接。

EasyBot 统一了 QQ / Telegram / Discord / 飞书 / 微信:

  1. 部署 EasyBot 网关服务
  2. 在插件的 easybot.yml 中填写 EasyBot 连接地址
  3. 在 EasyBot 控制台中创建客服 API Key 以获取 api_key
  4. 目标值如 admin_group 并非原生平台 ID —— 请从 EasyBot 控制台的会话管理中获取会话密钥(例如 qq:conv_xxxxxxxx)

详细路由规则:EasyBot 配置指南

选项 B — 内置直连频道

插件直接与平台 API 通信 —— 无网关进程,仅支持文本,凭据在 im.yml 中配置:

  1. 在 im.yml 中设置 backend: builtin 并填写 platforms.<id> 的凭据
  2. 重启服务器,在目标群组/频道发送一条消息,然后使用 /config im bind 绑定发现的会话
  3. 通过 /config im status 和 /config im test 进行验证

逐步指南:内置通用骨架 → QQ / 飞书 / Telegram / Discord。

从旧版设置迁移

旧的 bot.yml 不再加载。升级前,请迁移任何你仍需要的值 —— cmd_prompt_char、discord_server_link、qq_group_id(移至 config.yml → bot: 下)以及 log_throttle_ms(移至 easybot.yml),并在 EasyBot 控制台中完成各平台的会话设置。旧的 NapCatQQ、Discord JDA 和飞书 Webhook 直连参数已不再需要,可以移除。

更新

内置自动更新(推荐)

插件会在启动时以及每隔 update.check_interval_hours(默认 12 小时)检查 Hangar 上的新版本,所有操作均在非服务器线程上执行:

  • update.channel:release(稳定版,默认)或 beta(开发 -dev 构建)。
  • update.auto_download:默认为 false —— 发现新版本时仅打印控制台通知,管理员需运行 /update now 以下载。设置为 true 可自动下载至 plugins/update/(在暂存前会进行 sha256 校验)。
  • 管理员始终可以运行 /update check(查询)和 /update now(下载);下载完成后,重启服务器,Paper 会自动替换新的 JAR 文件。

手动更新仍然有效:将新的插件 JAR 放入 update/ 目录;下次重启时,Paper 会自动将其移动至 plugins/。

配置文件(config.yml / templates.yml / easybot.yml)会在启动时自动迁移:旧文件会保留为 *.bak 格式,缺失的默认键会被合并(现有值绝不会被覆盖),且仅在文档记录的旧默认值未被修改时才会翻转。无需手动删除并重新生成。请勿手动编辑 config-version。完整规则与边界请参阅 配置模式治理。

反馈

如果遇到任何问题,我们非常乐意听取您的意见 —— 请提交一个 issue。

您也可以加入我们的 QQ 频道进行反馈:
OrzMC 反馈群二维码

贡献

  • 贡献指南(开发说明与迭代惯例)—— 日常 PR 应提交至 develop(默认分支);main 为发布线(仅限里程碑与经批准的紧急修复)
  • 文档索引(跨所有文档的读者角色导航)
  • 插件架构
  • 配置模式治理
  • 更新日志

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源