--- deliantra/server/pod/random_maps.pod	2010/07/12 22:28:17	1.10
+++ deliantra/server/pod/random_maps.pod	2010/12/15 20:16:38	1.11
@@ -2,21 +2,20 @@
 
 =head2 Using random maps
 
-Any exit with "/!" as the destination map will generate a random map.  To
+Any exit with "/!" as the destination map will generate a random map. To
 specify random map parameters, you put parameters in the message field for
 the exit.
 
 =head2 How styles work
 
-A "style" is usually a small map which contains only objects which
-define the "style".  For example, a monsterstyle "orc" might be a map
-generated with crossedit which has six orcs, a kobold, and a troll in it.
-When monsters are placed, the generator will randomly choose monsters from the
-"orc" style, and for this example, on average, it will generate 6 orcs/troll
-and 1 kobold/troll.  So orcs will be very common, and there'll be occasional
-trolls and kobolds.
+A "style" is usually a small map which contains only objects which define
+the "style". For example, a monsterstyle "orc" might be a map which has
+six orcs, a kobold, and a troll in it. When monsters are placed, the
+generator will randomly choose monsters from the "orc" style, and for this
+example, on average, it will generate 6 orcs/troll and 1 kobold/troll. So
+orcs will be very common, and there'll be occasional trolls and kobolds.
 
