home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbsdoor / tk104.zip / TKQUEST.DOC < prev    next >
Text File  |  1992-10-05  |  24KB  |  661 lines

  1.  
  2.  
  3.       ┌─────────────────────────────────────────────────────────────────╖
  4.       │     Thabean Knights Ver 1.4    Quest Writing Documentation      ║
  5.       ╘═════════════════════════════════════════════════════════════════╝
  6.  
  7.  
  8.                Quests are the substance of the Thabean Knights.
  9.  
  10.            Like all good story-telling, the way a Quest is written
  11.                 will determine the player's enthusiasm for it.
  12.  
  13.         It is suggested that you not deviate too far from the setting
  14.          of the Thabean Knights to insure continuity for the players.
  15.  
  16.  
  17.  
  18.        FORMAT:
  19.        ======
  20.  
  21.          The quest files are designed to give you (and your "Knights")
  22.        the power to control the game.  Creating good quest files will
  23.        keep the game interesting and a challenge.
  24.  
  25.          The format of the quest files:
  26.  
  27.            (Quest 1)   -TITLE
  28.                        -AUTHOR
  29.                        :START
  30.                          .
  31.                          .
  32.                        :FINISH
  33.            (Quest 2)   -TITLE
  34.                        -AUTHOR
  35.                        :START
  36.                          .
  37.                          .
  38.                        :FINISH
  39.  
  40.  
  41.        KEYS:
  42.        =====
  43.  
  44.          Each player's Knight has 100 "Keys" dedicated to the quests.
  45.  
  46.          Each Key is numbered from 1 to 100 (Key1, Key2, ..., Key100),
  47.        and stores a value from 0 to 255.
  48.  
  49.          The player's Keys may be set, compared, incremented and
  50.        decremented within the quest.  The Keys are saved from quest to
  51.        quest, however, all the Keys are reset when the player completes
  52.        a level's quests.
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                                      - 1 -
  61.  
  62.  
  63.        COMMANDS:
  64.        ========
  65.  
  66.          The commands of the Quest###.RAW text files form a simple
  67.        language of words.  At times they can get cryptic (during long
  68.        quests) so you will probably want to use a lot of comment lines
  69.        (the ";" at the beginning of the line indicates a comment).
  70.  
  71.               COMMAND  PARAMETERS
  72.  
  73.              -Answer   [Number]
  74.              -Ask      [ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789]
  75.          *   -Author   [Author of Quest]
  76.              -Clear
  77.              -Color    [Fore] [Back] [Blink]
  78.              -EndAns   [Number]
  79.              -Exit
  80.              -Exper    [+/-] [Amount]
  81.          *   :Finish
  82.              -Foe      [Number Flee Move Attack Close]
  83.              -Gold     [+/-] [Amount]
  84.              -Gosub    [Label Number]
  85.              -Goto     [Label Number], [Start] or [Finish]
  86.              -HP       [+/-] [Amount]
  87.              -IF       [(KEY# or GOLD) =,<,> Number]
  88.              -IFElse
  89.              -IFEnd
  90.              -Key      [## +/- ##]
  91.              :Label    [Number]
  92.              -Pause    [Milliseconds]
  93.              -Poison [+/-] [Amt]
  94.              -Return
  95.              -RiteC    [Text]
  96.              -RiteN    [Text]
  97.              -RiteW    [Text]
  98.              -RndFoe
  99.              -RndMon
  100.              -RndKey   [Key Min Max]
  101.              -Set      [Key Number Or STR, DEX, CON, WIS, CHA]
  102.          *   :Start
  103.          *   -Title    [Title of Quest]
  104.              -Turns    [Number]
  105.              -Wait
  106.  
  107.  
  108.            * Indicates required commands necessary for each quest.
  109.  
  110.       NOTES: Any blank lines (not beginning with a command) are ommitted.
  111.  
  112.              None of the commands are Case Sensitive (upper or lowercase).
  113.  
  114.              The "-" and ":" command switches are necessary for each line.
  115.  
  116.              The brackets "[" and "]" should not be typed.  They are shown
  117.              here for emphasis only.
  118.  
  119.  
  120.                                      - 2 -
  121.  
  122.  
  123.  
  124.        COMMANDS EXPLAINED:
  125.        ==================
  126.  
  127.  
  128.       -Answer [Number]
  129.        --------------------------------------------------------------------
  130.           Begins the results for the index to the character returned
  131.         from -Ask.  In the -ASK example, -ANSWER 1 would be used if the
  132.         player pressed "A".
  133.  
  134.  
  135.       -Ask    [ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789]
  136.        --------------------------------------------------------------------
  137.           Waits for a specific key from the list after -Ask.
  138.  
  139.           Example:
  140.  
  141.              -ASK ABC123
  142.  
  143.               Stop and wait for the player to press "A","B","C","1","2",
  144.               or "3".  Each letter is assigned a number in the order of
  145.               appearance ("A"=1, "B"=2, etc) for calls from  -ANSWER
  146.               and -ENDANS.
  147.  
  148.  
  149.       -Author [Author of Quest]
  150.        --------------------------------------------------------------------
  151.           The Author is automatically centered and displayed just after
  152.         the title.  There is no delay after the Author.  This allows you
  153.         to set your own -Pause time at the top of the quest or display
  154.         a description of the quest and then -Wait.
  155.  
  156.           -AUTHOR should be the line following the -TITLE line.
  157.  
  158.  
  159.       -Clear
  160.        --------------------------------------------------------------------
  161.           Clear the Screen in the current color.
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.                                      - 3 -
  181.  
  182.  
  183.  
  184.       -Color  [Fore] [Back] [Blink]
  185.        --------------------------------------------------------------------
  186.                   FOREGROUND                 BACKGROUND     BLINK
  187.  
  188.           0 - Black     8 - Dark Grey        0 - Black      0 - OFF
  189.           1 - Blue      9 - Light Blue       1 - Blue       1 - ON
  190.           2 - Green    10 - Light Green      2 - Green
  191.           3 - Cyan     11 - Light Cyan       3 - Cyan
  192.           4 - Red      12 - Light Red        4 - Red
  193.           5 - Magenta  13 - Light Magenta    5 - Magenta
  194.           6 - Brown    14 - Yellow           6 - Brown
  195.           7 - Grey     15 - White            7 - Grey
  196.  
  197.           All color changes remain until the next call to -COLOR.
  198.  
  199.           If Blink is ommitted, only the Foreground and Background will
  200.         change.  The Blink will remain as it was the last time it was
  201.         changed.
  202.  
  203.  
  204.           Another way to change colors in the text is by using color the
  205.         control codes.  They are far easier to understand when reading
  206.         portions of the quest with a lot of color changes.
  207.  
  208.           The color control codes are created by typing the ASCII 11
  209.         character (most easily created by holding down the ALT key while
  210.         typing 11 on the number pad.)   Most text editors support the
  211.         ALT Key - Number Pad combinations.  This creates the "male" symbol
  212.         (the arrow out of the circle).
  213.  
  214.           Then type the "[" bracket and then the ForeGround and Background
  215.         colors from the chart below.
  216.  
  217.                   FOREGROUND                          BACKGROUND
  218.                                              ( Blink ON )   ( Blink OFF )
  219.           0 - Black     8 - Dark Grey        0 - Black      8 - Black
  220.           1 - Blue      9 - Light Blue       1 - Blue       9 - Blue
  221.           2 - Green     A - Light Green      2 - Green      A - Green
  222.           3 - Cyan      B - Light Cyan       3 - Cyan       B - Cyan
  223.           4 - Red       C - Light Red        4 - Red        C - Red
  224.           5 - Magenta   D - Light Magenta    5 - Magenta    D - Magenta
  225.           6 - Brown     E - Yellow           6 - Brown      E - Brown
  226.           7 - Grey      F - White            7 - Grey       F - Grey
  227.  
  228.           Examples:   (Substitute the ALT-11 Key press for the "&" symbol)
  229.  
  230.                 &[E0 Hello     - Would display Hello in yellow on black
  231.                 &[E8 Hello     - display Hellow in blinking yellow on black
  232.                 &[F0 H&[E0ello - Would display Hellow with the "H" in
  233.                                  white and "ello" in yellow.
  234.  
  235.           Any color changes remain until the next change.
  236.  
  237.  
  238.  
  239.  
  240.                                      - 4 -
  241.  
  242.  
  243.  
  244.       -EndAns [Number]
  245.        --------------------------------------------------------------------
  246.           Ends the results for the index to the character returned
  247.         from -Ask.  In the -ASK example, -ENDANS 1 would be end the
  248.         results portion if the player pressed "A".
  249.  
  250.  
  251.       -Exit
  252.        --------------------------------------------------------------------
  253.           Exit the Quest without giving the player credit for completing
  254.         it.  Use this instead of -GOTO FINISH when you wish to have the
  255.         player exit without finishing the quest.
  256.  
  257.  
  258.       -Exper [+/-] [Amount]
  259.        --------------------------------------------------------------------
  260.           Used to alter the player's experience points.
  261.  
  262.           Example:
  263.  
  264.               -Exper + 10  would add 10 to the player's experience
  265.               -Exper - 2   would subtract 2 from the player's exper.
  266.  
  267.  
  268.       :Finish
  269.        --------------------------------------------------------------------
  270.           End of Quest Label.  This MUST be the last line of the Quest.
  271.  
  272.  
  273.       -Foe    [Number Flee Move Attack Close]
  274.        --------------------------------------------------------------------
  275.           Place the player's Knight in battle with a predetermined foe.
  276.  
  277.           * NUMBER - A list of foes is available from your sysop in file
  278.                      format.  If you wish to have your sysop create a new
  279.                      foe for the quest, see the "FOE" section at the end of
  280.                      this document.
  281.  
  282.             FLEE   - If you include the FLEE parameter, the player and
  283.                      the foe will both have the flee option available
  284.                      during battle.  Otherwise it will be a fight to the
  285.                      death.
  286.  
  287.             MOVE   - If you include the MOVE parameter, the player and
  288.                      the foe will be able to move.  Use this when the
  289.                      encounter occurs in an open area (open enough to
  290.                      allow movement).
  291.  
  292.             ATTACK - If you include the ATTACKED parameter, the foe will
  293.                      get the first attack.  Use this when you wish the
  294.                      player to be surprised by the foe.
  295.  
  296.             CLOSE  - If you include the CLOSE parameter, the foe will
  297.                      be close to the Knight when the battle begins.
  298.                      Otherwise, the starting distance will be randomly
  299.                      set.
  300.                                      - 5 -
  301.  
  302.  
  303.  
  304.       -Foe    [Number Flee Move Attack Close]  (CONTINUED)
  305.        --------------------------------------------------------------------
  306.  
  307.              * - IMPORTANT!  The Number must correspond to an existing
  308.                              foe.  See the "FOE" section at the end
  309.                              of this document.
  310.  
  311.           Make sure that the Level of the Foe corresponds to the level
  312.         of the quest you are creating.
  313.  
  314.           It is important to remember that during battle, the Knights
  315.         will have access to all of their statistics and can use/ready/
  316.         and wear their equipment.
  317.  
  318.  
  319.       -Gold [+/-] [Amount]
  320.        --------------------------------------------------------------------
  321.           Used to add/subtract gold from the player.
  322.  
  323.           Examples:
  324.  
  325.                -Gold - 10   would subtract 10 from the player's gold
  326.                -Gold + 100  would add 100 to the player's gold
  327.  
  328.  
  329.       -Gosub  [Label Number]
  330.        --------------------------------------------------------------------
  331.           Jumps to Label Number (1-100) until -Return is called.  Up to 100
  332.         Gosubs may be "nested" within loops.  This allows for greater
  333.         flexiblity and space saving when you wish to call a frequently
  334.         used portion of the quest (like viewing a map) without losing
  335.         the player's current place in the Quest.
  336.  
  337.  
  338.       -Goto   [Label Number], [Start] or [Finish]
  339.        --------------------------------------------------------------------
  340.           Jump to :Label Number (1-100), :Start, or :Finish of Quest.
  341.         Unlike -GOSUB, -Goto will not keep track of the player's current
  342.         position in the quest.  This is effective when moving from area
  343.         to area or moving around areas when the player is not equiped to
  344.         undergo specific areas.
  345.  
  346.  
  347.       -HP [+/-] [Amount]
  348.        --------------------------------------------------------------------
  349.           Used to add/subtract points from the player's hit points.
  350.  
  351.           Examples:
  352.  
  353.                -HP - 10   would subtract 10 from the player's Hit Points
  354.                -HP + 10   would add 10 to the player's Hit Points
  355.  
  356.  
  357.  
  358.  
  359.  
  360.                                      - 6 -
  361.  
  362.  
  363.  
  364.       -IF     [(KEY# or GOLD) =<> KEY# or Number]
  365.        --------------------------------------------------------------------
  366.           Begin the TRUE of the IF Statement.  If the If statement is
  367.         true then the quest will continue until -IFElse is encountered.
  368.  
  369.           Example:
  370.  
  371.                -If Key1 < 100          Is Key1 less than 100?
  372.                  -GOTO 1               Yes, goto Label 1
  373.                -IFELSE                 End True, Start False
  374.                  -GOTO Finish          No, goto the end of the Quest
  375.                -IFEND                  End
  376.  
  377.                -IF GOLD > 50           Is Player's Gold greater than 50?
  378.                  -GOLD - 50            Yes, Reduce the GOLD by 50
  379.                -IFEND                  End
  380.  
  381.                -IF Key10 < Key20       Is Key10 less than Key20?
  382.  
  383.           Note that the -IFElse statement (false portion to the IF) is not
  384.         necessary for the IF statement to work correctly.
  385.  
  386.           Up to 100 IF statements may be "nested" within each other.  This
  387.         allows for multiple comparisons in order for certain results.
  388.  
  389.           IMPORTANT!  Each -IF statement MUST have a corresponding -IFEND
  390.                       statement!
  391.  
  392.  
  393.       -IFElse
  394.        --------------------------------------------------------------------
  395.           Begin the FALSE of the IF Statement.  If the If statement is
  396.         false then the quest will continue until -IFEND is encountered.
  397.  
  398.  
  399.       -IFEnd
  400.        --------------------------------------------------------------------
  401.           End the Current True or False of the -IF statement.
  402.  
  403.  
  404.       :Label  [Number]
  405.        --------------------------------------------------------------------
  406.           Set Label Number (1-100) for -Goto/-Gosub.  :Label 1 would start
  407.         the block number 1.
  408.  
  409.  
  410.       -Key    [## +/- ##]
  411.        --------------------------------------------------------------------
  412.           Add or Subtract amount to or from Key ##.
  413.  
  414.           Example:
  415.                    -Key 2 + 10 would add 10 to the value of Key2
  416.                    -Key 2 - 1  would subtract 1 from the value of Key2
  417.  
  418.  
  419.  
  420.                                      - 7 -
  421.  
  422.  
  423.       -Pause  [Milliseconds]
  424.        --------------------------------------------------------------------
  425.           Pause for a number of milliseconds.  -PAUSE 1000 would delay
  426.         the quest for 1 second.
  427.  
  428.  
  429.       -Poison [+/-] [Amt]
  430.        --------------------------------------------------------------------
  431.           Increases or Decreases the Player's Level of Poison.
  432.           Amt ranges from 1 to 10
  433.  
  434.           Example:
  435.                    -Poison + 5 would poison the player if the player was
  436.                                not poisoned.  The level of poisoning would
  437.                                increase by 5.
  438.  
  439.  
  440.       -Return
  441.        --------------------------------------------------------------------
  442.           Return to last -Gosub position in the Quest.
  443.  
  444.  
  445.       -RiteC  [Text]
  446.        --------------------------------------------------------------------
  447.           Display Text centered, No Carriage Return.  This will print
  448.         the text to the center of the screen and leave the cursor in the
  449.         space just after the last character.
  450.  
  451.  
  452.       -RiteJ  [Text]
  453.        --------------------------------------------------------------------
  454.           Display Text centered, With Carriage Return.  This will print
  455.         the text to the center of the screen and Jump the cursor to the
  456.         beginning of the next line.
  457.  
  458.  
  459.       -RiteN  [Text]
  460.        --------------------------------------------------------------------
  461.           Display Text, No Carriage Return.  This will print the text
  462.         to the screen and leave the cursor in the space just after the
  463.         last character.
  464.  
  465.  
  466.       -RiteW  [Text]
  467.        --------------------------------------------------------------------
  468.           Display Text, With Carriage Return.  This will print the text
  469.         to the screen and jump to the beginning of the next line.
  470.  
  471.  
  472.       -RndFoe
  473.        --------------------------------------------------------------------
  474.           Causes the Player to be forced into battle with a foe randomly
  475.         selected from the database of foes.  The selected foe will be
  476.         humanoid (one that may be found within the Tavern) and may be
  477.         of a level greater than the player's Knight.
  478.           If no foes are found within the level ranges of the Knight, the
  479.         battle will be skipped entirely.
  480.  
  481.                                      - 8 -
  482.  
  483.  
  484.       -RndMon
  485.        --------------------------------------------------------------------
  486.           Causes the Player to be forced into battle with a foe randomly
  487.         selected from the database of foes.  The selected foe will NOT be
  488.         humanoid (one that may be found within the Tavern) and may be
  489.         of a level greater than the player's Knight.
  490.           If no foes are found within the level ranges of the Knight, the
  491.         battle will be skipped entirely.
  492.  
  493.  
  494.       -RndKey [Key# Min Max]
  495.        --------------------------------------------------------------------
  496.           Sets a Key (1-100) to a random amount between Min and Max.  The
  497.         size limits to Min and Max are from 0 to 255.
  498.  
  499.           Example:
  500.  
  501.                -RNDKEY Key65 200 250
  502.  
  503.                 Key65 will result in a number between 199 and 251.
  504.  
  505.  
  506.       -Set    [Key# Number Or STR, DEX, CON, WIS, CHA]
  507.        --------------------------------------------------------------------
  508.           Sets a Key (1-100) to a specific number from 0 to 255
  509.  
  510.               STR = Player Strength
  511.               DEX = Player Dexterity
  512.               CON = Player Constitution/Endurance
  513.               WIS = Player Wisdom
  514.               CHA = Player Charisma
  515.  
  516.           Example:
  517.  
  518.                -SET Key25 50      The value of Key25 is set to 50.
  519.                -SET Key20 CHA     The value of Key20 is set to the
  520.                                   player's charisma points.
  521.  
  522.           Note: Setting a key to a player's attribute is useful when
  523.                 determining how the player will do in a situation.
  524.  
  525.                 The attribute also includes any magical "plus" currently
  526.                 active on that attribute.
  527.  
  528.       :Start
  529.        --------------------------------------------------------------------
  530.           Beginning of Quest Label.  This MUST be the first line of the
  531.         Quest.  The exceptions to this are the -TITLE and -AUTHOR lines
  532.         which may be just before :START.
  533.  
  534.  
  535.       -Title  [Title of Quest]
  536.        --------------------------------------------------------------------
  537.           The Title is automatically centered and displayed at the very
  538.         beginning of the quest.
  539.  
  540.           -TITLE should be the first line of your quest (just before or
  541.         after the :START Label)
  542.  
  543.                                      - 9 -
  544.  
  545.  
  546.  
  547.       -Turns  [Number]
  548.        --------------------------------------------------------------------
  549.           Number of Turns required to continue.  This will subtract
  550.         [Number] from the players daily turns remaining.
  551.  
  552.           If the number is larger than the turns remaining then the
  553.         player will be informed of the lack of character turns and
  554.         the quest will be exited.
  555.  
  556.           Example:
  557.  
  558.                -TURNS 10
  559.  
  560.                 If the player has more than 10 turns remaining,
  561.                 the turns will be reduced by 10 and the player will
  562.                 be allowed to continue.  Otherwise, the player will
  563.                 be released from the quest and returned to the Courtyard.
  564.  
  565.  
  566.       -Wait
  567.        --------------------------------------------------------------------
  568.           Wait until ENTER/RETURN is pressed.  The prompt is:
  569.  
  570.                ". . Press Thy RETURN/ENTER to continue . ."
  571.  
  572.           The prompt is automatically centered and displayed in the
  573.         current colors set by the -COLOR statement.
  574.  
  575.  
  576.       ; Comment line, not used in Quest
  577.        --------------------------------------------------------------------
  578.           Use the ";" switch at the beginning of a line to keep it from
  579.         being used in the quest.  Using the ";" lines will help you to keep
  580.         track of thoughts and ideas when working on the quest file.
  581.  
  582.  
  583.        FOES:
  584.        ====
  585.               Each Foe has the following characteristics:
  586.  
  587.          FOE: ITEM       RANGE     DESCRIPTION
  588.               --------------------------------------------------------
  589.               NAME       35 Chars  Name of the Foe
  590.               LEVEL      1-250     Level of the Foe
  591.               WEAPON1    1-250     First weapon Index Number
  592.               WEAPON2    1-250     Second weapon Index Number
  593.               ARMOUR1    1-250     First armour Index Number
  594.               ARMOUR2    1-250     Second weapon Index Number
  595.               TREASURE   0-9999    Maximum Amount of Treasure Carried
  596.               HIT PNTS   1-9999    Number of Foe's Hit Points
  597.               POISON     YES/NO    Is the Foe Poisonous?
  598.               MAGIC      YES/NO    Is the Foe Magical?
  599.               KEEP WEP   YES/NO    Allow Knight to keep weapons?
  600.               KEEP ARM   YES/NO    Allow Knight to keep armour?
  601.               TAVERN     YES/NO    Allow Knight in Tavern?
  602.  
  603.                                      - 10 -
  604.  
  605.  
  606.          WEP: ITEM       RANGE     DESCRIPTION
  607.               --------------------------------------------------------
  608.               NAME       35 Chars  Name of the Weapon
  609.               LEVEL      1-250     Minimum level for purchasing.
  610.               TWOHANDED  YES/NO    Is the weapon Two-Handed?
  611.               MAGIC      YES/NO    Is the weapon Magical?
  612.               DISTANT    YES/NO    Is it a long range weapon?
  613.               AMOUNT     1-9999    Maximum Amount of Damage Caused
  614.               MAXUSE     1-250     Maximum Times it can be used.
  615.  
  616.          ARM: ITEM       RANGE     DESCRIPTION
  617.               -------------------------------------------------------
  618.               NAME       35 Chars  Name of the Armour
  619.               LEVEL      1-250     Minimum level for purchasing.
  620.               SHIELD     YES/NO    Is the armour a Shield?
  621.               MAGIC      YES/NO    Is the armour Magical?
  622.               AMOUNT     1-9999    Maximum Amount of Damage Caused
  623.               MAXUSE     1-250     Maximum Times it can be used.
  624.  
  625.  
  626.            Each item has an index number used to reference it.  This
  627.          makes it very simple to use the same weapons and armour for
  628.          different foes within the game.  Same for the Knights.
  629.  
  630.            When creating a new foe for use within quests, please
  631.          provide as much of the above information as possible for
  632.          your Sysop.  When too little information is provided and
  633.          your Sysop has to guess, you may find that the Foe is not
  634.          really what you had in mind for that particular battle.
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.                                      - 11 -
  661.