home · contact · privacy
Add to TODO.
[plomrogue] / README
diff --git a/README b/README
index 8b79cf28fda8dcc6fd898fb7894e46b9751dd550..110146d50d3fca1d244f769093888a23f60db7db 100644 (file)
--- a/README
+++ b/README
@@ -15,25 +15,28 @@ Enemies' AI is very dumb so far: Each turn, they try to move towards their
 shortest-path-wise nearest enemy visible to them. If they see no enemy, they
 just wait.
 
-Once you start a new world, every move of yours is recorded in a file called
-"record". Once you re-start the game, all of your previous moves are replayed
-automatically up to the point wherere you left the game. To start over in a new
-world, simply delete this file.
+Every move of yours re-writes a file "savefile" that describes the new state of
+the world. Once you re-start the game, the game state is recreated from the
+"savefile" file. To start over in a new world, simply delete this file.
 
 System requirements / installation / running the game
 -----------------------------------------------------
 
 The game is expected to run on Linux systems that contain the ncurses library.
-Do the following steps:
+(It may also work on other Unix-like systems with ncurses, who knows.) Do the
+following steps:
 
 $ git clone https://github.com/plomlompom/plomrogue
 $ cd plomrogue
-$ make
+$ ./redo
 $ ./roguelike
 
-(It may also work on other Unix-like systems with ncurses, who knows.)
+(If you got a redo build system installed and in your $PATH, you could also do a
+simple "redo" instead of "./redo". The ./redo script calls a simple partial
+shell script implementation of redo stored below build/redo_scripts/, written by
+Nils Dagsson Moskopp a.k.a. erlehmann.)
 
-Make generates two executables ./roguelike-server and ./roguelike-client.
+./redo generates two executables ./roguelike-server and ./roguelike-client.
 ./roguelike is a pre-existing shell script that merely executes both of them,
 with the server as a background job. You can also ignore the script and start
 the two by hand.
@@ -67,16 +70,21 @@ in-client window management.
 Replay game recording
 ---------------------
 
-Run "./roguelike -s" to watch a recording of the current game from the
-beginning. Hit any player action key to increment turns (they will not trigger
-the actions usually mapped to them, only repeat the actions done at that point
-in the game as defined in the "record" file). Keys to manage windows, scroll on
-the map and quit the program do their usual thing. Append a number to the -s
-option (like "-s100") to start the recording at the respective turn number.
+Once you start a new world, every move of yours is recorded in a file called
+"record". It gets overwritten when a new game world is started after deletion
+of the "savefile" file. Run "./roguelike -s" to watch the current game's
+recording from the beginning. Hit any player action key to increment turns (they
+will not trigger the actions usually mapped to them, only repeat the actions
+done at that point in the game as defined in the "record" file). Keys to manage
+windows, scroll on the map and quit the program do their usual thing. Append a
+number to the -s option (like "-s100") to start the recording at the respective
+turn number.
 
 Hacking / server internals and configuration
 --------------------------------------------
 
+[THIS SECTION IS OUT OF DATE (but kept as long as there's nothing better yet)]
+
 The ./confserver/world file defines the thing types, actions available to them,
 the map geometry and the thing type (species) of the player. Each definition
 consists of a single- or multi-line block wherein each line sets one attribute.