Skip to content

Commit 6afc03b

Browse files
committed
docs(readme): 添加 TestProtos 示例文件索引
1 parent da74243 commit 6afc03b

5 files changed

Lines changed: 60 additions & 0 deletions

File tree

README.ja.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,18 @@ message PlayerInfo
122122

123123
完全なプロトコル仕様については [通信プロトコル仕様](https://gameframex.doc.alianblank.com/zh-CN/protobuf/require.html)[注意事項](https://gameframex.doc.alianblank.com/zh-CN/protobuf/note.html) のドキュメントを参照してください。
124124

125+
## サンプル Proto ファイル
126+
127+
[TestProtos/](TestProtos/) ディレクトリには、主要なパターンを網羅したサンプル proto ファイルが含まれています:
128+
129+
| ファイル | パターン | モジュール ID |
130+
|----------|----------|--------------|
131+
| `heartbeat.proto` | 基本的な Req/Resp | `1`(クライアント-サーバー) |
132+
| `player.proto` | Req/Resp/Notify + enum + map | `2`(クライアント-サーバー) |
133+
| `bag.proto` | enum + repeated + map + Notify | `3`(クライアント-サーバー) |
134+
| `admin-s.proto` | サーバー専用プロトコル(`-s` 接尾辞) | `99`(クライアント-サーバー) |
135+
| `server-internal-s.proto` | サーバー間通信(負のモジュール ID) | `-1`(サーバー-サーバー) |
136+
125137
---
126138

127139
# パラメータ解説

README.ko.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,18 @@ message PlayerInfo
122122

123123
전체 프로토콜 사양은 [통신 프로토콜 사양](https://gameframex.doc.alianblank.com/zh-CN/protobuf/require.html)[주의사항](https://gameframex.doc.alianblank.com/zh-CN/protobuf/note.html) 문서를 참조하세요.
124124

125+
## 샘플 Proto 파일
126+
127+
[TestProtos/](TestProtos/) 디렉토리에는 주요 패턴을 포괄하는 샘플 proto 파일이 있습니다:
128+
129+
| 파일 | 패턴 | 모듈 ID |
130+
|------|------|---------|
131+
| `heartbeat.proto` | 기본 Req/Resp | `1` (클라이언트-서버) |
132+
| `player.proto` | Req/Resp/Notify + enum + map | `2` (클라이언트-서버) |
133+
| `bag.proto` | enum + repeated + map + Notify | `3` (클라이언트-서버) |
134+
| `admin-s.proto` | 서버 전용 프로토콜 (`-s` 접미사) | `99` (클라이언트-서버) |
135+
| `server-internal-s.proto` | 서버 간 통신 (음수 모듈 ID) | `-1` (서버-서버) |
136+
125137
---
126138

127139
# 매개변수 설명

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,18 @@ message PlayerInfo
122122

123123
For the complete protocol specification, see the [Protocol Requirements](https://gameframex.doc.alianblank.com/en-US/protobuf/require.html) and [Notes](https://gameframex.doc.alianblank.com/en-US/protobuf/note.html) documentation.
124124

125+
## Example Proto Files
126+
127+
The [TestProtos/](TestProtos/) directory contains example proto files covering all major patterns:
128+
129+
| File | Pattern | Module ID |
130+
|------|---------|-----------|
131+
| `heartbeat.proto` | Basic Req/Resp | `1` (client-server) |
132+
| `player.proto` | Req/Resp/Notify + enum + map | `2` (client-server) |
133+
| `bag.proto` | enum + repeated + map + Notify | `3` (client-server) |
134+
| `admin-s.proto` | Server-only proto (`-s` suffix) | `99` (client-server) |
135+
| `server-internal-s.proto` | Server-server communication (negative module ID) | `-1` (server-server) |
136+
125137
---
126138

127139
# Parameter Reference

README.zh-CN.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,18 @@ message PlayerInfo
122122

123123
完整的协议规范请参考 [通讯协议规范](https://gameframex.doc.alianblank.com/zh-CN/protobuf/require.html)[注意事项](https://gameframex.doc.alianblank.com/zh-CN/protobuf/note.html) 文档。
124124

125+
## 示例 Proto 文件
126+
127+
[TestProtos/](TestProtos/) 目录下提供了覆盖所有主要模式的示例 proto 文件:
128+
129+
| 文件 | 模式 | 模块 ID |
130+
|------|------|---------|
131+
| `heartbeat.proto` | 基础 Req/Resp | `1`(客户端-服务端) |
132+
| `player.proto` | Req/Resp/Notify + enum + map | `2`(客户端-服务端) |
133+
| `bag.proto` | enum + repeated + map + Notify | `3`(客户端-服务端) |
134+
| `admin-s.proto` | 服务端专属协议(`-s` 后缀) | `99`(客户端-服务端) |
135+
| `server-internal-s.proto` | 服务端间通讯(负值模块 ID) | `-1`(服务端-服务端) |
136+
125137
---
126138

127139
# 参数解析

README.zh-TW.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,18 @@ message PlayerInfo
122122

123123
完整的協議規範請參考 [通訊協議規範](https://gameframex.doc.alianblank.com/zh-CN/protobuf/require.html)[注意事項](https://gameframex.doc.alianblank.com/zh-CN/protobuf/note.html) 文件。
124124

125+
## 範例 Proto 檔案
126+
127+
[TestProtos/](TestProtos/) 目錄下提供了覆蓋所有主要模式的範例 proto 檔案:
128+
129+
| 檔案 | 模式 | 模組 ID |
130+
|------|------|---------|
131+
| `heartbeat.proto` | 基礎 Req/Resp | `1`(用戶端-伺服器端) |
132+
| `player.proto` | Req/Resp/Notify + enum + map | `2`(用戶端-伺服器端) |
133+
| `bag.proto` | enum + repeated + map + Notify | `3`(用戶端-伺服器端) |
134+
| `admin-s.proto` | 伺服器端專屬協議(`-s` 後綴) | `99`(用戶端-伺服器端) |
135+
| `server-internal-s.proto` | 伺服器端間通訊(負值模組 ID) | `-1`(伺服器端-伺服器端) |
136+
125137
---
126138

127139
# 參數解析

0 commit comments

Comments
 (0)