Updated README to reflect recent changes.

[plomrogue] / README

diff --git a/README b/README
index 13d1846d54540617ce3f3e4736c77995da4b849c..da3c097e16b6e86e6a02c3bd934364f7919b29dd 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,66 @@
 plomrogue
 =========
 
-plomlompom tries to build his own RogueLike
\ No newline at end of file
+plomlompom tries to build his own roguelike. Currently, it doesn't do
+much interesting, apart from managing some ncurses windows in a bizarre
+fashion. You can move around a player and meet a number of different
+enemies. They move randomly and will only accidentally hit you. You have
+5 hitpoints to lose before death, and so has each of them. The map gets
+generated randomly, too. There is only one save file (named "savefile"),
+and it gets overwritten each new turn. To start over with a new world,
+delete it.
+
+Install/run
+-----------
+
+Dependencies: the ncurses library.
+
+git clone https://github.com/plomlompom/plomrogue
+cd plomrogue
+make
+./roguelike
+
+Default keybindings
+-------------------
+
+Q       quit
+F1      toggle keybinding editing window
+F2      toggle map window
+F3      toggle info window
+F4      toggle log window
+
+LEFT    scroll windows pad left
+RIGHT   scroll windows pad right
+>       cycle window selection forwards
+<       cycle window selection backwards
+y       shift window forwards
+Y       shift window backwards
+*       grow window horizontally
+_       shrink window horizontally
++       grow window vertically
+-       shrink window vertically
+
+w       scroll map up
+x       scroll map down
+a       scroll map left
+d       scroll map right
+s       center map on player
+t       move player up
+b       move player down
+f       move player left
+h       move player rifght
+.       next turn / wait
+
+S       save current keybindings
+UP      navigate selection upwards in keybinding editing window
+DOWN    navigate selection downwards in keybinding editing window
+RETURN  modify keybinding selected in keybinding editing window
+
+Replay game recording
+---------------------
+
+Run "./roguelike -s" to watch a recording of the current game from the
+beginning. Hit the "next turn / wait" key to increment turns. Keys to
+manage windows, scroll on the map and quit the program are active; keys
+to perform player actions are inactive. Append a number to the -s option
+(like "-s100") to start the recording at the respective turn number.