home · contact · privacy
Remove debugging code.
[plomrogue] / README
diff --git a/README b/README
index d9b678989bf164e12684aa03574e76464c4d96a3..5a11cc1c68b3368c9520acfc909e3b1cf4d1c037 100644 (file)
--- a/README
+++ b/README
@@ -1,76 +1,61 @@
-plomrogue
-=========
+7DRL 2015 project: Please the Island God
+========================================
 
-plomlompom tries to build his own roguelike. It doesn't do much yet (although
-plomlompom has insanely ambitious long-term plans).
+Description
+-----------
 
-You can move around a player on an island and meet different enemies. You have 5
-hitpoints to lose before death. Enemies start with different amounts of
-hitpoints, depending on their species. Dead enemies become dirt, skeletons or
-"magic meat" -- such objects can be collected, and "magic meat" can be consumed
-to gain hitpoints (if allowed to lie on the ground for a while it may even
-multiply ...). Note that different kinds of movements/actions take different
-numbers of turns to finish.
-
-Enemies' AI is very dumb so far: Each turn, they try to move towards their
-shortest-path-wise nearest enemy (any animate being of a different species)
-visible to them. If they see no enemy, they search for and consume "magic meat".
-
-Every move of yours re-writes a file "savefile" that describes the new state of
-dthe world, if more than 15 seconds have passed since its last writing. 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.
+See <http://www.plomlompom.de/PlomRogue/plomwiki.php?title=7DRL2015Day2>
+and <http://www.plomlompom.de/PlomRogue/plomwiki.php?title=7DRL2015Day3>.
 
 System requirements / installation / running the game
 -----------------------------------------------------
 
-The game is expected to run on Linux systems that contain the ncurses library.
-(It may also work on other Unix-like systems with ncurses, who knows. See
-<https://github.com/plomlompom/plomrogue/issues/2#issuecomment-50972436> for OS
-X compatibility.) Do the following steps:
+The game is expected to run:
+- on Unix systems with a vt100-like terminal environment (xterm will do)
+- that contain the ncurses library
+- and Python3 (version >= 3.2.3).
+
+To build it, this is furthermore necessary:
+- gcc (version >= 4.7.2); some llvm masked as gcc was tested successfully on OSX
+- libc library headers (libc6-dev?)
+- ncurses library headers (libncurses5-dev?)
+
+To build and start, do the following steps:
 
-$ git clone https://github.com/plomlompom/plomrogue
-$ cd plomrogue
 $ ./redo
 $ ./roguelike
 
-(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.)
+(If you got a version of djb's 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.)
 
-./redo generates two executables ./roguelike-server and ./roguelike-client.
+There are 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.
-
-Client's keybindings and window management
-------------------------------------------
-
-Multiple windows may fill the screen. One of these will be selected as "active"
-– identified by dollar signs enclosing its title. Active windows may come with
-window-specific keybindings. Furthermore, global keybindings are available no
-matter what window is selected.
-
-Hit "W" (per default global keybindings) to switch the active window to a view
-that allows changing its geometry. One more hit on "W" switches the window to a
-view that sports (and allows changing its) window-specific keybindings. (One
-further "W" will return the window to its default, "normal" view.) The global
-keybindings are visible (and can be changed) in the "Set global keys" window,
-those of the window geometry configuration in the "Set window geometry keys"
-window, and those of the window-specific keybindings configuration in the "Set
-window keybinding keys" window; by default, the latter two are not visible, but
-may be turned on by (per default keybindings) hitting the keys "F6" and "F7".
-
-Keybindings and default window selection / visibilities / geometries are read
-from the textfile ./confclient/interface_conf by default, or by another one
-named by the -i command line option of the client. Some other default window
-configurations are stored below ./confclient/single_windows/: "map", "info",
-"inventory" and "log". Each of these opens up only a single window into the
-client, filling up the entire terminal. This may be useful for running multiple
-clients in parallel in multiple terminal windows that can be managed by one's
-own window manager choice, instead of relying on plomrogue-client's bizarre
-in-client window management.
+any of the two by hand.
+
+Keybindings
+-----------
+
+a - let AI decide move
+
+w - move north-west
+e - move north-east
+s - move west
+d - move east
+x - move south-west
+c - move south-east
+
+l - toggle "look" mode, investigate map cells by moving a cursor over the map
+    instead of the player avatar
+
+p - pick up item
+D - drop item selected in inventory
+u - use item selected in inventory
+
+UP - navigate upwards in Inventory
+DOWN - navigate downwards in inventory
 
 Replay game recording
 ---------------------