home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / bbs / trivial2 / trivia.doc < prev    next >
Text File  |  1985-12-31  |  10KB  |  238 lines
  1.  
  2.  
  3.                ========================================
  4.                    Documentation for Trivial Pursuit
  5.                  a Script Program for BBS Express! ST
  6.                  written by Keith Ledbetter  11-17-87.
  7.                              ==========
  8.                      Edited by Kolonel Kink of the
  9.                    Compu-erotica bbs (312-425-6061)
  10.                               12-12-87
  11.                ========================================
  12.  
  13.  General Overview
  14.  ----------------
  15.  
  16.  
  17.    Welcome to Trivial Pursuit, a Script game written for BBS Express! ST
  18. systems.   This game is based loosely on 2 things:  (1) the actual Trivial
  19. Pursuit board game, and (2) previous 'Trivia' scripts written by Express!
  20. SysOps (such as John R. Heritage).
  21.  
  22.  
  23.    There are some very nice features in this version of Trivia, which are
  24. listed below.
  25.  
  26.  
  27.    -  The program will serve as a good learning tool for those of you who
  28.       are learning Script language.  It does many of the "less-used" features
  29.       of Script, such as using the NOTE and POINT commands to index into each
  30.       of the six question files.
  31.  
  32.    -  This program is HUGE.  It gives some good insight into just how powerful,
  33.       large, and fast a script file can be now under version 1.30 of the BBS.
  34.  
  35.    -  The most exciting ability is that your USERS can add their own trivia
  36.       questions to the game.   You, as SysOp, can control this.  It's up to
  37.       you to set the security level required to add new questions to the
  38.       game.   In other words, you can let everyone add questions, or only
  39.       yourself.
  40.  
  41.    -  All of the functions are contained in one .COM file: the playing of the
  42.       game, viewing of the Hall of Fame, insertion of names into the Hall of
  43.       Fame, adding new questions to the game, and viewing the "tips" file.
  44.  
  45.    -  You can control whether new questions added to the game are used
  46.       immediately or "hidden" until you validate them.
  47.  
  48.    -  You can assign a set number of questions to be played per game.
  49.  
  50.    -  You can set a time limit for the game.
  51.  
  52.    -  You can display the name of the person who entered the question
  53.       when the question is used in the game.
  54.  
  55.    -  An unlimited number of questions in each category (limited only by
  56.       your free disk space, of course).
  57.  
  58.    -  You can specify that you don't want users to be able to get the
  59.       same question in any one game. In this case if all the questions
  60.       in a category have been used the category is rendered dead.
  61.  
  62.    -  Multiple answers supported.  In other words, "Illinois" could be
  63.       answered by either "Illinois", "IL", or "ILL".
  64.  
  65.  
  66.  
  67.  
  68.  The Program
  69.  -----------
  70.  
  71.  
  72. To put this game on your BBS, you WILL have to recompile the script file
  73. using the SC.TTP program after making a few changes to some of the
  74. variables in the file.  The steps are as follows:
  75.  
  76.  
  77.    1.  Boot up your favorite text editor and load in TRIVIA.SCR.
  78.  
  79.    2.  Change the PATHNAME define to the drive and folder that you are going
  80.        to place the data files (the .QUE and .DAT files).
  81.  
  82.    3.  Change the HEADING define to the name of your BBS system.
  83.  
  84.    4.  Change the ADD_LEVEL define to your liking.  This number represents the
  85.        COMMAND LEVEL required to add new questions to the trivia game.  In
  86.        other words, setting
  87.  
  88.                 define  ADD_LEVEL = 1
  89.  
  90.        would mean that all users with a level 1 command level could add
  91.        questions to the game.
  92.  
  93.    5.  Change the SHOW_ANSWERS define to your liking.  If this field is set
  94.        to 'Y', then the user will be shown the correct answer to any question
  95.        that he/she misses.   If set to 'N', then the user will simply be told
  96.        that they missed the question.
  97.  
  98.    6.  Change the SHOW_AUTHOR define to your liking.  If it is set to 'Y'
  99.        the person's name who entered the question will be displayed
  100.        just above the question when it is asked.
  101.  
  102.    7.  Change the REPEATS define to your liking.  If set to 'N' a player
  103.        will never be able to play out one category to the point that he
  104.        starts getting repeat questions.  When set to 'N' after a player
  105.        receives all the questions in a particular category that category
  106.        is closed.  In the case that only one category remains active the
  107.        game is automatically ended.
  108.  
  109.    8.  If you would like to apply a maximum number of questions to be asked
  110.        per game change the MAX_QUESTIONS define to the max. number you
  111.        would like. If you don't want a limit set it to 'N'.
  112.  
  113.    9.  If you would like to impose a time limit on the game change the
  114.        MAX_TIME define to the number of minutes per game you would like.
  115.        If no limit is desired set to 'N'.
  116.  
  117. NOTE: All these limitation work with one another. If you set them all the
  118.       game will be ended by whatever limitation is encountered first.
  119.  
  120.   10.  If you would like to use categories other than those set up with
  121.        the game you may do so by making some obvious changes in the program
  122.        at the points requiring category names and filenames.  These areas
  123.        of the program are heavily highlighted.  When this version was
  124.        released I (Kink) included some extra question sets. Feel free to
  125.        inject them into your game.
  126.  
  127.   11.  Change the WAIT_FOR_VALIDATION flag to either 'Y' or 'N', depending on
  128.        your preference.  If you set this field to 'Y', then new questions added
  129.        by users WILL NOT be 'used' until you physically validate them.
  130.        By changing the SYSOP_NAME variable to your handle any questions
  131.        that you enter will be immediately valid regardless of the setting
  132.        of WAIT_FOR_VALIDATION. Change the LOG_FILE variable to the location
  133.        of your system's log. Use the whole path/filename. If you select
  134.        'Y' for WAIT_FOR VALIDATION you will be told in your activity log
  135.        when there is a new addition as well as what file(s) the addition(s)
  136.        were made in.
  137.  
  138.        When you do need to validate a question here's what you do.
  139.        It is accomplished by loading the ".QUE" file into your favorite
  140.        word processor.   The question file layout looks like this:
  141.  
  142.                 valid : N
  143.                 points: 1
  144.                 author: SYSOP*Keith
  145.                 quest1: What kind of nuts were originally used in the
  146.                 quest2: old shell game?
  147.                 answer: Walnuts
  148.                 answer: Walnut
  149.                 answer:
  150.  
  151.        Each question will be in this format.  As you can see, the above
  152.        question WOULD NOT be used because the 'valid' field is set to 'N'
  153.        for NO.  To validate questions, you just simply go through each
  154.        question file, changing the 'N' to a 'Y' for each question that you
  155.        want to validate.
  156.  
  157.   12.  Save the new TRIVIA.SCR file, and exit your text editor.
  158.  
  159.   13.  Compile TRIVIA.SCR into TRIVIA.COM by running the SC.TTP program.
  160.  
  161.   14.  Place TRIVIA.COM into your 80-column menu path.
  162.  
  163.   15.  Copy six .QUE files and the two .DAT files into your data path
  164.        that you specified in number 2 above.
  165.  
  166.   16.  Add the Trivia game to your SYSDATA file with the SYSEDIT.TOS program.
  167.  
  168.  
  169.  
  170.  
  171.  How the game works
  172.  ------------------
  173.  
  174.    As in the Trivial Pursuit board game, there are six categories available
  175. in the game.  These are usually:
  176.  
  177.                         1.  Geography
  178.                         2.  Entertainment
  179.                         3.  History
  180.                         4.  Arts and Literature
  181.                         5.  Science and Nature
  182.                         6.  Sports and Leisure
  183.  
  184.           (You may change the categories as specified earlier)
  185.  
  186.    Each question in the above categories has a 'point value' associated with
  187. it.   This point value ranges from 1-9 points, depending upon the difficulty
  188. of the question.
  189.  
  190.    For each question answered correctly, the user's TOTAL SCORE will be
  191. incremented by the point value of that question.   For each wrong answer,
  192. one point (1) will be decremented from the user's total score (regardless of
  193. the point value of the question).
  194.  
  195.    Before each 'round' of the game, two categories will be picked at random.
  196. The user will be shown the two categories, along with the point value
  197. of the question that will be asked in each category.  It is then up to the
  198. user to choose from which category the question will be asked.
  199.  
  200.  
  201.  
  202.  
  203.  Words of caution
  204.  ----------------
  205.  
  206.  
  207.    This trivia game is written so that the question files will be able to grow
  208. to huge proportions, without any slow-down in execution speed.  This is
  209. accomplished through heavy uses of indexing into the question files.   For
  210. this reason, it is important that you NEVER (never, never, never!) change the
  211. physical order of the question files.
  212.  
  213.    So, when you are 'validating' questions, be extremely careful to do nothing
  214. except change the 'N' to 'Y' in the 'valid' area.   Adding just one extra
  215. character to the file in the wrong place will screw the indexes all up.
  216.  
  217.    But, as usual, I am over-emphasizing this point slightly.  If you ever do
  218. want to change the order of a question file (or, if you ever do it by
  219. accident), there is an easy way to fix it.   Simply delete the TRSTART.DAT
  220. file.  If this file is not found when playing the game, the script will
  221. simply start over with question #1 of each category, and will create a new and
  222. valid TRSTART.DAT file.
  223.  
  224.  
  225.   I hope you and your users enjoy this one.  I think it'll be extremely
  226. popular once we get some large question files built.   Check our BBS in the
  227. next couple of weeks -- we hope to have some large question files built for
  228. you to download.
  229.  
  230.                                 Enjoy!
  231.  
  232.                                   Keith
  233.  
  234.                                       &
  235.  
  236.                                   Kolonel Kink
  237.  
  238.