home · contact · privacy
Maps are always squares, therefore define only their edge lengths.
[plomrogue] / README
diff --git a/README b/README
index 2a0206deb2935950eeb388b70ac7a09c0812a840..5ec2f4ae7b059650e3b247ba10f3f7d7f37d4668 100644 (file)
--- a/README
+++ b/README
@@ -78,21 +78,9 @@ Hacking / server internals and configuration
 --------------------------------------------
 
 The ./confserver/world file defines the map object types, actions available to
-them, the map itself, the map object type (species) of the player and whether
-enemies see the whole map or only a line-of-sight field of view. Each definition
-consists of a single- or multi-line block wherein each line sets one attribute.
-
-Here's a typical map definition block:
-
-MAP_TYPE 0
-HEIGHT 64
-WIDTH 64
-
-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. 
+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:
 
@@ -131,14 +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.
 
-A line of "PLAYER_TYPE" followed by a number sets the map object type (id) of
-the player's creature.
+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 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.
+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