Refactored code for loading/saving positions of monsters and items, is a bit more...

[plomrogue] / README

diff --git a/README b/README
index 2793e9820c7968cfe3457e5f7c612d602e302069..34e1c6ac67c3278301d5f11e6e98d7310427e915 100644 (file)
--- a/README
+++ b/README
@@ -2,16 +2,17 @@ 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 three enemies; they will
+occasionally hit you (and each other) on contact, but without
+consequences (no hitpoints implemented yet). 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.

 
 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


@@ -52,3 +53,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.