跳到主要内容

来源与版本策略

当前版本

项目
公开契约v0.1
服务器仓库arena-hero/arena-hero
已审查服务器提交d66476a26f4713c5fe91cd40ae8a21098a576638
Python SDKarena-hero/arena-hero-python,v0.1.0
已审查 SDK 提交b784c8122f8cfc2435fc58a28ddc40a7db615970
服务端审查日期2026 年 7 月 27 日
SDK 审查日期2026 年 7 月 28 日
文档仓库arena-hero/arena-hero-doc
语言英文、简体中文

文档和服务端不一致时

这些页面描述的是公开的游戏规则和 API,但运行时到底怎么表现,由服务端代码、数据库 约束和测试说了算。

所以当已发布的文字和已发布的实现对不上时:

  1. 别把这个差异当成隐含规则去利用;
  2. 记下确切的服务端版本,以及你实际观察到的行为;
  3. 到文档仓库或服务端仓库提一个 Issue;
  4. 等预期行为定下来之后,两个仓库一起更新。

哪些修改会影响兼容性

下面这些只要一动,就可能弄坏现有客户端,因此每一条都需要明确的协议版本决定:

  • 15 秒全局命令窗口,以及以 state 作为动作触发器;
  • 确定性结算阶段和原子提交;
  • 完整来源计划替换,以及 Manual 的优先级;
  • 动作字段规则与幂等;
  • WebSocket 消息类型和重连快照;
  • 战争迷雾的隐私边界;
  • 地图生成器契约;
  • 决定重放结果的核心平衡规则。

其余的东西——文字、排版、图表、示例、讲解顺序——可以随意改进,因为它们都不改变游戏 契约。

为什么现在还没有版本选择器

公开 API 还停在 v0.1,所以站点只发布一个当前版本,提供英文和简体中文两种语言。等有了 第一个稳定的兼容版本,旧协议就可以作为 Docusaurus 版本保留下来。

修改协议时要更新什么

任何玩法或游戏 API 的改动,都得把下面这些一并带上:

  • 服务端仓库里的实现和测试;
  • 官方 Python SDK 中对应的模型、行为和测试;
  • 本仓库里同步更新的英文和简体中文页面;
  • 涉及到的话,更新 OpenAPI 或 AsyncAPI Schema;
  • 通过验证的双语生产构建;
  • 只要现有客户端可能被弄坏,就给出明确的兼容性说明。