为 MCDReforged (MCDR) 开发的现代化、功能丰富的 Web 管理界面插件。
Tip
文档中心: 点击访问
- 本地管理: 实时列出插件状态，支持启动、停止、重载及一键更新。
- 在线仓库: 集成插件安装管理器 (PIM)，支持多仓库搜索、安装、卸载及版本切换。
- 环境维护: 自 v1.4.0 起自动处理 Python 依赖 (pip)。
- 动态表单: 自动将
json、yaml配置文件解析为直观的可视化表单。 - 在线编辑器: 内置 Web 代码编辑器，支持直接修改原始配置文件。
- 实时终端: 提供支持 RCON 反馈和历史记录的服务器控制台。
- AI 辅助分析: 集成 AI 接口，支持自动化日志分析与故障排查。
- 兼容性增强: 联动
player_ip_logger显示详细在线玩家状态与验证信息。
- 公开聊天页: 游戏消息实时同步，支持玩家通过验证后在 Web 端交互。
- 个性化体验: 支持浅色与深色主题无缝切换。
- 从 Releases 下载最新的
.mcdr文件。 - 放入 MCDR 的
plugins文件夹。 - 重启 MCDR 或在控制台执行
!!MCDR admin reload all。
Important
升级提示 (v1.3.0+和v1.7.0+): 如果从旧版本升级，请删除 guguwebui_static 文件夹内文件和文件夹，仅保留 db.json。
数据说明: 重载本插件会同步更新静态资源。若手动修改过插件目录内的文件，请注意备份。
在游戏内使用以下指令管理 WebUI 访问权限：
- 创建管理员:
!!webui create <用户名> <密码> - 修改密码:
!!webui change <用户名> <旧密码> <新密码> - 临时登录:
!!webui temp(生成一次性授权链接)
- 访问
/chat路径。 - 点击生成验证码，并在游戏内发送
!!webui verify <验证码>。 - 回到页面设置独立密码并登录。
WebUI 提供事件分发机制，允许其他插件监听或向 WebUI 发送消息：
- 核心事件:
webui.chat_message_sent - 详细参考: WebUI 事件系统文档
- 示例代码: examples/
- fastapi_mcdr: 检测到该插件时，WebUI 将自动挂载为其子应用。
- PIM (内置): 已集成插件安装管理功能，亦可根据需要安装到外部。
Q: 为什么要开发这个插件？
A: 因为我乐意。
Q: 会支持MC服务器管理的功能吗？如模组管理、玩家管理、白名单等等……
A: 并不会深入涉及管理MC服务器，如有这方面的需求请查询MC服务器面板，仅可能会支持很小一部分，例如终端、重启服务器，更多的不在我们的范畴中。
Q: 可以加入开发吗？
A: 当然可以，您可以提交 pr 或者参与交流来参与开发。
Q: 会支持我的语言吗？
A: 我只会中文，你要是愿意可以参与，目前已有中文（zh-CN）和英文（en-US），在 i18n/locales 文件夹。
Q: 如何获取正在测试的开发版？
A: 前往 Releases页面 下载最新的预发布版本（Pre-release），这些版本会在每次代码更新后自动生成。或者你也可以自己打包src中的文件到zip，修改后缀为.mcdr。
Q: 我有个插件，我觉得很适合WebUI，可以作为WebUI的前置吗？
A: WebUI不打算使用任何插件前置，如果有好的方案我们会考虑直接加入WebUI并在关于页感谢贡献。
Q: WebUI中提到的PIM插件 是什么？
A: PIM插件 是WebUI的插件安装管理器，它可以帮助您安装、卸载、更新插件，并且可以查看插件信息。请注意，这并非MCDR内置的PIM，这是两个不同的东西。
Q: 对于开发者如何提供配置文件以支持多语言（中文、英文等）描述？
A: 查看 插件兼容 文档。
| 贡献人 | 说明 |
|---|---|
| 树梢 (LoosePrince) | 功能设计、文档编写、Web设计、前端编写 |
| 雪开 (XueK66) | 代码开发、维护、功能设计 |
| 见 贡献者 | 贡献者 |
| 贡献项目 | 功能 | 备注 |
|---|---|---|
| MCDR 插件仓库 | 插件生态 | 提供了丰富的 MCDR 插件生态，是本项目功能的基础 |
| MC-Server-Info | Minecraft 服务器信息查询 [v1.6.8及以下] | 用于获取服务器状态与玩家信息的基础实现（仓库被作者删除） |
| MCDReforged | MCDR 本体 | 本插件所依赖的运行平台 |
| WolfgangFahl | uvicorn 线程化 | 参考了其在 uvicorn 线程化运行方面的实现思路 |
| Minecraft Wiki（文本组件） | 文本组件格式规范 | RText 解析器所依据的格式规范 |
| mcstatus | Minecraft 服务器状态查询 | 用于查询 Minecraft Java 版服务器状态的 Python 库 |
| 特别鸣谢 | 说明 |
|---|---|
| 反馈者 | 感谢你们的反馈 |
如果需要更多联动或提交想法和问题请提交 issues 或 QQ 树梢 (1377820366) 提交！
如需要帮助或者交流请通过 QQ群 726741344 进行询问或者交流
视情况添加，请勿联系他人。