-In principle, you may put any object in any style map.  However, the
+In principle, you may put any object in any style map. However, the
 map generator will do special things with the object depending on which
 directory it is in. Style maps are located in maps/styles/*, you may use
 the editor to modify the style maps, or create new ones.
@@ -41,7 +40,7 @@
   layoutstyle <style>   (special!) Pick the layout style for the map.
                         Currently, "rogue", "spiral", "maze", "cave",
                         "castle", "snake", "onion", "squarespiral" and
-                        "multiple" are allowed.  See below for more
+                        "multiple" are allowed. See below for more
                         detail.
 
   floorstyle <style>    Load /styles/floorstyles/<style> and pick a random
@@ -49,8 +48,8 @@
                         The entire map will be tiled with the floortype.
 
   wallstyle <style>     Load /styles/wallstyles/<style> and pick a random
-                        walltype from that style for the random map.  All
-                        the walls in the map will be of this type.  The
+                        walltype from that style for the random map. All
+                        the walls in the map will be of this type. The
                         walls are modified on insertion so that players
                         cannot go through them: this is expected for
                         walls, but the random map generator makes sure of
@@ -69,179 +68,179 @@
 
   decorstyle <style>    Load /styles/decorstyles/<style> and pick the
                         decor objects from that style to insert in the
-                        map.  Decor objects are modified on insertion so
+                        map. Decor objects are modified on insertion so
                         that they do NOT block movement, regardless of the
-                        archetype.  They are placed randomly. A style of
+                        archetype. They are placed randomly. A style of
                         "none" causes no decor objects to be generated.
 
   monsterstyle <style>  Load /styles/monsterstyles/<style>, if it exists.
-			If it doesn't exist, then it will look for a directory
-			of that name.  If it finds a directory, it will choose
-			a style based on dungeon_level.  It will pick the style
-			with the name <name>_# with the # closest to the 
-			dungeon_level.  Monster objects are copied from the
-			style map, so you may form style maps with modified 
-			monsters which are weaker or stronger than the default 
-			archetype.A style of "none" causes no monsters to be
+                        If it doesn't exist, then it will look for a directory
+                        of that name. If it finds a directory, it will choose
+                        a style based on dungeon_level. It will pick the style
+                        with the name <name>_# with the # closest to the 
+                        dungeon_level. Monster objects are copied from the
+                        style map, so you may form style maps with modified 
+                        monsters which are weaker or stronger than the default 
+                        archetype.A style of "none" causes no monsters to be
                         generated.
 
   treasurestyle <style> (Special) If the style name chosen is contained
                         in the lib/treasures file, it will use
-                        that for making treasures.  If it is NOT
+                        that for making treasures. If it is NOT
                         in the lib/treasures file, it will look up
                         /styles/treasurestyle/<style>, and pick random
-                        treasures from there.  If <style> matches neither
+                        treasures from there. If <style> matches neither
                         of these, it will generate treasures using the
-                        "chest" treasurelist.  A style of "none" causes no
+                        "chest" treasurelist. A style of "none" causes no
                         treasures to be placed.
 
 =head2 Layout Parameters
 
 
-  xsize <int>		size of the map:  if not set, random from 10 to 70
+  xsize <int>           size of the map: if not set, random from 10 to 70
   
   
-  ysize <int>		size of the map:  if not set, random from 10 to 70
+  ysize <int>           size of the map: if not set, random from 10 to 70
   
   
   expand2x <bool>       Do we double the size of the layout?  This has
                         the effect of increasing the corridor widths by about
-                        2x.  Set it to a non-zero integer if this is desired.
+                        2x. Set it to a non-zero integer if this is desired.
   
   
-  symmetry <sym> 	symmetry of the layout:  You can cause the map generator
-			to generate a symmetrical layout by using this flag.
-			symmetry 0   random symmetry
-			symmetry 1  no symmetry
-			symmetry 2  symmetry about the vertical centerline
-			symmetry 3  symmetry about the horizontal centerline
-			symmetry 4  both 2 and 3 symmetry
-
-
-  Layout Style:	Parameter:			Effect:
-
-			
-  maze		maze_type			0: roomy (open space with some walls)
-  						1: sparse (maze with some larger open spaces)
-   						2: braided (few dead ends)
-   						3: closed (complete maze)
-   						default: random
-
-  cave		cave_type			0: very rough, mazelike
-                                                1: round 1-2 space corridors, often elliptic
-                                                2: more open, roundish
-                                                3: wide open areas, roundish
+  symmetry <sym>        symmetry of the layout: You can cause the map generator
+                        to generate a symmetrical layout by using this flag.
+                        symmetry 0   random symmetry
+                        symmetry 1  no symmetry
+                        symmetry 2  symmetry about the vertical centerline
+                        symmetry 3  symmetry about the horizontal centerline
+                        symmetry 4  both 2 and 3 symmetry
+
+
+  Layout Style: Parameter:    Effect:
+
+                        
+  maze          maze_type     0: roomy (open space with some walls)
+                              1: sparse (maze with some larger open spaces)
+                              2: braided (few dead ends)
+                              3: closed (complete maze)
+                              default: random
+
+  cave          cave_type     0: very rough, mazelike
+                              1: round 1-2 space corridors, often elliptic
+                              2: more open, roundish
+                              3: wide open areas, roundish
 
   50% of the time a maze layout will be "doorified", meaning that doors
   will be placed at random in the maze.
 
-  onion		layoutoptions1 0 (default)	Pick random options
-		See "Onion Rooms" below for
-		the rest of the options.
+  onion         layoutoptions1 0 (default)      Pick random options
+                See "Onion Rooms" below for
+                the rest of the options.
 
-  onion		layoutoptions2 0 (default)	Pick a random number of
-						"onion layers"
+  onion         layoutoptions2 0 (default)      Pick a random number of
+                                                "onion layers"
 
 =head2 Map generation parameters
 
 
-  difficulty		Set the map difficulty.  Has no relation to the 
-       		"difficulty" defined in common/*.c.
-       		If nonzero, this map and its descendants will 
-       		have the same difficulty.  If zero, it'll be set
-       		to the value of dungeon_level and incremeneted with
-       		each recursive map.
-
-  difficulty_increase	Sets how fast the difficulty increases.  This value
-       		is a float - the default value is 1.0.  Reducing
-       		This only applies to map without a default
-       		difficulty set (but that could change in the
-       		future).  For each level of a map, the difficulty
-       		is set to depth * difficulty_increase.  Setting
-       		this parameter to 0.5 (or other values between 0
-       		and 1) is a way to have deep dungeons that do not
-       		increase in difficulty all that rapidly.
-
-
-  dungeon_level	Another way of setting the map difficulty.  This
-       		has no relation to the "difficulty" defined in
-       		the common/*.c source code.  The effect is to pick
-       		which monsters to use:  for example, if the 
-       		monsterstyle
-       		is "humanoid" and the dungeonlevel is 9, the style
-       		map /styles/monsterstyles/humanoid/humanoid_9 will be
-       		the style from which monsters are chosen.  After the
-       		monsters are placed, the map 
-       		difficulty is set according
-       		to the server's rule, for treasure purposes.
-
-  dungeon_depth	The map generated will have an exit to another
-       		random map of the same style if 
-       		dungeon_level < dungeon_depth.  The next random map
-       		will have dungeon_level incremented.  If dungeon_level
-       		>= dungeon_depth, no exit to a more difficult map
-       		will be made.
-
-  orientation		How the exits look:
-       		0		random "orientation"
-       		1		player arrives in the map at
-       				a "stairs up", he goes to harder
-       				levels by finding a "stairs down"
-       		2		reverse of 1
-       		3-6		exits are horizontal.  In the future
-       				these will be made to make exits to
-       				rightward, leftward, north and south.
-
-  rotate	0	do not randomly rotate the map
-  		1	randomly rotate by 90, 180, 270° (default)
-
-  origin_x		<You shouldn't need to set this>  The exit which
-       		leads back from this map will go to this x.
-
-  origin_y		Like origin_x
-
-  random_seed		Set the random seed number used.  This number
-       		completely determines the random numbers:  a map
-       		with the same random seed and other parameters
-       		will always produce exactly the same map.
-
-  final_map		When dungeon_level >= dungeon_depth, another exit
-       		isn't usually made.  However, if final_map is set
-       		to a map's name, then an exit to this map will
-       		be made.
-       		
-  exit_on_final_map	The default action is to place an exit on
-            the final map.  When explicitly set to 'no' this will 
-			not place a return exit on the final_map.  
-			If you use this setting YOU MUST PROVIDE A WAY BACK IN THE FINAL MAP!
+  difficulty    Set the map difficulty. Has no relation to the 
+                "difficulty" defined in common/*.c.
+                If nonzero, this map and its descendants will 
+                have the same difficulty. If zero, it'll be set
+                to the value of dungeon_level and incremeneted with
+                each recursive map.
+
+  difficulty_increase   Sets how fast the difficulty increases. This value
+                is a float - the default value is 1.0. Reducing
+                This only applies to map without a default
+                difficulty set (but that could change in the
+                future). For each level of a map, the difficulty
+                is set to depth * difficulty_increase. Setting
+                this parameter to 0.5 (or other values between 0
+                and 1) is a way to have deep dungeons that do not
+                increase in difficulty all that rapidly.
+
+
+  dungeon_level Another way of setting the map difficulty. This
+                has no relation to the "difficulty" defined in
+                the common/*.c source code. The effect is to pick
+                which monsters to use: for example, if the 
+                monsterstyle
+                is "humanoid" and the dungeonlevel is 9, the style
+                map /styles/monsterstyles/humanoid/humanoid_9 will be
+                the style from which monsters are chosen. After the
+                monsters are placed, the map 
+                difficulty is set according
+                to the server's rule, for treasure purposes.
+
+  dungeon_depth The map generated will have an exit to another
+                random map of the same style if 
+                dungeon_level < dungeon_depth. The next random map
+                will have dungeon_level incremented. If dungeon_level
+                >= dungeon_depth, no exit to a more difficult map
+                will be made.
+
+  orientation           How the exits look:
+                0               random "orientation"
+                1               player arrives in the map at
+                                a "stairs up", he goes to harder
+                                levels by finding a "stairs down"
+                2               reverse of 1
+                3-6             exits are horizontal. In the future
+                                these will be made to make exits to
+                                rightward, leftward, north and south.
+
+  rotate        0       do not randomly rotate the map
+                1       randomly rotate by 90, 180, 270° (default)
+
+  origin_x              <You shouldn't need to set this> The exit which
+                        leads back from this map will go to this x.
+
+  origin_y              Like origin_x
+
+  random_seed           Set the random seed number used. This number
+                        completely determines the random numbers: a map
+                        with the same random seed and other parameters
+                        will always produce exactly the same map.
+
+  final_map             When dungeon_level >= dungeon_depth, another exit
+                        isn't usually made. However, if final_map is set
+                        to a map's name, then an exit to this map will
+                        be made.
+                
+  exit_on_final_map     The default action is to place an exit on
+                        the final map. When explicitly set to 'no' this will 
+                        not place a return exit on the final_map.
+                        If you use this setting YOU MUST PROVIDE A WAY BACK IN THE FINAL MAP!
 
 =head2 Misc. Parameters
 
-  decoroptions <option>	Currently, ignored.  Possibly in the future it
-       		will cause the decor to be patterned in some way,
-       		such as <put decor along walls> or <put decor
-       		in center of rooms>
-
-
-  treasureoptions <opt>	Parameterizes how the treasure is placed and protected.
-       	0	choose random treasure options
-       	1	concentrate the treasure on the map in a few locations
-       	2	hide the treasure behind hidden doors
-       	4	put the treasure in a chest which must be unlocked.
-       		(a key will be placed somewhere in the map, probably
-       		in a monster.)
-       	8	Put locked doors around the treasure (a key to each
-       		door will be placed in a monster or somewhere reachable
-       		by the player:  one key on each side of the door.)
-       		In onion maps, the treasure is co-located with the
-       		exit to harder levels, so this makes the exit harder
-       		to get to.
-       	16	Trap the treasure.  A trap from /styles/trapstyles/traps
-       		is selected and inserted into the treasure chest.
-       	32	sparse treasure.  1/2 as much treasure is generated.
-       	64	rich treasure.  2x as much treasure is generated.
+  decoroptions <option> Currently, ignored. Possibly in the future it
+                will cause the decor to be patterned in some way,
+                such as <put decor along walls> or <put decor
+                in center of rooms>
+
+
+  treasureoptions <opt> Parameterizes how the treasure is placed and protected.
+        0       choose random treasure options
+        1       concentrate the treasure on the map in a few locations
+        2       hide the treasure behind hidden doors
+        4       put the treasure in a chest which must be unlocked.
+                (a key will be placed somewhere in the map, probably
+                in a monster.)
+        8       Put locked doors around the treasure (a key to each
+                door will be placed in a monster or somewhere reachable
+                by the player: one key on each side of the door.)
+                In onion maps, the treasure is co-located with the
+                exit to harder levels, so this makes the exit harder
+                to get to.
+        16      Trap the treasure. A trap from /styles/trapstyles/traps
+                is selected and inserted into the treasure chest.
+        32      sparse treasure. 1/2 as much treasure is generated.
+        64      rich treasure. 2x as much treasure is generated.
 
-                If option 1 is not set, options 2-16 are ignored.  Options
+                If option 1 is not set, options 2-16 are ignored. Options
                 may be added together: treasureoptions 3 means treasure
                 optons 1 and 2 are set.
 
@@ -251,7 +250,7 @@
 
 Onion rooms are like this:
 
-    regular			   random
+    regular                        random
     centered, linear onion:        bottom/right centered, nonlinear:
 
     #########################     #########################
@@ -271,13 +270,13 @@
     #########################     ######################### 
 
     options:
-    0	Pick random options below
-    1	"centered"
-    2	linear doors (default is nonlinear)
-    4	bottom "centered"
-    8  	bottom-right centered
-    16	outer wall off:  i.e., no outer wall.
-    32	irregularly/randomly spaced layers (default: regular)
+    0   Pick random options below
+    1   "centered"
+    2   linear doors (default is nonlinear)
+    4   bottom "centered"
+    8   bottom-right centered
+    16  outer wall off: i.e., no outer wall.
+    32  irregularly/randomly spaced layers (default: regular)
 
 =head3 Maze Maps
 
@@ -623,9 +622,9 @@
     layoutoptions1:
 
     0  pick random options
-    1  Regular spiral:  distance increases constantly with angle
-    2  Fine spiral:  most coils possible are fit in
-    4  Fit Spiral:  scale spiral to fit rectanglar region
+    1  Regular spiral: distance increases constantly with angle
+    2  Fine spiral: most coils possible are fit in
+    4  Fit Spiral: scale spiral to fit rectanglar region
        (i.e., the spiral will look elliptical)
 
 =head3 Rogue-like Maps