Fixed off-by-one error encountered while changing default key for 'reload_wins' command.

[plomrogue] / README

diff --git a/README b/README
index 788089759ca199ca1461441dab62a35ff62aaed4..f21799ce785acad3d96c91679a7de3bd5014ef36 100644 (file)
--- a/README
+++ b/README
@@ -2,23 +2,30 @@ 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. A map gets generated randomly; it's seed can be saved and
-later reloaded.
+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; they have either 1, 3 or 9. Your score
+grows by killing enemies, to the amount of hitpoints each killed enemy
+started with.
+
+The map get 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
 make
 ./roguelike
 
 
 git clone https://github.com/plomlompom/plomrogue
 cd plomrogue
 make
 ./roguelike
 

-Use option -l to load an existing map seed.
-

 Default keybindings
 -------------------
 
 Default keybindings
 -------------------
 


@@ -38,20 +45,29 @@ Y       shift window backwards
 _       shrink window horizontally
 +       grow window vertically
 -       shrink window vertically
 _       shrink window horizontally
 +       grow window vertically
 -       shrink window vertically

-
-s       save seed of map
+r       reload window configuration

 
 w       scroll map up
 x       scroll map down
 a       scroll map left
 d       scroll map right
 
 w       scroll map up
 x       scroll map down
 a       scroll map left
 d       scroll map right

-t       move player up
-b       move player down
-f       move player left
-h       move player rifght
-.       wait one turn
+s       center map on player
+W       move player up
+X       move player down
+A       move player left
+D       move player right
+S       next turn / wait

 
 

-S       save current keybindings
+K       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.