home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 12 / CD_ASCQ_12_0294.iso / vrac / king814u.zip / KING.DOC < prev    next >
Text File  |  1993-12-06  |  19KB  |  419 lines
  1.                              King of the Board
  2.                Copyrighted June 1988,1989,1990,1991,1992,1993
  3.                    By Chuck Valecek - Suburban Software
  4.                                Version 8.13
  5.                              December 6, 1993
  6.  
  7. BACKGROUND
  8.  
  9.     King of the Board started about a 6 years ago as a Door written in 
  10. QuickBasic, and incorporated Door routines in DOORPATCH. Since then, 
  11. it has been modified from version 1.0 through 5.4 with suggestions 
  12. by users and Sysops. It has become very popular with PCBoards all 
  13. over the country and very popular with the users.
  14.  
  15.     The 7.0 was the first official release of the door which was completly
  16. rewritten using Turbo Pascal and ProKit Door routines. This will, I hope,
  17. satisfy those Sysops who wanted to use the door but could not, due to
  18. the newer modem speeds and system incompatibilities.
  19.  
  20.     Since the version 7 release there have been quite a few sysops that are
  21. running the door under BBS software other than PCBoard. This was a real task
  22. since the door required PCBoard files. There were converters to create the
  23. files but some sysops still had problems getting the DOOR to run correctly.
  24.  
  25.     Introducing version 8.0. This version is a complete rewrite of the 7.0
  26. version. This time it supports MOST major brands of BBS Software. A list of
  27. the supported Systems are described later in this file.
  28.  
  29. FILES
  30.  
  31. The following files are either included in the package or created by the door.
  32.  
  33. KINGxxx.EXE  The door program itself (xxx would be the version number)
  34. QUESTION.DAT Question file (included)
  35. NEXTQUES.DAT Next question (created by the door)
  36. NEW_QUES.DAT New questions entered by the users (created by the door)
  37. KOBUTLxx.EXE Utility program to list users etc (included)
  38. KING.CFG     Sample config file
  39. KINGxxx      Sample batch file
  40. KING.LOG     Optional log file (created by the door)
  41. KING.HLP     Help file
  42. KINGP.HLP    Help file if using the Point version.
  43. KOBG.DAT     Sign on screen for King - Color Version
  44. QOBG.DAT     Sign on screen for Queen - Color Version
  45. KOB.DAT      Sign on screen for King - No Color
  46. QOB.DAT      Sign on screen for Queen - No Color
  47. ADOPT.DAT    Sample of a Adopt-a-door screen that can be used - No Color
  48. ADOPTG.DAT   Sample of a Adopt-a-door screen that can be used - Color
  49.  
  50.  
  51. THE DOOR
  52.  
  53.     King is a trivia game in which users try to make it up the pyramid
  54. to the top. To accomplish this, the user must challenge another user 
  55. in a position above him. The user is asked a question and if he gets 
  56. it right he changes places with the user he challenged. It's a quick 
  57. game and won't tie up your board as some games do, because the user is 
  58. asked only one question and is allowed only one play per day. He may 
  59. call back tomorrow and find himself back were he was or even further
  60. down the pyramid. If the user is beyond the playing grid (only 28 
  61. users on the grid) he can challenge only the 26th, 27th, and 28th 
  62. positions. If he is on the grid he can only challenge one of the next 
  63. three players. After the player has a turn he is asked if he would 
  64. like to enter a qustion into the game. These questions are placed in 
  65. a hold file for the sysop to review and merge into the question 
  66. file. Each time a user calls in the question is changed. The program 
  67. reads the question file sequentially so the more questions in the 
  68. file the less chance the user will get a repeat. The sysop also has 
  69. the option to limit the number of chances the user gets to answer 
  70. correctly. I use 3 and it seems to work out just fine. One sysop, I 
  71. won't mention his name, changes the number of chances, so his users 
  72. never know how many tries they get. The format of the question is 
  73. shown to the user. All alpha characters are replaced with a *, all 
  74. digits are replaced with a N and special characters (!@#$$%) are 
  75. shown as is. After each guess the user is prompted to see if he 
  76. would like to try again. If so, the correct letters are replaced so 
  77. as to give him a hint. This helps if the user is unsure of the 
  78. correct spelling. Only letters that are in the correct position are 
  79. replaced.
  80.  
  81.  
  82.    There is an option that allows the sysop to choose whether he 
  83. wants the game to use a point system. The point system assigns a 
  84. point value to the person being challenged. The points are assigned 
  85. as follows: A person 3 positions above the player is worth 2500 
  86. points. A person 2 positions above the player is worth 2000 points. 
  87. A person 1 position above the player is worth 1500 points.
  88.  
  89. If the player answers the question incorrectly the person he 
  90. challenged gets a bonus of 500 points.
  91.  
  92. If you choose to set the point option, an extra bulletin file will be created 
  93. by the door which will contain the point standings. This will only 
  94. appear if the point option is set. The user will also be asked if he 
  95. would like to review the file before the door terminates. If you 
  96. wish, this file could be copied over as a bulletin in the door batch 
  97. file.
  98.  
  99.  
  100.  
  101.    That's about it for the door operation. It's simple yet fun!
  102.  
  103. SETUP
  104.  
  105.     Most of you out there are familiar with the setup of a door. This door 
  106. follows the standard setup of Doors.
  107.  
  108.  
  109. Since the config file has gotten so large, I have incorporated a configuration
  110. option in the KOBUTLxx.EXE. It will allow you to edit or create the config file
  111. through a series of prompts. Answer the prompts and a config file will be
  112. created. You can always rerun the program to create another file or edit your
  113. existing config file. 
  114.  
  115. If you are a previous registered sysop of King of the Board your old 
  116. registration number will work with this door.
  117.  
  118.  
  119. And you thought it was hard!
  120.  
  121. Okay, now to set up a batch file for the door to run. Remember this is just like
  122. any other batch file except there is no ".BAT" extension.
  123.  
  124. The standard DOOR script for ProKit doors has this format:
  125.      echo off
  126.      cd \king
  127.      KINGxxx KINGxxx.CFG 
  128.      cd \pcb
  129.      board
  130.  There is nothing else required in this batch file.
  131.  
  132.  
  133. UTILITIES
  134.  
  135. Okay, now to the new Sysops. There is a program called KOBUTLxx.EXE. This 
  136. utility will display the users file, print the users file, Purge users from the users
  137. file, Verify the question file (explained later), Merge the new questions into
  138. the question file, Create a TEXT file from the question file for editing and
  139. rebuild the question file from a TEXT file. Since the question file is a
  140. encrypted file it may look like gibberish to you. Choosing the option
  141. Convert to text will allow you to use any text type editor and edit the questions
  142. or answers, and then rebuild the question file. All the options are 
  143. in LOTUS type menus. Select the option with the arrow keys and press 
  144. return.
  145.  
  146.     The questions entered by the users go into a file called NEW_QUES.DAT.
  147. This is a standard text file and can be edited with any text editor. Edit this
  148. file before merging the new questions into the question file.
  149. The format of the data is question,answer,user. That is the question followed
  150. by a comma followed by the answer followed by a comma followed by the username.
  151. As of this release all three (3) fields must be present.
  152.  
  153.  
  154.     If you convert the question file into a text file, the first line will be 
  155. the number of questions in the file. Example: 1147,0. There is no need to change 
  156. this record. Leave as it is the KOBUTLxx will place the correct number of 
  157. questions in the first record. Why this record? The door creates a file called
  158. NEXTQUES.DAT that contains the number of the next question. If this number
  159. exceeds the number of questions it will reset to 2 allowing the first question
  160. to be asked. In future release this may be removed and a editor built into the
  161. KINGUTIL to accomodate editing of the questions. But for now this is the way
  162. it has to be.
  163.     
  164.     PLEASE edit your new question file!!! I have had users call me long
  165. distance to complain that they lost because of a word was entered incorrectly.
  166. This is not MY problem. It's up to you to insure that the answers are correct.
  167.  
  168.     I believe I have tried to cover most of the requirements of the programs.
  169. Sample config files, batch files and questions have been included in the 
  170. package.
  171.  
  172.  
  173.  
  174. Conversion:
  175.  
  176. If you are running a version prior to 8.00 then I would suggest starting over.
  177.  
  178. If you are running a version prior to 8.07, use the CONVCFG.EXE program. Or
  179. run KOBUTLxx.EXE and edit your configuration file. There have been lines added
  180. to the file.
  181.  
  182.  
  183. KOBUTLxx.EXE will allow you to create a new config file or you may edit your
  184. old one the choice is yours.
  185.  
  186. YOU MUST RUN THIS AS SOME OPTIONS HAVE CHANGED OR ADDED.
  187.  
  188. If you get a error from the door when it executes then the CFG file was not
  189. updated for this version of the door.
  190.  
  191. The KOBUTLxx.EXE is all new so before you use any of the options make sure that
  192. the KING.USR and QUESTION.DAT file are properly backed up.
  193.  
  194.  
  195. I would recommend to all PCBoard Sysops to use the USERS.SYS file instead
  196. of the PCBOARD.SYS file. To do this go into PCBSETUP Main Conference setup.
  197. Go into the DOORS.DAT file and select the USERS.SYS file in the door setup.
  198.  
  199.  
  200.  
  201. MULTINODE SETUP NOTES:
  202.  
  203. If your are running multinodes on one machine, you are shelling out to the
  204. door in different directories like PCB and PCB2. The DOOR supports the PCBOARD
  205. variables PCBDRIVE and PCBDIR. So instead of having multiple configuration files
  206. you can set the above variables and the DOOR will substitute then in the 
  207. configuration file.
  208. Example: SET PCBDRIVE= D:
  209.          SET PCBDIR=\PCB2
  210.  
  211. Then the line %PCBDRIVE%%PCBDIR%\DOOR.SYS would be converted to
  212.               D:\PCB2\DOOR.SYS
  213.  
  214.  
  215. GENERAL CONFIGURATION EXAMPLES
  216.  
  217.         EXAMPLE CONFIGURATION FILE FOR PCBOARD.SYS
  218.         ------------------------------------------
  219.  
  220.         C:\PCB\PCBOARD.SYS       <=-  (Full pathname of your PCBOARD.SYS file)
  221.         Suburban Software        <=-  (Change this to your BBS name)
  222.         Chuck                    <=-  (The Sysop's first name)
  223.         Valecek                  <=-  (The Sysop's last name)
  224.  
  225.         EXAMPLE CONFIGURATION FILE FOR USERS.SYS
  226.         ------------------------------------------
  227.  
  228.         C:\PCB\USERS.SYS         <=-  (Full pathname of your USERS.SYS file)
  229.         Suburban Software        <=-  (Change this to your BBS name)
  230.         Chuck                    <=-  (The Sysop's first name)
  231.         Valecek                  <=-  (The Sysop's last name)
  232.  
  233.         EXAMPLE CONFIGURATION FILE FOR DOOR.SYS
  234.         ---------------------------------------
  235.  
  236.         C:\BBS\DOOR.SYS          <=-  (Full pathname of your DOOR.SYS file)
  237.         Suburban Software        <=-  (Change this to your BBS name)
  238.         Chuck                    <=-  (The Sysop's first name)
  239.         Valecek                  <=-  (The Sysop's last name)
  240.  
  241.         EXAMPLE CONFIGURATION FILE FOR CALLINFO.BBS
  242.         -------------------------------------------
  243.  
  244.         C:\BBS\CALLINFO.BBS      <=-  (Full pathname of your CALLINFO.BBS file)
  245.         Suburban Software        <=-  (Change this to your BBS name)
  246.         Chuck                    <=-  (The Sysop's first name)
  247.         Valecek                  <=-  (The Sysop's last name)
  248.  
  249.         EXAMPLE CONFIGURATION FILE FOR DORINFOx.DEF
  250.         -------------------------------------------
  251.  
  252.         C:\BBS\DORINFOx.DEF      <=-  (Full pathname of your DORINFOx.DEF file
  253.                                   where 'x' is the BBS Node number.
  254.         Suburban Software        <=-  (Change this to your BBS name)
  255.         Chuck                    <=-  (The Sysop's first name)
  256.         Valecek                  <=-  (The Sysop's last name)
  257.  
  258.         EXAMPLE CONFIGURATION FILE FOR SFDOORS.DAT
  259.         ------------------------------------------
  260.  
  261.         C:\BBS\SFDOORS.DAT       <=-  (Full pathname of your SFDOORS.DAT file)
  262.         Suburban Software        <=-  (Change this to your BBS name)
  263.         Chuck                    <=-  (The Sysop's first name)
  264.         Valecek                  <=-  (The Sysop's last name)
  265.  
  266.         EXAMPLE CONFIGURATION FILE FOR CHAIN.TXT
  267.         ----------------------------------------
  268.  
  269.         C:\BBS\CHAIN.TXT        <=-  (Full pathname of your CHAIN.TXT file)
  270.         Suburban Software       <=-  (Change this to your BBS name)
  271.         Chuck                   <=-  (The Sysop's first name)
  272.         Valecek                 <=-  (The Sysop's last name)
  273.  
  274.  
  275. NOTE: This Door supports COM 1-15 on the standard IRQ's - COM1/COM3 = IRQ4 and
  276.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  277.       number after the configuration filename. Let's assume your Door is
  278.       called KING and you want to use COM1 and IRQ5. The command line
  279.       passed to your Door would be:
  280.         KING KING.CFG /5
  281.         or  KING KING.CFG /%IRQ%  for the environment variable.
  282.       The /5 tells the Door to use IRQ5 rather than the standard IRQ4 that
  283.       is normally used with COM1. No /x parameter is needed for the standard
  284.       IRQ's.
  285.  
  286.       NOTE: You may also use the * instead of the / when specifying a 
  287.       non-standard comm port, Example: *5 or *%IRQ% 
  288.  
  289.  
  290. Fossil Driver Support
  291. ---------------------
  292. KING supports the use of Fossil drivers.  To tell the Door to use the Fossil
  293. driver instead of the standard COM ports, just put /FD on the command
  294. line when running the door. For example:
  295.      KING KING.CFG  /FD
  296. indicates that a Fossil driver is present and should be used. If no Fossil
  297. driver is detected, DoorFrame will print a message to that effect and exit
  298. the door gracefully.
  299.                    
  300.  
  301. FORCING ANSI ON
  302. ---------------
  303. If you are experiencing diffulcties with the door detecting ANSI use a command
  304. line option /NA to force ANSI on.
  305.  
  306.                               ==============
  307.                      ------------------------------------
  308.  
  309.                                 DOOR OPERATION
  310.                                 --------------
  311.   
  312.   F3    -   Toggles the printer On/Off.
  313.             Value is passed to PCBoard.
  314.   F4    -   Toggles the Page Bell On/Off.
  315.             Value is passed to PCBoard.
  316.   F5    -   DOS Shell.  Allows SysOp to exit to DOS from inside a DOOR.
  317.   F7    -   Toggles the Caller Alarm On/Off.
  318.             Value is passed to PCBoard.
  319.   F8    -   Returns the caller involuntarily to PCBoard.
  320.             Without letting them know that the sysop called them back!
  321.   F9    -   Toggles the local display On/Off.
  322.             Value is passed to PCBoard.
  323.   F10   -   Activates SysOp CHAT mode within the DOOR.
  324.  
  325.   ESC   -   Deactivates CHAT mode.  DOOR is resumed.
  326.   HOME  -   HELP key for status line options.
  327.   UP    -   Allows the SysOp to temporarily give the caller extra time
  328.             while in the DOOR.  This time is NOT passed to PCBoard.
  329.   DN    -   Allows the SysOp to temporarily subtract time from the
  330.             caller while in the DOOR.  This time is NOT passed to PCBoard.
  331.   ALT-N -   SysOp next on toggle.
  332.             Value is passed to PCBoard.
  333.   ALT-X -   PCBoard will exit after current caller logs off.
  334.             Value is passed to PCBoard.
  335.  
  336.                             WATCHDOG/CTTY/ANSI.SYS
  337.                             ----------------------
  338.  
  339.         CTTY and WATCHDOG are not required and should not be used with
  340.         this program.  The Door contains its own communication routines
  341.         which monitor the COM port.  If carrier is lost, it will return
  342.         to system where the BBS will log the user off the system.
  343.         ANSI.SYS, or something similar, is required for the door to
  344.         function properly!
  345.  
  346. BUG Reports
  347.     If you are having a problem please let me know but when you do I need to
  348. know some information about your system setup. What type of BBS software,
  349. running under any multitaskers, lans, non-standard com ports or non-standard
  350. IRQ's. n what exactly is the door doing or not doing. If possible send me
  351. the files associated with the doors except for the EXE files.
  352.  
  353. Thats it for now
  354.  
  355.     I would like to take a few lines and thank those who made this 
  356. door possible: Clark Development for writing the BEST BBS program 
  357. out, Ted Freeman for doing such a GREAT job on the routines used in 
  358. this door, Rest in Peace Ted, and to all of you that have taken the time to
  359. register the door and have added suggestions to the door. 
  360.  
  361.     And a special Thanks to Howard Hartman of Network East, Heather Broadhurst 
  362. for the edited question file, Israel Silverman, Sysop of The Round Table BBS
  363. for editing this doc file so it is more "readable" and to all the sysops who 
  364. have help me test the beta release and for thier suggestions.
  365.  
  366.    If you have an idea that you would like to see turn into a door. Drop me a 
  367. line and we can discuss your ideas. And maybe turn it into a door!!
  368.  
  369.  
  370. REGISTRATION
  371.  
  372.     If you wish to register the door it would be greatly appreciated. For a
  373. mere $20.00 you can get rid of that stupid message <EVALUATION COPY> and
  374.  
  375.     $$$$ Please help the sysop Register this door $$$ 
  376.    
  377.     I will contact you by BBS or mail you the latest version of the door along
  378. with a registration number. This number will turn off the messages and allow
  379. your BBS name to be displayed on the opening and closing screens. As I stated 
  380. before this door is not Crippled in any way or form and will run forever even
  381. if you did not register it. All monies received go back to other Door Authors
  382. for their doors that run on my system.
  383.  
  384.    I always have a open door for sysops on my board. Sign in and go into my
  385. Support Confrence and you will find the latest version of my doors there
  386. for downloading.
  387.  
  388.     Please if you have a problem with setting it up or find a bug (?) Don't 
  389. call Salt Air and gripe about it, call my board and you will get a FASTER
  390. response. I know there are some Sysops out there that can vouch for this. I
  391. called many Sysops voice and tried to help them out at my expense, even before
  392. they registered the door.
  393.  
  394.     If you are a Author of a door and want to exchange registered copies let
  395. me know. We can work out something!! I may even throw my kids into the deal!
  396.  
  397. OH! One more thing. If you have any suggestions, please drop me a line. Please
  398. direct all complaints about the door to my wife, I am trying to get even with
  399. here!!!
  400.  
  401. All the changes to the door in the past years have been suggestions made by 
  402. sysops who have registered the door. I will review all suggestions and if they
  403. have any merit I will incorporate them in the next release or so. If time
  404. permits I will compile a list of suggestions that have not yet made it into 
  405. the code for you to review and voice your opinion on.
  406.  
  407. Okay here is the address to send the MILLIONS!!
  408.  
  409. Chuck Valecek
  410. Suburban Software
  411. P. O. Box 368
  412. Oak Lawn, IL 60454
  413.  
  414. (708)-636-6694 (Node 1) (708)-636-6697 (Node 2) USR HST 19200
  415.  
  416. Oh! Please make the checks or money order payable to me NOT
  417. Suburban Software. Believe it or not my bank won't cash them unless I open a 
  418. business account.
  419.