main_game/start_map.map

   1 ' WARNING: All mod formats are under heavy development.  They may change at any
   2 ' time, breaking old mods.  For this reason, we DO NOT RECOMMEND making mods
   3 ' at this time.
   4
   5 ' This is the start map for the realism main game, which also serves as a mini-
   6 ' guide to making maps for your mods.
   7 ' For a complete guide to modding, see MODDING, in the Realism main directory.
   8
   9 ' TODO: A "mini-guide" this ain't.  Trim it down.
  10
  11 ' Lines starting with an apostraphe (') are comments and will be ignored when
  12 ' the map is processed.  Blank lines are also ignored.
  13
  14 ' THE MAP
  15 ' The map file starts with an ASCII art of the map.  If some lines are shorter
  16 ' than others, they are padded with walls.
  17
  18 ' You can use any symbols you like except for the apostraphe (') and colon (:).
  19 ' Try not to use symbols that are easily confused (1/l, 0/O).
  20
  21 ' Whitespace at the end of lines is trimmed.  Do not use tabs, they throw off
  22 ' the alignment of the ASCII art.
  23
  24 ' Note that case matters.  T != t
  25 ...###...#...
  26 .@1d2d..3d..4dt
  27 ...###...#...
  28
  29 ' THE KEY
  30 ' The art is followed by a key.  Each symbol is given a map function.
  31 ' You can overwrite them and create your own in <module>/map_functions.py.
  32 ' If the map contains any symbols that aren't in the key, the module will output
  33 ' an error message and refuse to run.
  34 ' The symbol must be the first character on the line, followed immediately by
  35 ' a colon.  The space after is optional, but improves readability.
  36 @: start_and_movement_tutorial
  37
  38 ' "safe" squares have no random encounters or other special features.
  39 ' If you want ordinary terrain with random encounters, use "normal" instead.
  40 .: safe
  41 #: wall
  42
  43 ' "door" squares contain closed but unlocked doors.  When open, they act like
  44 ' "safe" squares.
  45 d: door
  46 1: object_tutorial
  47 2: combat_tutorial
  48
  49 ' Some functions take one or more parameters, separated by spaces.  Extra spaces
  50 ' in a row are ignored, as parameters may not be omitted.
  51 ' These two have the parameter "Main Game", which alters the tutorial dialogue
  52 ' to be in-character for the main game.  Use "False" if you want a generic
  53 ' tutorial.
  54 ' You can also just leave it off, since it defaults to False.
  55 3: conversation_tutorial True
  56 4: menu_tutorial True
  57
  58 ' If no function with that name exists, the game will search for a map by that
  59 ' name, and link to any that it finds.  If no map exists, the game will output
  60 ' an error and refuse to run the module.
  61 t: start_town
  62
  63 ' MAP FEATURES
  64 ' After the key come a set of the features of the map as a whole.
  65
  66 ' The four border_ features are like the key above, but apply to the borders
  67 ' of the map.
  68 ' Each one should be either wall or a map name.  You can also use a custom
  69 ' function, but returning True (move OK) will be ignored.  Choose your display
  70 ' appropriately.
  71 border_north: wall
  72 border_east: start_town
  73 border_south: wall
  74 border_west: wall
  75
  76 ' This map has only safe spaces, so this section is for reference only.
  77 ' "normal" squares would cause encounters 20% of the time, with a safe period
  78 ' of five squares after each encounter.
  79 encounter_frequency: 20
  80 encounter_delay: 5
  81
  82 ' The encounters would be against single, level 1 monsters.
  83 ' If you specify a range for either level or critters, the value will be chosen
  84 ' at random for each encounter.
  85 encounter_min_level: 1
  86 encounter_max_level: 1
  87 encounter_min_critters: 1
  88 encounter_max_critters: 1
  89
  90 ' critter_types is a space-separated list of critter types (as defined in
  91 ' <module>/monsters.py) that can appear on this map.  Note that this only
  92 ' applies to "normal" squares.  Triggered encounters can use any critters.
  93 critter_types: all
  94
  95 ' The map can either use one of the normal tilesets or define its own in
  96 ' <module>/tilesets.py.
  97 tileset: cave