From 8e470c531bee990f02b051004fc72a34ea942aa9 Mon Sep 17 00:00:00 2001
From: Hipstercat <tasty@hipstercat.fr>
Date: Tue, 12 Feb 2019 17:41:25 +0100
Subject: [PATCH] Added README

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ce32755
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# gckmsd: Giants Citizen Kabuto Master Server
+
+## Installation
+1. Clone repo or download [latest release](https://hipstercat.fr/gogs/hipstercat/gckmsd/releases).
+2. Install Python 3.6 or later.
+3. Run `python masterserver.py`
+
+## How it works
+Listens on 2 ports:
+
+ * UDP 27900: on which dedicated servers register and send keepalive packets containing a lead byte (unknown) and the game port in ASCII. gckmsd checks the game server before adding it to its list of servers.
+ * TCP 28900: on which clients send queries. Replies must follow this format:  
+`{server index on 2 digits}0xac{server ip in ASCII}0xac{server port in ASCII}0x00[next server]`
\ No newline at end of file