update doc

zhangqijia
1 parent a2f16acb
Showing 4 changed files with 34 additions and 3 deletions Show diff stats
README.md
doc/login.md -> doc/account.md
doc/game.md
game.proto
@@ -3,7 +3,10 @@
 pro2d 服务器客户端共享的protobuffer
  
 ## 文档
-- [登录流程](doc/login.md)
+### 账号服务
+- [登录流程](doc/account.md)
+### 游戏服
+- [业务逻辑](doc/game.md)
  
 ## Usage
 ### golang
@@ -77,4 +77,3 @@ $ curl --request POST &#39;http://192.168.0.206:8080/v1/login&#39; \
  
  
  
-## 游戏服处理业务逻辑
 \ No newline at end of file
@@ -0,0 +1,29 @@
+## 游戏服处理业务逻辑
+游戏服使用tcp长连接，使用16字节包头 + 包体 的二进制协议 。包体使用protobuf
+
+客户端主要关注的是包头里的错误码和返回回来的包体.下面我主要说明请求对应的协议号以及返回回来的错误码说明和包体
+
+### 协议号以及错误码概述
+1. errCode = 0则请求为成功， 其他值则失败。
+
+2. 协议号对应的请求体查看protos/protocode.proto文件
+* 请求是`message HeartReq`, 协议号在protocode.proto文件中是 `HeartReq=1`, 对应的处理逻辑的函数是 `func HeartRpc(msg IMessage)`
+
+详细的请看代码或者客户端与服务器共享的proto协议文件
+
+## 协议号以及返回错误说明
+### 共同的错误码说明
+| errorCode 返回值| 描述  |
+| --- | --- | 
+|0|成功|
+|1| protobuf包体解析错误|
+### 登录 
+| errorCode 返回值| 描述  |
+| --- | --- | 
+|2|角色不存在|
+
+### 创建角色
+| errorCode 返回值| 描述  |
+| --- | --- | 
+|2|角色不存在|
+|3|创建角色失败|
@@ -20,7 +20,7 @@ message LoginReq {
 }
  
 message CreateReq {
-  string uid = 1;
+  string token = 1;
   string device = 2;
 }