home · contact · privacy
Maps are always squares, therefore define only their edge lengths.
[plomrogue] / README
diff --git a/README b/README
index 2770f53c8d03cea998c9232f6f82b04975c47d35..5ec2f4ae7b059650e3b247ba10f3f7d7f37d4668 100644 (file)
--- a/README
+++ b/README
@@ -12,10 +12,8 @@ to gain hitpoints. 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. If no enemy is found in their surroundings,
-they just wait.
-
-Diagonal movement is possible, but takes (40%) longer than orthogonal movement.
+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
@@ -47,8 +45,8 @@ 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
+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
@@ -80,29 +78,9 @@ Hacking / server internals and configuration
 --------------------------------------------
 
 The ./confserver/world file defines the map object types, actions available to
-them and the map itself. Each definition consists of a multi-line block wherein
-each line sets one attribute of the object type, action or the map.
-
-Here's a typical map definition block:
-
-MAP_TYPE 0
-HEIGHT 64
-WIDTH 64
-DIST_ORTHOGONAL 5
-DIST_DIAGONAL 7
-
-A line of "MAP_TYPE" followed by a non-empty token starts the map definition
-block. In the future, the second token may differentiate different map types,
-but as of right now, only one is available and the value is not interpreted.
-The numbers after "HEIGHT" and "WIDTH" give the map's vertical and horizontal
-extensions in cells. They must be >= 1 and <= 256. The numbers after
-"DIST_ORTHOGONAL" and "DIST_DIAGONAL" define the diagonal movement penalty as
-the second value divided by the first. The above values define a penalty ratio
-of 7/5 or 1.4, i.e. it takes 40% longer in turns to move diagonally than
-orthogonally. Set both to the same value to eliminate the diagonal movement
-penalty. A negative penalty to realize weird geometry is possible by setting
-"DIST_DIAGONAL" to a lower value than "DIST_ORTHOGONAL". Both values, however,
-must be >= 1 and <= 255.
+them, the map geometry and the map object type (species) of the player. Each
+definition consists of a single- or multi-line block wherein each line sets one
+attribute.
 
 Here's a typical action definition block:
 
@@ -141,11 +119,21 @@ yet: or if they are inanimate, but are otherwise crushed). Note that the
 after, it may even be the same). "START_NUMBER" sets the number of objects that
 are to appear of the given type on the map on game start.
 
-All these definition block members must be present within their blocks, but only
-"ACTION" / "OBJECT" / "MAP_TYPE" must be positioned at their respective blocks'
-first line; the others may appear in whatever order and even multiple times. If
-an object or action definition block is finished, however, it cannot be
-re-defined by starting a new block with the same object type or action id.
+The map is defined by a single-line block. Its number value sets the map
+square's edge length. It must be >= 1 and <= 256:
+
+MAP_LENGTH 64
+
+The player type / species is also defined by a single line block. Its number
+value sets the player's creature's map object type by its id:
+
+PLAYER_TYPE 0
+
+All these definition block members must be present within their respective
+blocks, but only "ACTION" and "OBJECT" must be positioned at their respective
+blocks' first line; the others may appear in whatever order and even multiple
+times. If an object or action definition block is finished, however, it cannot
+be re-defined by starting a new block with the same object type or action id.
 
 Tokens in this config file are separated by whitespace. Single quotes can be
 put around string values that are to include whitespace by themslves. Note that