Discord-MC-Chat (DMCC) 重构设计文档

1. 项目概述

Discord-MC-Chat (DMCC) 是一个 Minecraft 模组，旨在为 Discord 和 Minecraft 服务器之间建立一个功能强大、可高度定制的双向通信桥梁。

本次重构的核心目标是实现一个统一的、基于“服务端-客户端 (Server-Client)”的通信架构 。在此架构下，所有运行模式都将复用同一套核心逻辑，以达到最大程度的代码复用、架构一致性和未来的可扩展性。

项目初期将优先实现对 NeoForge 1.21.10 的兼容。但为了未来能够无缝支持 Fabric，整体架构设计严格遵循平台无关原则，所有核心代码中 不得含有任何启动器专属的调用，仅通过 Mixin 进行注入。

2. 核心功能需求

2.1 通信功能

• 双向消息转发: 在 Discord 和 Minecraft 之间实时转发聊天消息。
• 格式兼容: 支持 Markdown、Discord 表情符号、Unicode 表情符号、@ 提及、图片和超链接在两个平台间的自动转换。
• Webhook 支持: 可选通过 Webhook 以玩家头像发送 Minecraft 消息到 Discord。
• 自定义格式: 允许用户高度自定义所有消息的显示格式。

2.2 事件通知

• 玩家事件: 玩家加入/离开服务器、死亡、获得进度/成就。
• 服务器事件: 服务器启动/关闭。
• 性能监控: 当服务器 MSPT (每 tick 毫秒数) 超过阈值时，在 Discord 发出警告。

2.3 管理功能

• 通过 Discord 和游戏内命令查询服务器状态。
• 通过 Discord 执行 Minecraft 控制台命令。
• 通过 Discord 查看和过滤（如玩家 IP 地址）服务器日志。
• 重载 DMCC 配置文件。
• 远程启动/关闭子服务器（仅限多服务器模式）。

2.4 账户链接功能

• 身份绑定: 支持将 Minecraft 玩家账户与 Discord 账户进行关联（一个 Discord 账户可关联多个 Minecraft 账户，但一个 Minecraft 账户只能关联一个 Discord 账户）。
• 角色颜色同步: 游戏内聊天消息显示与玩家 Discord 角色的颜色一致。
• 跨平台提及: 在 Discord 中@用户时，对应的 Minecraft 玩家会收到游戏内提醒。
• 权限同步: 可选基于 Discord 角色自动授予玩家游戏内的 OP 权限。

3. 系统架构

3.1 统一的“服务端-客户端 (Server-Client)”架构

DMCC 所有运行模式都基于一个统一的通信模型，该模型包含两个核心组件：

1. 服务端 (Server): 整个系统的“大脑”。它作为后台服务运行，是唯一负责与 Discord API (通过 JDA) 直接通信的组件。它处理所有核心逻辑，如消息格式化、命令解析和权限验证。此组件在任何情况下都不得包含任何 net.minecraft 的导入（反射除外），以确保其可以在没有 Minecraft 环境（Standalone 模式）的情况下独立运行。
2. 客户端 (Client): 部署在每个 Minecraft 服务器上的“触手”。它作为 Minecraft 模组运行，负责捕获游戏内的所有事件，将其发送给 服务端 (Server)。并执行来自 服务端 (Server) 的指令和本地命令。

两者之间通过基于 Netty 的 TCP 协议进行通信。

3.2 运行模式与部署

1. 单体服务器模式 (single_server): 在后台同时启动一个内部服务端和一个内部客户端。内部客户端自动通过本地回环地址连接到内部服务端。这是为单个 Minecraft 服务器提供的开箱即用的解决方案。
2. 多服务器-客户端模式 (multi_server_client): 只启动一个客户端，此客户端会连接到一个外部独立运行的服务端。用于将多个 Minecraft 服务器连接到一个中央服务端。
3. 独立模式 (standalone): 只启动一个服务端，监听网络端口，等待一个或多个外部客户端连接。作为多服务器架构的中央“大脑”而存在。

3.3 配置文件策略

1. mode.yml: 用户首先在此文件选择一种运行模式。若在非 Minecraft 环境下直接运行 JAR，则自动认定为 standalone 模式。
2. config.yml: DMCC 会根据选择的模式，从内部模板生成一份对应的 config.yml。此配置文件将被严格验证。standalone 模式首次启动时，会自动在 config.yml 中生成一个高强度的 shared_secret，用户需将其手动同步到所有 client 的配置文件中。

