home · contact · privacy
Server: Check against setting map object id of 0 in config file reading.
[plomrogue] / README
diff --git a/README b/README
index a944ceaac75398bcd0fb375016bae75213b0ec69..2770f53c8d03cea998c9232f6f82b04975c47d35 100644 (file)
--- a/README
+++ b/README
@@ -111,12 +111,12 @@ NAME move
 EFFORT 5
 
 A line of "ACTION" followed by a number starts an action definition block and
-sets the action's id for internal use to 1. The number after "EFFORT" determines
-how many turns this action takes for the actor performing it. The string after
-"NAME" names the action. Furthermore, if it is one of "move", "pick_up", "drop"
-or "use", it matches internal functions described by these strings to this
-action. All other names (including "wait") currently are matched to a do-nothing
-wait function.
+sets the action's id (must be > 0) for internal use to 1. The number after
+"EFFORT" determines how many turns this action takes for the actor performing
+it. The string after "NAME" names the action. Furthermore, if it is one of
+"move", "pick_up", "drop" or "use", it matches internal functions described by
+these strings to this action. All other names (including "wait") currently are
+matched to a do-nothing wait function.
 
 Here's a typical map object type definition block: 
 
@@ -126,6 +126,7 @@ SYMBOL z
 LIFEPOINTS 3
 CORPSE_ID 5
 CONSUMABLE 0
+START_NUMBER 9
 
 A line of "OBJECT" followed by a number starts it, and the number sets the
 object type's internal id. The number after "CONSUMABLE" defines the object
@@ -137,7 +138,8 @@ the id of the object type that objects of this type degrade to if their
 hitpoints drop to zero if they start out as inanimate (what is not implemented
 yet: or if they are inanimate, but are otherwise crushed). Note that the
 "CORPSE_ID" must match the id of an object type defined in the file (before or
-after, it may even be the same).
+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'