contrib/tinks: add README.md

Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

diff --git a/contrib/tinks/README.md b/contrib/tinks/README.md
new file mode 100644 (file)
index 0000000..4a26077
--- /dev/null
+++ b/contrib/tinks/README.md
@@ -0,0 +1,47 @@
+Tinks! a multiplayer crossplatform action game with destructible procedurally generated worlds
+
+# Project description
+
+Each player controls a tank, opens fire from the turret and navigates between the terrain features.
+Explosions from turret fire and tank destruction have different forces and destroy the terrain.
+Each tank needs 4 hits to be destroyed.
+Destroyed tanks drop health powerups which can repair other tanks.
+
+The game is optimized for the multiplayer mode but one can play alone to practice.
+Upon launch, a client searches for server by broadcasting a UDP socket.
+A server may respond with its TCP connection port.
+If there is no answer, the client starts its own server which will accept other clients.
+
+The game logic is mostly event based.
+Only the events are passed to the clients at each frame, by serializing them to binary.
+So both the clients and the server keep the game knowledge.
+
+The world is different in each game, it is procedurally generated with an "unlimited" size.
+Each world feature is discovered only as needed by either the server or the clients.
+The server discovers the features affected by possible collisions and by explosions.
+The clients discover the features visible on screen.
+The clients and servers share the seed for the noise generator, so they discover the same features.
+Only the destroyed features and new powerups are passed to the clients by the server as events.
+
+# Modifications
+
+This game was developed quickly while aiming to keep it simple.
+It should be easy to add features as refinements on both the client and the server.
+
+# Usage
+
+Compile with: `make`
+
+Launch with: `bin/tinks`
+
+Compile for Android with: `make bin/tinks.apk`
+
+Launch a server with: `bin/server [server_port]`
+
+Connect to a precise server with: `bin/tinks server_address [server_port]`
+
+# Configuration on desktop
+
+You can configure the client by modifying the file `./config.json` created when you first launch the game.
+The fields `res_x` and `res_y` specify the resolution of the window.
+The field `play_sounds` should be clear enough.