4. 网络协议与安全

为保证通信安全，防止共享密钥在传输中被窃取及防止重放攻击，系统采用一次性的哈希质询-响应机制进行认证。

认证流程:

1. 客户端发起连接: Client 连接成功后，发送包，包含其在 config.yml 中配置的 serverName 和自身的 DMCC 版本号。
2. 服务端验证与质询: Server 收到包后： a. 白名单检查: Server 检查 serverName 是否在 config.yml 的 multi_server.servers 列表中。如果不在，返回错误及原因，并断开连接。 b. 版本检查: 对比 Client 版本和自身版本。如果不兼容，返回错误及原因，并断开连接。 c. 生成质询: 如果通过，Server 生成一个唯一的、一次性的随机字符串作为 challenge，并暂存于内存中。 d. 发送质询: Server 向 Client 发送包，包含该随机字符串。
3. 客户端计算响应: Client 收到包后： a. 从 config.yml 读取 shared_secret。 b. 使用某合适的单向算法计算哈希值。 c. 向 Server 发送包，包含该哈希值。
4. 服务端验证响应: Server 收到包后： a. 取出内存中为该 Client 暂存的 challenge。 b. 以同一个单向算法计算出哈希值。 c. 比对哈希: 如果不一致，返回错误及原因，并断开连接。
5. 握手成功: 如果哈希一致，认证通过。Server 发送包，其中包含服务端所配置的 language，作为全局同步的语言，客户端收到后会重载语言。

5. 命令系统设计

命令	权限 (默认)	模组运行 multi_server_client	模组运行 single_server	独立运行 standalone	说明与行为差异
help	everyone	✅	✅	✅	动态显示当前环境可用且有权执行的命令。
info	everyone	✅	✅	✅	在 client 执行只显示自身状态。在 server 端执行则显示全局信息。
update	everyone	✅	✅	✅	在本地执行，检查自身 DMCC 实例的更新。每个实例独立检查自身版本。只是检查更新，不是自动更新。
stats <type> <name>	everyone	✅	✅	✅	在 client 执行只统计自身 MC 服务器。在 server 端执行则统计全部 MC 服务器。获取的是 /world/stats/ 文件夹中的数据。
console <mc_command>	admin	✅	✅	❌	在所在的 MC 服务器中执行 MC 命令。
execute <at/all> <dmcc_command>	admin	✅	❌	✅	client 端执行时会将请求转发给 server，由 server 进行转发。
link <add/remove> <mc_user>	everyone	❌	✅	✅	管理该 Discord 账户的账户链接（仅 add 需要验证），只能在 server 执行。
link confirm	everyone	✅	✅	❌	验证先前提交的账户链接请求，只能在游戏内 client 执行，然后通知 server。
link list <discord_user/all>	admin	❌	✅	✅	列出某 Discord 账户的账户链接，只能在 server 执行。single_server 环境时可在游戏内执行。all 仅供管理员使用。
log <file>	admin	✅ (MC log)	✅ (MC log)	✅ (DMCC log)	获取自身实例的日志文件。可通过 execute 命令获得 client 的日志。
reload	admin	✅	✅	✅	通过 shutdown() + init() 实现。
start <server>	admin	❌	❌	✅	启动 config.yml 中定义的子 MC 服务器。
stop <server>	admin	❌	❌	✅	停止 config.yml 中定义的子 MC 服务器。
shutdown	admin	❌	❌	✅	关闭 standalone 应用程序。

execute <at> <dmcc_command> 命令设计有 all 的选项，但是需要处理重名的问题，以及 server_name 的要求，例如不可以设为 all 和 standalone。

log <file> 命令和 link <add/remove> <mc_user> 命令为 Discord 独占的命令。前者的结果为文件附件，后者需要验证 Discord 账户身份。

6. 权限管理模型 (双轨制)

1. 原生继承模型 (Minecraft -> DMCC): 游戏内 OP 等级高于 minecraft_op_level_requirement 的玩家，自动成为“DMCC 管理员”。这是权限的基础来源。
2. 角色同步模型 (Discord -> Minecraft -> DMCC): 可选功能。可配置 Discord 角色到游戏内 OP 等级的映射。Server 组件会周期性检查并 通过向 Client 发送指令来自动授予/撤销玩家的游戏内 OP 权限。一旦玩家因此获得足够 OP 等级，也将通过路径一成为“DMCC 管理员”。