home · contact · privacy
Had forgotten to actually add the new library.
[plomrogue] / README
diff --git a/README b/README
index 2793e9820c7968cfe3457e5f7c612d602e302069..da3c097e16b6e86e6a02c3bd934364f7919b29dd 100644 (file)
--- a/README
+++ b/README
@@ -2,16 +2,18 @@ plomrogue
 =========
 
 plomlompom tries to build his own roguelike. Currently, it doesn't do
 =========
 
 plomlompom tries to build his own roguelike. Currently, it doesn't do
-much, apart from managing some example ncurses windows in a bizarre 
-fashion. You can move around a player and meet an enemy, but they don't
-really fight. The map gets generated randomly. There is only one save
-file (named "savefile"), and it gets overwritten each new turn. To start
-over with a new world, delete it.
+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
 -----------
 
 
 Install/run
 -----------
 
-Dependencies: ncurses.
+Dependencies: the ncurses library.
 
 git clone https://github.com/plomlompom/plomrogue
 cd plomrogue
 
 git clone https://github.com/plomlompom/plomrogue
 cd plomrogue
@@ -42,6 +44,7 @@ w       scroll map up
 x       scroll map down
 a       scroll map left
 d       scroll map right
 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
 t       move player up
 b       move player down
 f       move player left
@@ -52,3 +55,12 @@ 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
 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.