home · contact · privacy
Also built checks for server config files, and accordingly reformatted those.
[plomrogue] / README
diff --git a/README b/README
index d53dd85a8d6cb25c717655a04b2296f47755c702..7b71967e9ab6cd5ef21abbb0147144444ff70969 100644 (file)
--- a/README
+++ b/README
@@ -18,8 +18,8 @@ obstacles. You can use that for your advantage.
 
 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
-automatially until you end up where you left the game. To start over in a new
-world, delete this file.
+automatically up to the point wherere you left the game. To start over in a new
+world, simply delete this file.
 
 System requirements / installation / running the game
 -----------------------------------------------------
@@ -53,17 +53,17 @@ keybindings may 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
-hitting the "F6", "F7" and "F8" keys.
-
-What actions are available globally or only in specific windows can be further
-manipulated by editing the files ./confclient/keybindings_global and
-./confclient/windows/Win_* that map keycodes to commands to the respective
-keybinding repositories. While keybindings_global contains merely a list of
-keycode command mappings, the Win_* files start with the name of the windows to
-be configured, followed by a one-character line for internal use (mapping the
-window to one of several internally available window content drawing functions),
-followed by two lines describing the window's designated height and width, and
-only then an optional list of keybindings specific to that window.
+(per default keybindings) hitting the "F6", "F7" and "F8" keys.
+
+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 may be managed by one's
+own window manager choice, instead of relying on plomrogue-client's bizarre
+in-client window management.
 
 Replay game recording
 ---------------------
@@ -80,9 +80,11 @@ Hacking / server internals and configuration
 --------------------------------------------
 
 The movements/actions available to the player and the enemies are defined and
-can be changed in ./confserver/map_object_actions. Each line consists of, first,
-a numerical ID used internally to manage the action, secondly the number of
-turns the action takes, and thirdly a string representing the action internally.
+can be changed in ./confserver/map_object_actions. Each entry consists of a
+first line of a numerical ID used internally to uniquely identify and manage the
+action, a second line of the number of turns the action takes, and a third line
+of a string that maps the action to the game logic to perform when it is called.
+Finally, a delimiter line of "%%" ends the entry.
 
 The different map object types, i.e. species (including the player's human one)
 and item types, can be edited in ./confserver/defs. Here the first value is a
@@ -91,7 +93,8 @@ this object decomposes to when it gets destroyed/killed, the third value is the
 character used to represent the object visually on the map, the fourth value is
 the number of hitpoints the object starts with (items are dead and start with
 zero hitpoints, anything else moves), the fifth is the string that names the
-object in the game log. Note that the only valid item use so far, consuming
+object in the game log. Finally, the same delimiter as for the map object action
+definitions file follows. Note that the only valid item use so far, consuming
 "magic meat" to gain hitpoints, is so far hard-coded (this should change in the
 future).
 
@@ -99,7 +102,7 @@ All source files are thoroughly documented to explain more details of
 plomrogue's internals. The ./roguelike-server executable can be run with a -v
 option for helpful debugging info (mostly: what messages the client sends to the
 server). Server and client communicate via files in the ./server/ directory
-(generated when the server is first run). The /server/in fifo receives commands
-for the server as null-terminated strings. The /server/out file contains a
+(generated when the server is first run). The ./server/in fifo receives commands
+for the server as null-terminated strings. The ./server/out file contains a
 serialized representation of the game world's data as it is to be available to
 the player / the player's client.