All members of structs Win and WinMeta are now officially visible externally, removed...

[plomrogue] / README

diff --git a/README b/README
index a4f20a1ac2ee8c04892edfa55ad58818f0dd5abe..457ed7a6536c119f665af3faff261d5fefef4c90 100644 (file)
--- a/README
+++ b/README
@@ -2,12 +2,25 @@ 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 
+much interesting, apart from managing some ncurses windows in a bizarre

 fashion.
 
 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: the ncurses library.
+

 git clone https://github.com/plomlompom/plomrogue
 cd plomrogue
 make
 git clone https://github.com/plomlompom/plomrogue
 cd plomrogue
 make


@@ -32,17 +45,33 @@ Y       shift window backwards
 _       shrink window horizontally
 +       grow window vertically
 -       shrink window vertically
 _       shrink window horizontally
 +       grow window vertically
 -       shrink window vertically

+r       reload window configuration
+z       toggle window configuration view
+h       toggle whether window height is saved as positive or negative
+n       toggle whether window width is saved as positive or negative
+m       save 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
+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.