Skip to content

Doc minor fixes #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 7, 2022
Merged

Doc minor fixes #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6870eef
Fix semantics README.md
DicyRoll Sep 6, 2022
f61f3bd
Fix typos and semantics README.md
DicyRoll Sep 6, 2022
667b9e6
Fix typos README.md
DicyRoll Sep 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@



gogs is an simple, fast and lightweight game server framewrok written in golang. It is designed to be easy to use and easy to extend. It will generate logic code from protobuf files, and you can use it to develop your game server. It is also a good choice for you to learn golang. It support websocket and webrtc datachannel.
gogs is a simple, fast and lightweight game server framework written in golang. It is designed to be easy to use and easy to extend. It will generate logic code from protobuf files, and you can use it to develop your game server. It's also a good starting point for you to learn golang. It supports websocket and webrtc datachannel.

---

Expand Down Expand Up @@ -78,7 +78,7 @@ main.go

## How to encode/decode the message
### Packet Protocol
gogs use 8 bytes as the protocol header
gogs uses 8 bytes as the protocol header

protocol header = flag + version + action index + message data length
```
Expand Down Expand Up @@ -122,7 +122,7 @@ BindUser action index = packetType <<22 | component <<16 | action = 2 << 22 | 1
BindSuccess action index = packetType <<22 | component <<16 | action = 2 << 22 | 1 << 16 | 2 = 0x810002

### Packet encode & decode
gogs have three encode&decode type - ecodeType in protocol header
gogs has three encode&decode types - encodeType in protocol header
- 0 json encode&decode without protocol header
- 1 json encode&decode with protocol header
- 2 protobuf encode&decode with protocol header
Expand All @@ -133,7 +133,7 @@ gogs have three encode&decode type - ecodeType in protocol header

message = **JSON binary data**

`gogs get the action index from message, then get the filed type and decode the message, then call the logic function. the json message without protocol header should add a filed named action, the value is the filed name`
`gogs retrieves the action index from the message, then gets the filed type and decodes the message, finally it calls the logic function. The json message without protocol header should add a filed named action, the value is the filed name`

```json
{
Expand Down