ZMusic 跨仓库规范与协议文档

简体中文 | English | 日本語

简介

ZMusic Specs 用于维护 ZMusic 项目之间共享的规范。

这个仓库是服务端插件、客户端 Mod 以及未来相关实现之间的协议事实源。所有会影响多个仓库的约定，都应优先在这里沉淀，而不是散落在单个实现仓库中。

维护内容

本仓库适合维护：

• 通信包协议
• 跨仓库 API 契约
• 兼容性策略
• JSON Schema 和协议测试样例
• 影响多个仓库的架构决策

本仓库不维护：

• 单个实现仓库的 TODO
• 只影响某个仓库的重构说明
• 面向用户的使用文档
• 单个仓库的发布检查清单

当前状态

当前维护两条相互衔接的实时通信协议：

• ZMusic 通信包协议：服务端 Plugin 与客户端 Mod 之间的 Minecraft 自定义负载协议。
• ZMusic Plugin WebSocket 协议：服务端 Plugin 与 ZMusic API 之间的状态同步和控制协议。

相关仓库

• ZMusic Plugin - 服务端插件

开源协议

本仓库中的规范和文档使用 CC BY 4.0 协议发布。