home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_GAME / LOD400E.ZIP / CUSTOM.DOC < prev    next >
Text File  |  1994-03-03  |  25KB  |  562 lines

  1. Land Of Devastation Sysop Customization Manual
  2. ----------------------------------------------
  3.  
  4. By Scott M Baker
  5.  
  6. Section 1: Purpose
  7. ------------------
  8.        This manual is intended for sysops who wish to modify their Land
  9. Of Devastation games from the default setup. Land Of Devastation allows
  10. the sysop (or Game Master) to change almost every aspect of the game. You
  11. can create your own maps, monsters, weapons & armor, etc.
  12.  
  13. Section 2: Required files
  14. -------------------------
  15.        All of the files required for creating custom LOD games are
  16. contained in the archive LODxxxE.ARJ (with xxx representing the current
  17. LOD version number).
  18.  
  19. Section 3: Programs included
  20. ----------------------------
  21.        LOD includes several utilities to help you customize the game.
  22. These are:
  23.  
  24.        CUSTOM.EXE   - Customization editor. Used to edit some of the
  25.                       more complex fields of the game.
  26.  
  27.        COMPILE.EXE  - Used to compile a new game data set for LOD. (What
  28.                       is a data set? Look below!)
  29.  
  30. Section 4: Data Sets
  31. --------------------
  32.        To make things as easy as possible for both the customizer and
  33. the customizee (the poor guy who tries to run the customized version), LOD
  34. will "compile" most of the game data into a single "data set". This data
  35. set is contained in the file GAME.DEF. For most customized versions, the
  36. only file that needs to be changed is this GAME.DEF
  37.  
  38.        Basically, the data set (GAME.DEF) is a compiled package of the
  39. following text files:
  40.  
  41.        STRINGS.TXT - All of LOD's internal text strings
  42.        MONSTER.TXT - Monster definitions
  43.        COMBAT.TXT  - Combat strings (i.e. "You poke x's eye with your sword")
  44.        TALK.TXT    - Conversations of characters in Tavern & wasteland
  45.        TAVERN.TXT  - Tells who is in what tavern
  46.        TROYINFO.TXT- \
  47.        TRELLNOT.TXT-  > Special purpose text files
  48.        HISTORY.TXT - /
  49.        OBJECT.TXT  - Outlines the object of the game
  50.  
  51.        DATASET.TXT - Data Set identification & misc data
  52.  
  53.        The data set file (GAME.DEF) also includes the following binary
  54. files. These are NOT text files and may not be edited with a text editor. You
  55. must use the customization tool, CUSTOM.EXE to edit these files.
  56.  
  57.        MAIN.MAP    - The main game map
  58.        TERRAIN.BIN - Terrain definitions
  59.        MISC.BIN    - Miscellaneous stuff
  60.        DEVICES.BIN - Main device library
  61.  
  62.        As mentioned above, COMPILE.EXE will take all of those files and
  63. spit out one big GAME.DEF file from them. Therefore, you need not distribute
  64. any of the above text files - just the completed GAME.DEF.
  65.  
  66. Section 5: Locating the default text/binary files
  67. -------------------------------------------------
  68.        The default text and binary files are stored in the archive
  69. STANDARD.ARJ inside of LODxxxE.ARJ. Unarchive this file and it'll dump
  70. out strings.txt, monster.txt, combat.txt, main.map, devices.bin, and
  71. all of the other stuff. Then you can load these up and customize
  72. whatever you want according to section 6 below.
  73.  
  74. Section 6: Customizing the Text files
  75. -------------------------------------
  76.        What follows is a description of how to customize the text files
  77. listed in section four above. To edit these files, use any plain text
  78. editor.
  79.  
  80.   STRINGS.TXT: The master string file
  81.   -----------------------------------
  82.             Almost all of the text strings contained within LOD are taken
  83.      from this file. Everything from "you enter the tavern" to "what do you
  84.      wish to buy" to "there is new mail in the message system" is in here.
  85.      In fact, if you wanted to translate LOD into another language, once
  86.      you translated this one file, you would be about 80% done!
  87.  
  88.             Here's what to do:
  89.  
  90.             1) Load up STRINGS.TXT using any plain-ascii text editor. You can
  91.                now edit the strings and customize them as you wish. Please
  92.                note, the strings are specified one string to each line - if
  93.                you mess up this format, you could possibly shift all of the
  94.                strings and really screw things up. Here is the format:
  95.  
  96.                - Each line is one string definition in the game; So DO NOT
  97.                 DELETE OR INSERT LINES. You'll really mess things up.
  98.  
  99.                - A tilde (~) has been placed at the end of each line as a
  100.                  simple indicator to the user of where the line ends. (i.e.
  101.                  Otherwise lines that ended with a trailing space would be
  102.                  indistinguishable from lines that didn't)
  103.  
  104.                - The ampersand (&) is used to indicate the Land Of
  105.                  Devastation should change colors at that position. The "&"
  106.                  sign is followed by a hexadecimal digit, "0"-"F" specifying
  107.                  the color to change to.
  108.  
  109.                    &0 Black     &6 Brown         &C Light Red
  110.                    &1 Blue      &7 Light Gray    &D Light Magenta
  111.                    &2 Green     &8 Dark Gray     &E Yellow
  112.                    &3 Cyan      &9 Light Blue    &F White
  113.                    &4 Red       &A Light Green
  114.                    &5 Magenta   &B Light Cyan
  115.  
  116.               - The "|" sign is used to indicate a carriage return.
  117.  
  118.               - String may be up to 255 characters in length. (You could use
  119.                 one string entry with multiple "|"'s to specify multiple
  120.                 lines of text)
  121.  
  122.             2) Remember, just editing the file won't have any effect by
  123.                itself. You still need to run COMPILE.EXE to create a new
  124.                GAME.DEF file.
  125.  
  126.             So what needs to be edited in strings.txt? In reality, not a
  127.      whole lot. If you don't like the way something is said in the game
  128.      (or, heaven-forbid, you catch one of my ten thousand misspelled
  129.      words), you can change it. You'll find most of the fun work down
  130.      in the monsters.txt below.
  131.  
  132.   MONSTER.TXT: All the bad guys
  133.   -----------------------------
  134.             Here's where you will get a chance to have some fun. You can
  135.      create any monster you want in here. You can put him in any zone,
  136.      give him whatever weapons you want, and make up a nice description
  137.      of him.
  138.  
  139.             All of the instructions for editing monsters.txt are contained
  140.      at the top of the file. It's really pretty self explanatory - the best
  141.      thing to do is take one of the default monsters, and copy him to another
  142.      section of the file and make your changes to the copy.
  143.  
  144.   COMBAT.TXT: Combat strings
  145.   --------------------------
  146.             In the wasteland, we have all kinds of neat phrases for what
  147.       happens in combat. The combat.txt file is where it all is. Instructions
  148.       for this file are contained up at the top (like in the monster.txt
  149.       file). I'll leave it to you to look at the default stuff and figure
  150.       out how the format works.
  151.  
  152.   TALK.TXT: Character Dialog
  153.   --------------------------
  154.             No customized game is complete without a bunch of cool characters
  155.       that the player can talk to. Here is where you can decide what they
  156.       will say. You can make them say whatever you want and create
  157.       your own "keywords" that their responses will match.
  158.  
  159.             NOTE: If you create any new characters and want them placed in
  160.       a tavern, you will also have to edit the tavern.txt file below.
  161.  
  162.   TAVERN.TXT: People in Taverns
  163.   -----------------------------
  164.             This rather simple file just tells which players are in what
  165.       tavern. For example, say your create a character in the talk.txt file
  166.       above named "weird joe". If you want wierd joe to be in the freedom
  167.       city tavern, then you'll have to add an entry to this file to put
  168.       him there.
  169.  
  170.   TROYINFO.TXT: Troy Hadley's info file
  171.   -------------------------------------
  172.             One of the special quests ends up with the player receiving
  173.       a special rom-disk for his laptop which contains some hints on
  174.       locations, monsters, etc. This text file contains those hints. There's
  175.       no real format to this file - it's just a flat text file. If you
  176.       go moving towns around on the map, you'll probably have to change
  177.       some of the hints in here.
  178.  
  179.   TRELLNOT.TXT: Sergeant Trell's note
  180.   -----------------------------------
  181.             This is Sergeant Trell's note from the Tranlius Nuclear Facility.
  182.       If you want, you can edit it and change the theme a bit.
  183.  
  184.   HISTORY.TXT: History of the War
  185.   -------------------------------
  186.             There's a history rom that the players can get for their laptop.
  187.       It tells about the history of the nuclear war. This is it. Edit it to
  188.       your delight.
  189.  
  190.   OBJECT.TXT: Game Objectives
  191.   ---------------------------
  192.             This is a straight text file which should outline the object of
  193.       the game. Information on the central quest, etc. It is displayed by
  194.       the Game Objectives command in the documentation center of Sacre
  195.       Base.
  196.  
  197.   DATASET.TXT: Data set file
  198.   --------------------------
  199.             This contains some miscellanious "glue" information. Stuff
  200.       that needs to hold the whole package together, but doesn't really fit
  201.       in any of the other files above.
  202.  
  203.             Some minimal instructions are given inside the file - read them
  204.       and make your changes.
  205.  
  206.             The one important thing in here is the NAME and AUTHOR fields.
  207.       If you create a customized LOD data set, then you probably want to
  208.       give it a name and put yourself down as the author. This is where
  209.       you do it. The name/author information will appear on the WORLD
  210.       menu at the documentation center.
  211.  
  212.   GENOBJ.TXT: Generic Object System
  213.   ---------------------------------
  214.             The Generic Object System is intended to allow you to create
  215.       fairly complex objects. This system is fairly complicated and you
  216.       should look to the "Technical Tools" and "Loki Summoner" as
  217.       examples of GENOBJS.
  218.  
  219.             To Create a GENOBJ:
  220.  
  221.               1) Create an item in the device editor with the devapp set
  222.                  to GenObj (40), and set its VAR1 to a unique number (tag)
  223.                  that will be used to link your object to the GENOBJ file.
  224.  
  225.               2) Create an object definition in GENOBJ by using the "TAG x"
  226.                  field, with x being the number you used in VAR1 in step
  227.                  1 above.
  228.  
  229.             GENOBJs will do the following:
  230.  
  231.               a) display all HEADER statements for which the IF's are true.
  232.  
  233.               b) display one RANDOM statement for which the IF's are true.
  234.  
  235.               c) display all FOOTER statements for which the IF's are true.
  236.  
  237.               d) process all CONVERT/REPLICATE/ADDITEM statements in
  238.                  order if their IF's are true.
  239.  
  240.             If any statement listed above has "modifiers" attached to it,
  241.       then the modifier will be applied immediately after the action
  242.       has been executed.
  243.  
  244.             For your GENOBJ to work, there must be one or more "ACTION"
  245.       entries. These are things such as "HEADER", "FOOTER", "CONVERT x > y",
  246.       etc. IF statements and modifiers are completely optional and only need
  247.       to be used if you have a specified purpose for them.
  248.  
  249.             A Few notes about IFs (and MODIFIERS):
  250.  
  251.               - All IF's apply to the action statement that follows the
  252.                 IF's and ONLY that action statement.
  253.  
  254.               - If multiple action statements are present, then any (and all)
  255.                 action statements that have true IF's will be executed.
  256.  
  257.             For Example:
  258.  
  259.               IFTESTX 10
  260.               HEADER
  261.               You are at X coordinate 10.
  262.  
  263.               IFTESTY 15
  264.               HEADER
  265.               You are standing at Y coordinate 15
  266.  
  267.               IFTESTX 10
  268.               IFTESTY 15
  269.               You are standing at x=10 and y=15.
  270.  
  271.             Suppose, that the user is standing at...
  272.  
  273.               X=10, Y=anything but 15: "You are at X coordinate 10"
  274.  
  275.               X=anything but 10, Y=15: "You are standing at Y coordinate 15"
  276.  
  277.               X=10, Y=15: "You are at X coordinate 10",             / Yes, all
  278.                           "You are standing at X coordinate 15",   <  3 are
  279.                           "You are standing at x=10 and y=15"       \ output
  280.  
  281. Section 7: Using CUSTOM.EXE
  282. ---------------------------
  283.        The external editor, NEWLODED.EXE, includes a variety of external editors
  284. and tools to allow the sysop to customize and configure his/her version of
  285. Land of Devastation. I will discuss each of the editor options in order
  286. below:
  287.  
  288.    UTILITIES
  289.         There are a few little utility features which will provide you with
  290.      some information about the game.
  291.  
  292.    EDITORS
  293.         Editors are included for device definitions, terrain, and the
  294.      wasteland map.
  295.  
  296.    SETUP
  297.         This section has options for configuring and setting up lod - what
  298.      new players start with, how much bases cost, etc.
  299.  
  300.      The external editor has an extensive context-sensitive help system which
  301.   can be of great use to you. Simply hit F1 at any time and a help window will
  302.   pop up.
  303.  
  304.  
  305.   NOTE #1: The external editor uses the TAB and SHIFT-TAB keys to move around
  306.            in some areas. Sometimes people find this difficult to understand,
  307.            but it is part of the design of the Turbo Vision tool kit which the
  308.            editor was written with.
  309.  
  310. Section 8: Editing Device Definitions
  311. -------------------------------------
  312.        To edit devices, you will need to use the Device Editor command under
  313. the Editors menu in CUSTOM.EXE.
  314.  
  315.        The following are a list of the various parameters that each device
  316. definition includes:
  317.  
  318.      NAME:     The name of the device; Should not be longer than 15 chars
  319.  
  320.      USES:     Number of uses LEFT on the device. Usually the same as MAXUSE
  321.      MAXUSE:   Maximum number of uses the device has.
  322.      DEV USE:  If "Y", then decrement the USES variable each time the
  323.                device is used.
  324.  
  325.      VAR1:     General purpose variable #1; varies from device to device.
  326.      VAR2:     General purpose variable #2; varies from device to device.
  327.  
  328.      APPLICAT: Code corresponding to what the device does.
  329.  
  330.      USABLE:   "Y" if the device can be used with the U command.
  331.  
  332.      STORE:    Code(s) corresponding to store at which device will be sold.
  333.      COST:     Price of device when sold at store.
  334.  
  335.      ANSI:     8 character string corresponding to attached ansi picture.
  336.      EGA:      Attached EGA graphics picture.
  337.  
  338.      Listing of APPLICAT codes:
  339.  
  340.      0 Radio         9 AML (medline)   18 Death Badge   27 Rom Disk
  341.      1 Medical Kit  10 Rope            19 Warper        28 <Internal>
  342.      2 SR Weapon    11 Rations         20 Communicator  29 B-Teleporter
  343.      3 LR Weapon    12 Scanner         21 B-React       30 Recharger
  344.      4 Armor        13 Stealth         22 B-Comm        31 Pylon Key
  345.      5 <reserved>   14 G-Blaster       23 B-Defense     32 Energy Cell
  346.      6 B.A.D.       15 Unusable Armor  24 B-Moat        33 Unitran
  347.      7 LRScan       16 Grenade         25 B-Weapon      34 Mine
  348.      8 Ammunition   17 Cyclops Eye     26 Laptop        35 Boat
  349.  
  350.      36 Mapper
  351.      37 Cryo-Unit
  352.      38 BaseGeneric
  353.      39 MapPack
  354.      40 Genobj
  355.  
  356.      Listing of store codes:
  357.  
  358.      0 No Store      9 B-Weapon        18 Town #3       27 BaseScav
  359.      1 SR Weapons   10 Computer        19 Town #4       28 BaseEne
  360.      2 Armor        11 LR Weapons      20 Town #5       29 BaseMed
  361.      3 Supply       12 <internal>      21 Town #6       30 Acme Fort
  362.      4 Ammo         13 <internal>      22 Town #7       31 Acme Weapons
  363.      5 B-React      14 GSRZ Hort.      23 Town #8       32 Acme ROM
  364.      6 B-Comm       15 B-Teleporter    24 Town #9
  365.      7 B-Def        16 EEEE            25 Kill, Inc
  366.      8 B-Moat       17 Town #2         26 BasePack
  367.  
  368.      Note: A device may be present at more than one store. If this is the
  369.            case, then list all of the store codes with SPACES inbetween
  370.            them. If a device is not to be present at any store, then leave
  371.            it's store line blank.
  372.  
  373.      Here are some of the definitions for the VAR1/VAR2 parameters for
  374.  some of the various device types.
  375.  
  376.      Weapons: The VAR1 parameter is divided into three fields corresponding
  377.               to the ammo type, minimum, and maximum damage. For example,
  378.               consider the following:
  379.  
  380.               NAME: Rad-Axe
  381.                 .
  382.                 .
  383.               VAR1: 03020030
  384.                 .   \/\:/\:/
  385.                 .   A Min Max
  386.  
  387.               The three fields are 3, 020, and 030. "3" is the ammo type;
  388.               020 is the minimum damage done and 030 is the maximum damage
  389.               done.
  390.  
  391.               For weapons not requiring ammo, use a "0" for the ammo type.
  392.               Always use three digit numbers (i.e. for a 4-6 damage weapon
  393.               requiring power packs, use 03004006, NOT 0346)
  394.  
  395.               This includes SR Weapons (#2), LR Weapons (#3), Base Moats
  396.               (#24), Base Weapons (#25), and Grenades (#16).
  397.  
  398.         Ammo: The VAR1 parameter is the ammo type and the VAR2 parameter
  399.               is the number of shots. For example,
  400.  
  401.               NAME: Power Pack
  402.               VAR1: 3
  403.               VAR2: 35
  404.  
  405.               This is for a power pack - ammo type 3; 35 shots.
  406.  
  407.        Armor: The USELEFT parameter is the amount of damage the armor can
  408.               absorb; The VAR2 is the percentage chance of the armor
  409.               deflecting a hit. (i.e. VAR2=0 means the armor deflects
  410.               nothing; VAR2=100 means the armor deflects everything)
  411.  
  412.               The VAR1 parameter holds some specialty flags. These flags
  413.               are bit mapped. Right now, the flags are as follows:
  414.  
  415.                  Bit 1: If set, then armor is rechargable.
  416.  
  417.  Stlth Field: The SFG (Stealth Field Generator) uses both variables. VAR1
  418.               is 0 if neutral, 1 if noisy, or 2 if quiet. This should normally
  419.               be set to zero.
  420.  
  421.               VAR2 is the SFG's effectiveness. This is a percentage. The
  422.               higher the percentage, the more powerful the SFG is. The
  423.               default is 50.
  424.  
  425.         Mine: The VAR1 variable of the mine defines it's capabilities.
  426.               Example: 03020035. The "03" indicates the mines capabilities,
  427.               the 020 is the minimum damage, and the 035 is the maximum
  428.               damage.
  429.  
  430.               example:
  431.  
  432.               var1: 611020035;
  433.                     :\/\:/\:/
  434.                     :: Min Max
  435.                     ::
  436.                     :Features (Bits 1+2+8)
  437.                     :
  438.                     Robomine number (or empty for non-robomines)
  439.  
  440.               Mine Capabilities: This is setup as a bitmap. Bit #1 is
  441.               for a smart mine, bit #2 is for a energy-drainer mine,
  442.               and bit #3 is for a teleporter mine.
  443.  
  444.               Mine Uses: the Useleft parameter tells how many charges
  445.               the mine contains.
  446.  
  447.  
  448.  
  449.      Note: If/when I bring out a newer version of LOD, it will include a
  450.            replacement DEVICES.DEF file which will overwrite yours. For this
  451.            reason, it will be necessary for you to re-type your custom
  452.            device information back into device.def.
  453.  
  454.            Since I may also add devices to DEVICES.DEF in a future release,
  455.            it may be wise for you to place your custom entries from the
  456.            last position backwards to avoid conflicts with mine.
  457.  
  458. Section 9: Editing Terrain
  459. --------------------------
  460.        To edit Terrain, you will need to use the Terrain Editor option in
  461. the CUSTOM.EXE program.
  462.  
  463.        The terrain editor has the following parameters:
  464.  
  465.      NAME:     The name of the terrain type
  466.      DANGER:   Percentage chance of finding monster there.
  467.      SYMBOL:   2 character symbol for ansi/ascii maps
  468.      COLOR:    Numeric color code for ascii/ansi
  469.      PASSABLE: "Y" if you can walk through it. "N" if you can't.
  470.                Use a "W" to indicate water. (requires miniraft to pass)
  471.  
  472.        NOTE: For compatability (and simplicity) reasons, I would suggest
  473. that you stick with the standard terrain classes if at all possible. We've
  474. tried to throw in just about every possible kind of terrain you might want.
  475.  
  476. Section 10: Creating Trivia
  477. ---------------------------
  478.        You can create your own trivia questions if you use the same format
  479. as in TSAMP1.TXT. Name your text file "TRIVIA.TXT" and run TRIVCOMP to
  480. compile it into TRIVIA.DEF.
  481.  
  482.        A complete 300 question library is provided in the default TRIVIA.DEF
  483. file, but to make sure users don't get a hold of the questions, I had to
  484. keep the non-encrypted text version here!
  485.  
  486. Section 11: The GTSTRS.DEF file
  487. -------------------------------
  488.        Included with both GTERM and LOD, there is a GTSTRS.DEF file which
  489. defines the strings that will be used by the graphical interface. i.e. the
  490. help menus and screens inside the graphics window when using GAMEEGA
  491. or GTERM. Normally, there should be no reason to modify these strings. They
  492. were provided only for very extreme situations, such as the project to
  493. translate LOD into German.
  494.  
  495.        The format is very similar to LOD's strings.txt file, except that
  496. the color codes (&1, &2, ..., &F) are not allowed. You must have one
  497. string per line. You may not add or delete any lines. The "~" symbol is
  498. simply a marker for the end of each line - it is not actually displayed
  499. to the user.
  500.  
  501.        Both GAMEEGA and GTERM have seperate copies of this file. If you
  502. want remote users (with GTERM) to see the changes, then they will have
  503. to obtain their own copy of the file.
  504.  
  505. Section 12: Packaging Considerations
  506. ------------------------------------
  507.        For the purpose in maintaining some kind of standardization in naming
  508. conventions, this is what I would suggest. None of the following is
  509. required, but it establishind a standard really helps everyone out.
  510.  
  511.        1] Place your dataset (GAME.DEF, readme's, text files, whatever) into
  512.           an archive (.ARJ, .ZIP, etc) to keep all of the files together.
  513.  
  514.        2] For the name of your archive, use the following:
  515.  
  516.             a] First four letters identify your data set (i.e. STND for my
  517.                LOD standard data set)
  518.  
  519.             b] Next three letters indicate the version of LOD you compiled
  520.                the set for (i.e. 361)
  521.  
  522.             c] The last letter is a revision letter for your dataset (in case
  523.                you made changes and re-released). Start with "a" every time
  524.                you release for a new version of LOD, increment the indicator
  525.                every time you re-release YOUR data set for that version of
  526.                LOD.
  527.  
  528.             d] Of course, the extension would be .ZIP, .ARJ, .LZH, etc
  529.  
  530.             e] Examples:
  531.  
  532.                  STND361a.ARJ - LOD standard data set, for version 3.61,
  533.                                 revision "a".
  534.  
  535.                  FUTR395f.ARJ - FUTURE data set, compiled for LOD version
  536.                                 3.95, revision "f".
  537.  
  538.        3] Inside your archive, include the following files:
  539.  
  540.             README.TXT  -=-  Whatever you want in here - who you are, what
  541.                              the data set is about, special considerations,
  542.                              etc.
  543.  
  544.             GAME.DEF    -=-  The compiled dataset. The sysop just drops
  545.                              it in to use your data.
  546.  
  547.             ANSI.DEF    -=-  Optional. Only distribute if you modified some
  548.                              of the ansi screens.
  549.  
  550.             TRIVIA.DEF  -=-  Optional. Only distribute if you created some
  551.                              custom trivia.
  552.  
  553.             SOURCE.ARJ  -=-  The "source code" for your data set. All of
  554.                              your customized .TXT files (monster.txt,
  555.                              combat.txt, etc), your maps (MAIN.MAP), device
  556.                              definitions (devices.bin), etc. This is
  557.                              optional - only distribute it if you want
  558.                              other sysops to view/edit your data set.
  559.  
  560.  
  561.  
  562.