From ef5c1768223247d9a852b26ec4028f145fadde16 Mon Sep 17 00:00:00 2001
From: Marcel Hellkamp <marc@gsites.de>
Date: Wed, 21 Mar 2018 12:57:25 +0100
Subject: [PATCH] README.txt -> README.md

---
 README.md  | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.txt | 37 ----------------------------------
 2 files changed, 59 insertions(+), 37 deletions(-)
 create mode 100755 README.md
 delete mode 100644 README.txt

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..88d7018
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+Pixelflut: Multiplayer canvas
+=============================
+
+What happens if you give a bunch of hackers the ability to change pixel colors on a projector screen? See yourself :)
+
+Pixelflut is a very simple (and inefficient) ASCII based network protocol to draw pixels on a screen.
+You can write a basic client in a single line of shell code if you want, but you only get to change a single pixel at a time.
+If you want to get rectangles, lines, text or images on the screen you have to implement that functionality yourself. That is part of the game.
+
+Pixelflut Protocol
+------------------
+
+Pixelflut defines four main commands that are always supported to get you started:
+
+* `HELP`: Returns a short introductional help text.
+* `SIZE`: Returns the size of the canvas in pixel.
+* `PX <x> <y>` Return the current color of a pixel at position (x, y).
+* `PX <x> <y> <rrrggbb(aa)>`: Draw a single pixel at position (x, y) with the specified hex color code.
+  If the color code contains an alpha channel value, it is blended with the current color of the pixel.
+
+You can send multiple commands over the same TCP socket by terminating each command with a single newline character (`\n`).
+
+Example: `echo "PX 23 42 ff8000" | netcat pixelflut.xample.com 1337`
+
+Server Implementations
+----------------------
+
+This repository contains multiple implementations of the pixelflut protocol. Pull requests for additional implementations or improvements are always welcomed.
+
+#### `/pixelflut` (python server)
+
+Server written in Python, based on gevent and pygame. Easy to hack with, but a bit slow.
+
+    sudo apt-get install python-gevent python-pygame python-cairo
+    cd pixelflut
+    mkdir save
+    python pixelflut.py brain.py
+
+#### `/pixelwar` (java server)
+
+Server wirtten in Java8, based on netty and awt. Optimized for speed and large player groups, fast networks or high resolution projectors.
+
+    sudo apt-get install maven openjdk-8-jdk
+    cd pixelwar
+    mvn package
+    java -jar target/pixelwar*-jar-with-dependencies.jar
+
+Links and Videos
+----------------
+
+Pixelflut at EasterHegg 2014 in Stuttgart, Germany
+http://vimeo.com/92827556
+
+Pixelflut Bar (SHA2017)
+https://wiki.sha2017.org/w/Pixelflut_bar
+https://www.youtube.com/watch?v=1Jt-X437MKM
+
+Pixelflut GPN17 Badge
+https://www.youtube.com/watch?v=JGg4zqqumvs
diff --git a/README.txt b/README.txt
deleted file mode 100644
index c26ff35..0000000
--- a/README.txt
+++ /dev/null
@@ -1,37 +0,0 @@
-Pixelflut & Pixelwar: Multiplayer canvas. 
-=========================================
-
-What happens if you give a bunch of hackers the ability to change pixel colors on a beamer screen? See yourself :)
-
-p1xelflut uses a very simple (and inefficient) ASCII based network protocol. You can write a basic client in a single line of shell code if you want, but you only get to change a single pixel at a time. If you want to get rectangles, lines, text or images on the screen you have to implement that functionality yourself. That is part of the game.
-
-
-
-Pixelflut (python)
-------------------
-
-Gevent and pygame based python implementation. easier to hack with, but a bit slow. Not recommended for more than 20 players.
-
-    sudo aptitude install python-gevent python-pygame python-cairo
-    cd pixelflut
-    mkdir save
-    python pixelflut.py brain.py
-
-Pixelwar (java)
----------------
-
-Netty based java7 implementation. Very fast but not scriptable (yet). 
-
-    sudo aptitude install maven2 openjdk-7-jdk
-    cd pixelwar
-    mvn package
-    java -jar target/pixelwar*-jar-with-dependencies.jar
-
-Links
------
-
-Pixelflut at EasterHegg 2014 in Stuttgart, Germany: http://vimeo.com/92827556
-
-
-
-