diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 60 insertions, 0 deletions
@@ -12,10 +12,70 @@ 标准预览: https://echo.hydroroll.team/ ,开发预览: https://echo.hydroroll.team/dev/ 。 +Echo 标准包括以下几个方面: + +* 事件定义:事件的唯一标识符、事件的发起者、事件的接收者、事件的附加信息等。 +* API定义:API的唯一地址、API的请求方式、API的请求参数、API的响应结果等。 +* 错误处理:错误的唯一标识符、错误的具体编号、错误的简要描述、错误的详细解释等。 + +示例: + +```json +{ + "event": { + "type": "join", + "source": "user1", + "target": "all", + "data": { + "name": "Alice", + "role": "PC" + } + }, + "api": { + "path": "/event", + "method": "POST", + "parameters": { + "event": { + "type": "object", + "required": true + } + }, + "responses": { + "200": { + "status": "success", + "code": 0, + "message": "OK", + "data": null + }, + "400": { + "status": "error", + "code": 1001, + "message": "Bad Request", + "tip": "请输入正确的事件类型" + } + } + }, + "error": { + "type": "400", + "code": 1001, + "message": "Bad Request", + "tip": "请输入正确的事件类型" + } +} +``` + +### 特性 + +* 简单:Echo标准使用JSON或YAML格式编写,语法简单,结构清晰,易于阅读和编写。 +* 通用:Echo标准可以适用于任何支持HTTP或WebSocket协议的平台,无论是网页、手机、桌面还是其他设备,都可以实现事件的交互和同步。 +* 灵活:Echo标准可以根据不同的平台功能和限制,选择合适的请求和响应方式,也可以根据不同的游戏场景需求和目标,定义和扩展事件的类型和数据。 +* 兼容:Echo标准考虑了多个平台(甚至是 console、shell)间的互通或起码使用不同平台的不同元素实现一个大概的类似效果,因此不需要担心下游规则包或插件对于平台的兼容性问题。 + ### 背景 文字跑团(TRPG)游戏是一种基于文字描述和角色扮演的桌上游戏,通常由一个游戏主持人(KP)和多个玩家(PC)组成,通过网络平台进行交流和互动。不同的平台可能有不同的功能和限制,比如群聊、频道、图片、音频甚至视频等,这些都会影响到游戏的体验和效果。为了让水系的文字跑团游戏能够跨平台运行,ES 规定了游戏的**基本逻辑、数据结构、接口定义、错误处理**等。这样,水系用户的 TRPG 游戏就可以**在不同的平台上实现相同或相似的功能**,同时也可以方便模型或规则包或插件开发者进行扩展和定制。 + ### 贡献 欢迎查看[CONTRIBUTING](https://github.com/HydroRoll-Team/echo/blob/main/CONTRIBUTING.md)。 |
