home · contact · privacy
Server: Fix segfault when parsing THINGS_HERE on player sans .fov_map.
[plomrogue] / README
diff --git a/README b/README
index ce60e55572fd4d3fdf6922e21cb63a78c8cd69bd..49cf3a8158a888a7299f2118ce012af0d5804910 100644 (file)
--- a/README
+++ b/README
@@ -8,12 +8,14 @@ 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
 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. Note that different kinds of movements/actions take different
+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.
 
 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 just wait.
+Enemies' AI is very dumb so far: Each turn, they look out for actors of
+different species to flee from (if their type starts out with more hitpoints
+than they have) or (if the opposite is the case) move towards for purposes of
+attack. 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
 
 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
@@ -24,8 +26,9 @@ System requirements / installation / running the game
 -----------------------------------------------------
 
 The game is expected to run on Linux systems that contain the ncurses library.
 -----------------------------------------------------
 
 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.) Do the
-following steps:
+(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:
 
 $ git clone https://github.com/plomlompom/plomrogue
 $ cd plomrogue
 
 $ git clone https://github.com/plomlompom/plomrogue
 $ cd plomrogue
@@ -45,18 +48,20 @@ the two by hand.
 Client's keybindings and window management
 ------------------------------------------
 
 Client's keybindings and window management
 ------------------------------------------
 
-In the client's default window configuration, the window appearing on the left
-sports a list of keybindings available globally, and additionally via the window
-selected as active.
-
-Hit "W" (per default 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 allows changing its window-specific keybindings. The global keybindings can
-be changed in the "Global keys" window, those of the window geometry
-configuration in the "Window geometry keys" window, and those of the
-window-specific keybindings configuration in the "Window keybinding keys"
-window; by default, these three windows are not visible, but may be turned on by
-(per default keybindings) hitting the "F6", "F7" and "F8" keys.
+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
 
 Keybindings and default window selection / visibilities / geometries are read
 from the textfile ./confclient/interface_conf by default, or by another one