aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/protocol.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/protocol.txt b/doc/protocol.txt
new file mode 100644
index 000000000..b7b433c9e
--- /dev/null
+++ b/doc/protocol.txt
@@ -0,0 +1,32 @@
+Minetest-c55 protocol (incomplete, early draft):
+Updated 2011-06-18
+
+A custom protocol over UDP.
+
+Initialization:
+- A dummy reliable packet with peer_id=PEER_ID_INEXISTENT=0 is sent to the server:
+ - Actually this can be sent without the reliable packet header, too, i guess,
+ but the sequence number in the header allows the sender to re-send the
+ packet without accidentally getting a double initialization.
+ - Packet content:
+ # Basic header
+ u32 protocol_id = PROTOCOL_ID = 0x4f457403
+ u16 sender_peer_id = PEER_ID_INEXISTENT = 0
+ u8 channel = 0
+ # Reliable packet header
+ u8 type = TYPE_RELIABLE = 3
+ u16 seqnum = SEQNUM_INITIAL = 6550
+ # Original packet header
+ u8 type = TYPE_ORIGINAL = 1
+ # And no actual payload.
+- Server responds with something like this:
+ - Packet content:
+ # Basic header
+ u32 protocol_id = PROTOCOL_ID = 0x4f457403
+ u16 sender_peer_id = PEER_ID_INEXISTENT = 0
+ u8 channel = 0
+ # Control packet header
+ u8 type = TYPE_CONTROL = 0
+ u8 controltype = CONTROLTYPE_SET_PEER_ID = 1
+ u16 peer_id_new = assigned peer id to client (other than 0 or 1)
+