Added README

This commit is contained in:
Amazed 2019-02-12 17:41:25 +01:00
parent da10458aa5
commit 8e470c531b
1 changed files with 13 additions and 0 deletions

13
README.md Normal file
View File

@ -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]`