home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / main / BBS / TTRIV10.ZIP / readme.txt < prev    next >
Encoding:
Text File  |  2003-07-04  |  20.1 KB  |  465 lines
  1. TOURNAMENT TRIVIA  v1.0
  2. =-=-=-=-=-=-=-=-=-=-=-=
  3. (C) 2003 Evan Elias
  4.                    
  5.  
  6. This is the Sysop Documentation file for Tournament Trivia.  This document is
  7. also available online at http://trivia.doormud.com/sysdocs.html in hypertext
  8. format, complete with configuration screenshots!  You may find that version of
  9. the docs to be much easier to use.
  10.  
  11. Tournament Trivia is a 32-bit Windows door, and will run on the following BBS
  12. software platforms:
  13.  - Synchronet v3.xx for Windows
  14.  - WildCat WinServer
  15.  - Mystic BBS (for Win32)
  16.  - EleBBS (for Win32)
  17.  - MannSoft GameSrv
  18.  - Any other Windows-based BBS with Door32.sys support
  19.  
  20.  
  21.  
  22. Upgrading from a previous version:
  23.    Simply unzip the newer version into your existing Tournament Trivia
  24.    directory, over-writing older files.  Your score files and custom question
  25.    files will not be lost.
  26.  
  27.  
  28. ==============================================================================
  29.  
  30.  
  31. INTRODUCTION 
  32. ------------
  33. Tournament Trivia is a new 32-bit doorgame for Bulletin Board Systems.  
  34. Players compete with each other in real-time, trying to be the first to answer
  35. the current question.  Scores add up from day to day, and are reset at the end
  36. of the month, with one player emerging victorious.  The game offers an 
  37. excellent multi-node environment that also effectively functions as a chat 
  38. room.
  39.  
  40.  
  41.  
  42. DISCLAIMER
  43. ----------
  44. Users of this program must accept the following:
  45.  
  46. TOURNAMENT TRIVIA is supplied as is.  The author disclaims all warranties, 
  47. expressed or implied.  The author assumes no liability for damages, direct or 
  48. consequential, which may result from the use of TOURNAMENT TRIVIA.
  49.  
  50. You may not modify or disassemble this software, in whole or in part.  Use of
  51. decompilers, hex editors, etc on TOURNAMENT TRIVIA is strictly forbidden.
  52.  
  53.  
  54. ==============================================================================
  55.  
  56.  
  57. Contents
  58. ~~~~~~~~
  59. 1. Setup
  60. 2. Configuration options
  61. 3. Adding more questions
  62. 4. Registration
  63. 5. Miscellaneous
  64.  
  65.  
  66. ==============================================================================
  67.  
  68.  
  69. 1. Setup
  70. ~~~~~~~~
  71.  
  72. In order to set up Tournament Trivia, perform the following steps:
  73.  
  74. Step 1:  Create a directory for Tournament Trivia, and copy all of the 
  75.          Tournament Trivia files to this directory.  Please be sure to select
  76.          a directory name that does not contain any spaces in it.
  77.  
  78. Step 2:  You must add the door to your BBS's menus.  Specific instructions for
  79.          every supported BBS software are included below!
  80.  
  81.  
  82. Specific setup instructions:
  83. (Reminder:  http://trivia.doormud.com/sysdocs.html has configuration screenshots
  84. for each BBS software -- please give these a look if you encounter setup 
  85. problems.)
  86.  
  87.  
  88. Synchronet:
  89. ----------
  90.   Tournament Trivia has a special Synchronet version (trivsync.exe) that uses
  91.   Synchronet's proprietary XTRN.DAT instead of using DOOR32.SYS.  Like the
  92.   Door32 version, it is a 32-bit Windows-native doorgame.  But the Synchronet
  93.   version also adds support for Synchronet Global Commands such as on-line user
  94.   lists, log-on/off notifications, and inter-node paging!
  95.  
  96.   To add the game to your board's menus, first run SCFG by selecting 
  97.   BBS -> Configure in the Synchronet console.  Then go to External Programs ->
  98.   Online Programs -> Games -> Available Online Programs, and hit the insert 
  99.   key.  Use "Tournament Trivia" for the program name and "TRIVIA" for the 
  100.   internal code.  Now, configure the door as follows:
  101.  
  102.          ª----------------------------------------------------------ª
  103.          ª ªName                       Tournament Trivia            ª
  104.          ª ªInternal Code              TRIVIA                       ª
  105.          ª ªStart-up Directory         C:\SBBS\XTRN\TRIVIA   <<- Example only
  106.          ª ªCommand Line               trivsync                     ª
  107.          ª ªClean-up Command Line                                   ª
  108.          ª ªExecution Cost             None                         ª
  109.          ª ªAccess Requirements                                     ª
  110.          ª ªExecution Requirements                                  ª
  111.          ª ªMultiple Concurrent Users  Yes                          ª
  112.          ª ªIntercept I/O Interrupts   No                           ª
  113.          ª ªNative (32-bit) Executable Yes                   <<- See below!
  114.          ª ªModify User Data           No                           ª
  115.          ª ªExecute on Event           No                           ª
  116.          ª ªBBS Drop File Type         Synchronet      XTRN.DAT     ª
  117.          ª ªPlace Drop File In         Node Directory               ª
  118.          ª ªTime Options...                                         ª
  119.          +----------------------------------------------------------+
  120.  
  121.          Be sure to set the "start-up directory" to whatever directory you put
  122.          your Tournament Trivia files in.
  123.  
  124.          When selecting the Synchronet XTRN.DAT dropfile type, set "use real 
  125.          names" to "no" in order for inter-node paging to properly display a 
  126.          user's alias.    
  127.  
  128.          The "Native (32-bit)" option is only available in Synchronet v3.10g 
  129.          or later. If you are using an older version of Synchronet, you MUST 
  130.          put trivsync on the OS/2 Program List instead as described below.
  131.  
  132.          New versions of Synchronet may have additional options for doors.  
  133.          You can safely leave those at their default values.
  134.  
  135.  
  136.   If you are running Synchronet v3.10g or later, your setup for the door is now
  137.   complete, and you can exit SCFG.
  138.  
  139.   Otherwise, you are running an older (pre-3.10g) release of Synchronet, which
  140.   does not have the "Native (32-bit) Executable" option in SCFG.  Instead, you
  141.   must manually add trivsync to a seperate list of 32bit doors. This can be
  142.   done in SCFG by selecting External Programs -> OS/2 Program List and hit the
  143.   insert key on your keyboard.  Type "trivsync" and then hit enter.  Select 
  144.   "No" for the "Comm Port" toggle.  (This step is *required* for pre-3.10g
  145.   Synchronet, so do not skip it!)
  146.  
  147.   Next, exit SCFG.  In older versions of Synchronet, you must now manually
  148.   refresh the board's node/config data in order for the game to appear on your
  149.   BBS's menus immediately.  You can do this by hitting the stop button then the
  150.   play button on the Synchronet telnet server.
  151.  
  152.  
  153. WildCat Winserver:
  154. ----------------- 
  155.   You must run Tournament Trivia through a batch file.  Copy WCTRIV.BAT from
  156.   your Tournament Trivia directory and place it wherever you normally put door
  157.   batch files. Then, edit it as directed in the batch file's comments. 
  158.  
  159.   Then, configure your BBS to run the door as "Door32 Compatible" for Door 
  160.   Type, and "WCTRIV.BAT" for the Batch File.  Be sure to enable the Multiuser
  161.   toggle option.
  162.  
  163.   IMPORTANT:  This door directly interfaces with Winserver's DOOR32.DLL file
  164.   to provide native Winserver door support.  It is vital that the door is able
  165.   to find this file.  Please determine which of your directories contains this
  166.   file (probably your \wc5 directory), and then add this directory to your 
  167.   system's path if it isn't already there:   
  168.  
  169.     Windows 95/98/ME:  You can add a directory to your system path by
  170.                        modifying AUTOEXEC.BAT.  You will then have to reboot
  171.                        your system in order for the change to take effect.
  172.  
  173.     Windows NT/2K/XP:  Use the Control Panel to modify your system path.
  174.                        Please see Control Panel >> System >> Advanced >> 
  175.                        Environmental Variables >> System Variables >> Path.
  176.  
  177.   An alternative option (if you don't know how to edit your path) is to 
  178.   simply place a copy of WildCat's DOOR32.DLL file in Tournament Trivia's 
  179.   directory.  This should work fine, but is not recommended for upgrade 
  180.   reasons, since DOOR32.DLL could change in future versions of Winserver.
  181.  
  182.  
  183. Mystic BBS:                                                              
  184. ----------
  185.   Assuming c:\doors\trivia is your Tournament Trivia directory, and c:\mystic
  186.   is your Mystic directory, use a command line of:
  187.     
  188.      c:\doors\trivia\triv32.exe /n %3 /d c:\mystic\temp%3
  189.  
  190.   Set the menu command type to "D3  Door with DOOR32.SYS".
  191.  
  192.   IMPORTANT:  The original release of Mystic v1.07 had a bug that prevents 
  193.   Door32 games from working properly.  You must have Mystic v1.07.2 or later
  194.   in order for this door to run.
  195.  
  196.   WINDOWS 95/98/ME:  Do *NOT* use a batch file to call this door.  Doing so 
  197.   will not work on these operating systems.  The door switches to its own
  198.   directory upon start-up anyway; there is no need for a batch file!
  199.  
  200.  
  201. EleBBS:
  202. ------
  203.   Assuming c:\doors\trivia is your Tournament Trivia directory, and c:\ele is
  204.   your EleBBS directory, use a command line of:
  205.  
  206.      c:\doors\trivia\triv32.exe -n *N -d c:\ele\NODE*N\door32.sys -socket *W
  207.  
  208.   In order for this door to work properly, you may need to lower the value for
  209.   Modem >> Telnet >> Start Node# in ELCONFIG, since this door does not support
  210.   node numbers higher than 99.  
  211.  
  212.   WINDOWS 95/98/ME:  Do *NOT* use a batch file to call this door.  Doing so 
  213.   will not work on these operating systems.  The door switches to its own
  214.   directory upon start-up anyway; thus there is no need for a batch file!
  215.  
  216.  
  217.  
  218. MannSoft GameSrv:
  219. ----------------
  220.   In GameSrv, go to the Games tab and press Add.  
  221.   Assuming Tournament Trivia is in c:\bbs\trivia and GameSrv is in 
  222.   c:\bbs, you should use the following command line: 
  223.   
  224.      c:\bbs\trivia\triv32.exe /n *N /d c:\bbs\node*N /socket *H 
  225.  
  226.   For the FOSSIL setting, select "None".  Tournament Trivia uses Door32.sys,
  227.   so it doesn't need (and can't use) a FOSSIL driver.
  228.  
  229.  
  230.  
  231. ==============================================================================
  232.  
  233.  
  234. 2. Configuration Options
  235. ~~~~~~~~~~~~~~~~~~~~~~~~
  236. The game has a special "config" command that is usable to change the game's
  237. settings.  This command is available only to sysops, not to ordinary users.
  238. In order for the game to recognize you as a sysop, you can do one of the 
  239. following:
  240.  
  241.   - Enter the door in local mode ("triv32.exe -l"). In local mode, you are
  242.     able to use the "config" command. You can also grant sysop access to a 
  243.     specific user account, by using "triv32.exe -l -username xxx" where xxx is
  244.     the real name of the player.  
  245.  
  246.   - In the Synchronet version of the door, the game reads the user's Security
  247.     Level from the dropfile.  Any user with 90+ security in Synchronet is
  248.     considered a Sysop in the door.
  249.  
  250.  
  251. To enter the game configuration menu, type "config" from any game prompt.  From
  252. this menu, you can change the following game settings:
  253.  
  254. [F] Question Frequency 
  255.        This setting determines how long an unanswered question remains before
  256.        it is replaced with a new question.  (Default: 50 seconds)
  257.  
  258. [M] Maximum number of clues
  259.        This setting determines the maximum number of clues that may be
  260.        displayed for a question.  The actual number of clues may be lower 
  261.        than this value, since clues stop being displayed if most of the
  262.        answer is already filled in.  (Default: 3 clues)
  263.  
  264. [S] Show sysops on score list
  265.        If set to "no", players with sysop access will not be listed on the
  266.        score list. (Default: yes -- sysops ARE listed along with normal
  267.        players)
  268.  
  269. [#] Question File 
  270.        This setting allows you to configure what question files are used
  271.        by Tournament Trivia.  By default, the only question files used are
  272.        DATABASE.ENC and CUSTOM.TXT; you can add up to eight other files.
  273.        Modifying CUSTOM.TXT and/or creating your own custom question files
  274.        is easy; please see Section 3 of this document for more information.
  275.        In the near future, you will also be able to download third-party
  276.        question files.  
  277.  
  278.  
  279.  
  280. ==============================================================================
  281.  
  282.  
  283. 3. Adding More Questions
  284. ~~~~~~~~~~~~~~~~~~~~~~~~
  285.  
  286. Default question file:
  287.   The game's stock question database is DATABASE.ENC.  The copy of DATABASE.ENC
  288.   that comes with Tournament Trivia v1.0 contains about 800 questions.  Newer,
  289.   larger versions of DATABASE.ENC are regularly released on-line at
  290.   http://trivia.doormud.com/sysop.html -- each new release of the file increases
  291.   the size of the database, adding many new questions.
  292.  
  293.   Please note that in the unregistered version of Tournament Trivia, only 400 
  294.   questions from DATABASE.ENC are made available to players.  
  295.  
  296.  
  297. Using third-party question files:
  298.   Several new question files from third-party sources will soon be available
  299.   for Tournament Trivia.  You can freely download these files and add them to
  300.   your game via the "config" command (see Section 2 of these docs, above).
  301.   Links to third-party question files will be available on-line at 
  302.   http://trivia.doormud.com/sysop.html in the near future.
  303.  
  304.   In the unregistered version of Tournament Trivia, only 150 total questions
  305.   from third party files (and/or custom question files) are made available
  306.   to players.
  307.  
  308.  
  309. Adding custom questions:
  310.   Adding your own custom questions is easy; see CUSTOM.TXT as an example of
  311.   some BBS-related custom trivia questions.  With a text editor, simply add
  312.   new questions into CUSTOM.TXT, having question lines alternate with answer
  313.   lines. Be sure to press <ENTER> at the end of each question or answer, and
  314.   ONLY at the end. It is recommended that you use a quality text editor like 
  315.   TextPad or EditPad, ie, one that displays line numbers and has an option to
  316.   *disable word wrap*. With these settings, questions should always be on odd
  317.   line numbers, and answers on even line numbers.
  318.   
  319.   Questions are limited to 160 characters, and answers are limited to 80
  320.   characters.
  321.   
  322.   After adding questions, if you notice the game acting strangely (displaying
  323.   answers instead of questions), it means one of your custom question files
  324.   has an <ENTER> line in an incorrect spot, and/or there's a question exceeding
  325.   160 characters, and/or there's an answer exceeding 80 characters.  Please 
  326.   verify that your custom files conform to the correct line formatting.
  327.  
  328.  
  329. ==============================================================================
  330.  
  331.  
  332. 4. Registration
  333. ~~~~~~~~~~~~~~~
  334.  
  335. Tournament Trivia is shareware.  There are limitations on the number of
  336. questions in the game if your copy is unregistered: 
  337.  - Only 400 questions from the game's standard question database are made 
  338.    available to players.  
  339.  - If you choose to add additional custom question files and/or third-party
  340.    question files, only 150 total questions from these sources will be used.
  341.  
  342. If you register the door, these question limits are removed.  The full version
  343. of the door has 800+ questions in its standard database, and you can add any
  344. number of additional questions through third-party question files and/or custom
  345. question files.
  346.  
  347.  
  348. Registration for Tournament Trivia normally costs $12 (US dollars).  However,
  349. you can register the game at a discounted rate if you have submitted new trivia
  350. questions for the game:
  351.  
  352. # of acceptable     | Registration
  353. questions submitted | Cost
  354. --------------------|-------------
  355. None (full price)   |  $12
  356. 10  questions       |  $10
  357. 20  questions       |  $8
  358. 40  questions       |  $5
  359. 80+ questions       |  FREE
  360.  
  361. For more information, please see the on-line question submission page:
  362.   ->  http://trivia.doormud.com/submit.html
  363. To check how many acceptable questions you have already submitted, please see:
  364.   ->  http://trivia.doormud.com/helplist.html
  365. Discounted rates are subject to change; please see the question submission
  366. page for up-to-date rates.
  367.  
  368.  
  369. HOW TO REGISTER ON-LINE:
  370. Registering on-line is the fastest and most convenient method to purchase
  371. Tournament Trivia.  You can pay via credit card or PayPal transfer.  For more
  372. information about how to register on-line, please see:
  373.   ->  http://trivia.doormud.com/register.html
  374.  
  375.  
  376. HOW TO REGISTER BY POSTAL MAIL:
  377. 1.  Print and fill out the registration form (REGISTER.TXT).  If you do not
  378.     have a printer, you may handwrite the information.  
  379. 2.  Include a check or money order for $12 US, or less if you have a discount.
  380.     If using a check, make it payable to "Evan Elias".  (If you qualify for a
  381.     free registration, you may skip this step!)
  382. 3.  E-mail RhythmNp@aol.com and inquire about the current registration mailing
  383.     address. Put the payment and registration form in an envelope and mail it 
  384.     to the provided address.
  385.  
  386.  
  387. ==============================================================================
  388.  
  389.  
  390. 5. Miscellaneous
  391. ~~~~~~~~~~~~~~~~
  392.  
  393. Notes on the Synchronet version (TRIVSYNC.EXE)
  394.   - By default, the Synchronet version of Tournament Trivia does not create
  395.     a local display window.  This feature is intentional, to reduce taskbar
  396.     clutter.  If you would prefer to have a local display window, a /window
  397.     command line option is available.
  398.   - The Synchronet-specific version of this game, trivsync.exe, does not 
  399.     support local mode play.  To play in local mode, run the door32 exe's 
  400.     local mode, "triv32.exe /l".
  401.  
  402.  
  403. Notes on the DOOR32 version (TRIV32.EXE)
  404.   - This version provides an interactive local display window by default.
  405.     The window automatically starts as minimized, unless you are running the
  406.     door in local mode.  If desired, you can eliminate the window entirely 
  407.     by using the /silent command line option.
  408.   - This version of Tournament Trivia supports several command line options:
  409.        /D or /DROPFILE  - Door information file directory and/or filename.
  410.        /N or /NODE      - Sets the node number to use.  
  411.        /SOCKET x        - Needed in EleBBS and GameSrv to specify the socket.
  412.        /L or /LOCAL     - Causes door to operate in local mode, without 
  413.                           requiring a door information (drop) file.  
  414.        /USERNAME        - Use in local mode to specify your user name.
  415.        /SILENT          - Operate in silent mode, with no local display window.
  416.        /GRAPHICS        - Unless followed by 0 or N, turns on ANSI mode.
  417.                           Useful if, for whatever reason, the game is not 
  418.                           detecting users' ANSI settings properly.
  419.  
  420.  
  421. Known issues/bugs in this version:
  422.   - If the nodes of your BBS are spread across multiple Windows computers via
  423.     a LAN, this door might not function properly.  An example would be if you
  424.     have one computer serve nodes 1 to 10 and have another, separate networked
  425.     computer serve nodes 11 through 20, using a shared drive for the BBS.  
  426.     Setups like this are pretty rare for a BBS, but if you are using one, 
  427.     please e-mail RhythmNp@aol.com for more info on the problem.
  428.  
  429.   - You cannot install multiple, separate copies of Tournament Trivia on the 
  430.     same BBS. This will be fixed in a future release.
  431.  
  432.   - When running the door in Local Mode, on some systems, the user name that
  433.     you enter in the dialog box is ignored and your user name will instead
  434.     always come up as "sysop".  This is a bug in the doorkit used to create
  435.     the game; it will be fixed in the next release.  For now, to avoid the
  436.     problem you can use the /username command line option, ie 
  437.     "triv32.exe /l /username John Doe", to use a different local user name.
  438.  
  439.   - On Wildcat Winserver, if a user drops carrier while in the door, it may 
  440.     lock the node and temporarily prevent the user from re-logging on.  This
  441.     problem cannot be fixed at the present time, because it is caused by a
  442.     doorkit flaw.  If/when a new C++ doorkit with Winserver support is
  443.     available, this problem will be fixed.
  444.  
  445.  
  446. Support:
  447. -=-=-=- 
  448. Please consult one of the following sources if you are having difficulty setting
  449. up the game or if you have any questions, comments, ideas, etc --
  450.  
  451.  - Visit the official webpage:       http://trivia.doormud.com
  452.  - E-mail the game's programmer:     RhythmNp@aol.com
  453.  
  454.  
  455.  
  456. Thank You's:
  457. -=-=-=-=-=-
  458. Web Hosting       -- Allied WebProducts (www.awphosting.com)
  459. 32-bit Doorkits   -- Rob Swindell and Brian Pirie
  460.  
  461. Also a huge thanks to all the sysops and players who beta-tested this game
  462. and submitted trivia questions!
  463.  
  464.  
  465. <End of file>