cyberarm/i-mic-fps
1
0
Fork 0
mirror of https://github.com/cyberarm/i-mic-fps.git synced 2025-12-15 15:42:35 +00:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Cyberarm
2020-07-21 08:08:17 -05:00
parent 2a36c58abe
commit 87b4b8ef92
1 changed files with 39 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
lib/networking/backend/README.md
View File

@@ -1,3 +1,41 @@
# I-MIC FPS / CyberarmEngine Networking System # I-MIC FPS / CyberarmEngine Networking System
End Goal: Reliable and ordered packets of abitrary size End Goal: Reliable and ordered packets of abitrary size
Current Goal: Unreliable, unordered packets of limited size Current Goal: Unreliable, unordered packets of limited size
## Internal Packet Format
Based on [minetest's network protocol](https://dev.minetest.net/Network_Protocol)
### Base header
All packet headers start with these fields
```
Protocol Version: Unsigned char
Packet Type: Unsigned char
Peer ID: Unsigned char
```
### Basic packet header
No unique header fields
### Control packet header
```
Control Type: Unsigned char
Control Data: Unsigned 16-bit integer
```
Control Types:
* ACK - Acknowledge receipt of reliable packet
* SET_PEER_ID - Set peer id of connected client, client must provide this to continue communicating
* PING - Used to track peer's network latency
* HEARTBEAT - Used as keep alive
* DISCONNECT - Peer is disconnecting
### Split Packet Header
```
Sequence Number: Unsigned 16-bit number
Chunk Count: Unsigned 16-bit number
Chunk Number: Unsigned 16-bit number
```
### Reliable Packet Header
```
Sequence Number: Unsigned 16-bit number
```