Skip to content

OrzMC/OrzMCPlugin

Repository files navigation

OrzMCPlugin

Pull Request Build Check Publish to Hangar

OrzMC OrzMC OrzMC

OrzMC

私服开服自研插件,用来辅助管理员运维。

本插件针对PaperMC服务器进行开发,由于PaperAPI兼容BukkitAPISpigotAPI, 所以插件开发对有 Bukkit 和 Spigot 插件开发经验的开发者也比较友好。

插件能力

  • 📋服务器开启强制白名单: 未添加到白名单的玩家无法进入服务器
  • 💬社交软件群内管理服务器(命令前缀来自 bot.yml 的 cmd_prompt_char,默认 $
    👨‍💼 管理员命令:
    $a	添加玩家到白名单
    $r	从白名单移除玩家
    $b	地图备份
    $o	地图优化
    👨🏻‍💻 通用命令: 
    $l	查看在线玩家
    $w	查看白名单玩家
    $h	查看帮助信息
    
    • 🐧支持QQ群:需要配合使用QQ机器人服务(NapCatQQ),可实现在QQ群内通过命令添加/移除白名单玩家
    • 🤖Discord频道:配置Discord机器人,可以在Discord文字频道把机器人拉入后管理服务器玩家,命令与QQ机器人一致
    • 🕊️飞书群:飞书群自定义机器人,由于只能通过调用webhook向群里发消息,飞书群只能接收消息,无法发命令到MC服务器,所以目前只能用来同步服务器状态,不能主动管理玩家进出白名单。

    2025年9月5日,NapCatQQ服务的新手用户因未正确使用token鉴权功能,被黑客利用,遭QQ群被官方大规模封号 后续本插件添加了token配置能力,建议配置NapCatQQ服务器的鉴权token

  • 提供玩家指令
    • /tpbow 玩家进入服务器后,可通过此命令随时获取一把传送弓。
    • /guide 玩家首次进入服务器后,会获得一本玩家指南,如果后面丢掉了,可以通过此命令重新获取
    • /bot 查看当前机器人状态,用来随时进行机器人通知服务的状态查询
    • /portal <host> [port] 创建跨服跳转传送门
    • /portal remove|rm <host> [port] 移除跨服跳转传送门(需 OP 或 orzmc.admin)
    • /menu 打开内置菜单(当前为占位界面,点击提示“功能开发中”,后续将逐步增加快捷功能)
  • TNT服务器防护:可通过配置文件设置,开启服务器爆炸监听、报警和防护。支持在不同世界配置TNT可用区域白名单,在设置的白名单区域内,TNT相关功能可正常生效
  • 服务区域限制:为了防止一些国家玩家对服务器的扫描和破坏,可通过配置文件设置服务器允许玩家登录的国家区域

插件使用

首次使用插件:

  1. 下载插件后,放到PaperMC服务端插件目录plugins/下,启动服务端后,插件会创建同名数据目录
  2. 需要在停服后,才能修改插件数据目录下配置文件(本插件在运行期间,配置被加载到内存中,服务端停止时会写回配置文件)

更新插件版本:

  1. PaperMC服务端在插件目录下提供一个名称为update/的目录,把要更新的插件jar文件放到这个目录下面
  2. 下次服务端重启时,插件会被自动移到plugins/目录下面,完成插件升级

问题反馈

  • 如果你在使用过程中发现问题,欢迎给项目提建议:issues
  • 问题反馈可进入QQ频道:
    lark_issue_feedback_group

架构概览

  • 组合根:OrzMC 负责装配依赖与绑定事件/命令
  • 适配层:Events/Commands 只做参数采集与转发
  • 服务层:Features 负责业务编排与规则
  • 核心层:core/ports 与 core/bot 提供端口与消息模型
  • 基础设施:infra 提供配置、通知、Bot、网络等实现

文档索引

About

OrzMC - Paper Server Admin Plugin

Topics

Resources

Stars

Watchers

Forks

Contributors

Languages