home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / w / wof49.zip / WHEEL.DOC < prev    next >
Text File  |  1993-03-03  |  24KB  |  513 lines
  1.  
  2.                             WHEEL of FORTUNE
  3.  
  4.                                   v4.9
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                        (404) 256-9525 (2400-19.2)
  12.                        (404) 705-9104 (2400)
  13.                        (404) 256-9518 (VOICE, 9am-9:30pm EST)
  14.  
  15.  
  16.  
  17.                                 OVERVIEW
  18.                                 ________
  19.  
  20.  
  21.    Wheel of Fortune is an adaptation of the very popular TV game show.
  22.    The game is played almost exactly the same, however, you will have to
  23.    use your imagination when it comes to who is turning the letters on
  24.    the board. I can assure you that Vanna is not doing the turning. The
  25.    game has a SAVE feature which allows the caller to quit the game and
  26.    pick up where they left off, when the caller next chooses the door.
  27.  
  28.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  29.          created in the directory you run the door from.
  30.  
  31.  
  32.                               INSTALLATION
  33.                               ____________
  34.  
  35.  
  36.    Installation is fairly easy and straight-forward. The following steps and
  37.    examples should have you up and running in a very short period of time.
  38.    It is assumed that you are familiar with setting up DOORS on your system.
  39.    To this end, only examples of the configuration file and Door batch file
  40.    are described.
  41.  
  42.       1) Create a directory to hold all WHEEL of FORTUNE files.
  43.  
  44.       2) Unzip WOFxx.ZIP into the the above directory.
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied WHEEL.CFG file. A description follows:
  48.  
  49.             **                       Location of System FIle (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First Name
  52.             Lawrence                 Sysop's Last name
  53.  
  54. |-----------------------------------------------------------------------------|
  55. | READ!     1                        CommPort  \ These 2 lines are required   |
  56. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  57. |-----------------------------------------------------------------------------|
  58.  
  59.             00000000                 Registration Number
  60.  
  61.             50                       Number of entries in the Top Score file
  62.                                      Minimum=10, Maximum=50, Default=50
  63.  
  64.             20                       Number of puzzles each player has to solve.
  65.                                      Minimum=10, Maximum=50, Default=20
  66.  
  67.  
  68.         #   7                        NUMBER of chances given to solve each
  69.                                      puzzle. A wrong letter choice, landing
  70.                                      on "LOSE TURN" or "BANKRUPT" reduces
  71.                                      this variable by 1. When it reaches 0
  72.                                      the caller receives 100 pts, whether
  73.                                      caller has accumulateed more or not,
  74.                                      and they move on to the next puzzle.
  75.                                      This is the default!
  76.                                                     - or -
  77.  
  78.                                      LEVELS - allows caller to select a level
  79.                                      of difficulty. There are 4 levels and each
  80.                                      level carries a different number of chances
  81.                                      & a sliding percentage of the wheel points
  82.                                      caller will accumulate.
  83.  
  84.             2                        The number of players that must complete
  85.                                      all puzzles, before the puzzles are
  86.                                      changed automatically by WOFMAINT, usually
  87.                                      in your nightly event processing.
  88.  
  89.        #    3                        Number of puzzles the caller is allowed
  90.                                      to play per day.
  91.                                      (Sysop is unlimited in registered version!)
  92.  
  93.        #    NONE                     Full drive:\path\filename for Top Score
  94.                                      Bulletin, or NONE
  95.  
  96.        #    NONE                     Full drive:\path\filename for Hall of
  97.                                      Fame Bulletin, or NONE
  98.  
  99.             2                        1 = Do Not Display ADOPT-A-DOOR Message
  100.                                      2 = Display ADOPT-A-DOOR Message
  101.  
  102.  
  103.         #   2                        Keyboard Timeout Value in Minutes.
  104.                                      If key not depressed for "value" minutes
  105.                                      then game is saved. Minimum = 2 minutes
  106.  
  107.         #   N                        Y = Allow callers to add Puzzles
  108.                                      N = Do not allow callers to add Puzzles.
  109.                                      (See 'Caller Supplied Puzzles' below)
  110.  
  111.             12000                    Value used to dictate the speed the
  112.                                      wheel will spin. Since I run on a 286/12
  113.                                      I have determined that a value of 12000
  114.                                      performs well. For an 8088 CPU you would
  115.                                      lower the value and for a faster CPU you
  116.                                      would raise the value (range: 1000-15000)
  117.                                      If you find the optimum value for a
  118.                                      specific machine type, please share it
  119.                                      on the support board or thru any Sysop
  120.                                      or BBS_Door echo you have access to!
  121.  
  122.         #   Y                        Y = Allow Sysop to play as many games as
  123.                                          there are questions
  124.                                      N = Sysop just like a regular player
  125.  
  126.     @   #   XXXX/YYYY                 Blackout Range  From/To
  127.     @   #   XXXX/YYYY                 Blackout Range  From/To
  128.     @   #   XXXX/YYYY                 Blackout Range  From/To
  129.     @   #   XXXX/YYYY                 Blackout Range  From/To
  130.     @   #   XXXX/YYYY                 Blackout Range  From/To
  131.  
  132.          ** = Replace with ONE of the following:
  133.  
  134. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  135. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  136. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  137.                                    (Note:DOOR.SYS must be in SAME directory)
  138. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  139. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  140. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  141. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  142. C:\BBS\CHAIN.TXT                <- For WWIV systems
  143. C:\BBS\GTUSER.BBS               <- For GT Power
  144.                                    * if using this option you must put the
  145.                                      ComPort # on line 5 and the Node # on
  146.                                      line 6 of the configuration file
  147.  
  148.  
  149.  
  150.          # =  Requires registration to change to a different value
  151.          @ =  See "Blackout Periods" Below
  152.  
  153.  
  154.               NOTE:THERE ARE TO BE NO BLANK LINES IN THIS FILE !
  155.  
  156.       4) Run WOFMAINT WHEEL.CFG (or name you gave to config file)
  157.  
  158.           ********************* To Setup Program ****************************
  159.           *                                                                 *
  160.           *     Note filename is the filename you chose in #3 above.        *
  161.           *     ASSUMING that filename from #3 above is  WHEEL.CFG,         *
  162.           *     type the following:                                         *
  163.           *                                                                 *
  164.           *                  WOFMAINT WHEEL.CFG                          *
  165.           *                                                                 *
  166.           *******************************************************************
  167.  
  168.              Choose menu option #7. (NOTE: READ PROMPTS CAREFULLY !!!)
  169.              This will create and initialize all the required files in
  170.              the directory you created in # 1) above. The program will
  171.              display the names of the files being created. Uses config
  172.              file from #3 above! You will be returned to the main menu
  173.              after initialization. Choose option "8" to exit WOFMAINT.
  174.  
  175.       5) Create a batch file or modify the WHEEL file supplied. A
  176.          description of this file follows:
  177.  
  178.             ECHO off
  179.             CD\bbs\DOORS\WHEEL        Location of Wheel of Fortune Files
  180.             WHEEL WHEEL.CFG           EXE filename and CFG filename (Name
  181.                                       used in creating file in #3 above)
  182.             CD\bbs
  183.             BOARD
  184.  
  185.                  NOTE: THERE ARE NO BLANK LINES IN THIS FILE
  186.  
  187.        6) When running more than one node, be sure to supply a different
  188.           configuration name for each node (your choice of name) and
  189.           change the first entry in the .CFG (if necessary).
  190.  
  191.        7) If running with Fossil-based multi-port boards add
  192.            /FD to the line containing the CFG name as follows:
  193.  
  194.                          WHEEL WHEEL.CFG /FD
  195.  
  196.  
  197.  
  198.                       CALLER SUPPLIED PUZZLES
  199.                       _______________________
  200.  
  201.       If enough time remains, the caller will be given the option to enter
  202.       puzzles for you to use in the databases. This is optional and is
  203.       controlled by an entry in the CONFIG file (see Config description above).
  204.  
  205.       These entries will reside in a separate file, WOFUSER.PUZ. It will be
  206.       your responsibility to check the entries out, add a category to each one
  207.       and import them into the WHEEL and/or BONUS databases. Be sure to delete
  208.       the file when you are finished with it, as WOF will add on to the file
  209.       if it is found in the WHEEL directory. If not found it creates a new one.
  210.  
  211.       NOTE: This option is only available if Door is registered!
  212.  
  213.  
  214.                           BLACKOUT PERIODS
  215.                           ________________
  216.  
  217.       Use the Blackout ranges option to define up to 5 time periods during
  218.       which you DO NOT want the Door to be played. If a caller tries to access
  219.       the Door during the Blackout period, they will be shown a message that
  220.       contains ALL the Blackout periods you have defined, and to try the Door
  221.       at a later time.
  222.  
  223.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  224.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  225.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  226.  
  227.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  228.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  229.                    a Blackout range.
  230.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  231.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  232.  
  233.  
  234.                         NON-STANDARD COM SUPPORT
  235.                         ________________________
  236.  
  237.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  238.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  239.       number after the configuration filename. Let's assume your Door is
  240.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  241.       passed to your Door would be:
  242.  
  243.                             FOOBAR FOOBAR.CFG /5
  244.  
  245.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  246.       normally used with COM1. No /x parameter is needed for the standard
  247.       IRQ's.
  248.  
  249.       As an alternative, you may use an environmental variable on the command
  250.       line. To use the variable (following the example above), place a
  251.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  252.       different IRQ number for each node). The command line would now look
  253.       like this:
  254.  
  255.                           FOOBAR FOOBAR.CFG /%IRQ%
  256.  
  257.       This, in combination with the use of the environmental variables
  258.       described in the MULTI-NODE SETUP section will allow you to use one
  259.       batch file and one config file to run this door on all nodes.
  260.  
  261.  
  262.  
  263.  
  264.                            MULTI-NODE SETUP
  265.                            ________________
  266.  
  267.       All Sunrise Doors are Multi-Node capable. Each node must have the
  268.       ability to access a configuration file which will have its own system
  269.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  270.       line. There are 2 ways to accomplish this:
  271.  
  272.       (1) Create a separate configuration file for each node. The only
  273.           difference between each file would be the location of the system
  274.           file for that particular node. For example, on my system there are 2
  275.           nodes and the first line of the config files would look like this:
  276.  
  277.                         NODE1:  H:\PCB1\DOOR.SYS
  278.                         NODE2:  H:\PCB2\DOOR.SYS
  279.  
  280.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  281.  
  282.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  283.           the following PCBoard environmental variables:
  284.  
  285.                  PCBDIR    (Directory containing the System file)
  286.                  PCBDRIVE  (Drive containing the System file)
  287.  
  288.           Thus, the first line of the SINGLE configuration file, for this Door
  289.           would look like this:
  290.  
  291.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  292.  
  293.       NOTE: This option, as described, assumes that you are running PCBoard
  294.             14.5a software. The environmental variables are automatically
  295.             created by the software for each node.
  296.  
  297.             HOWEVER, if you are running other BBS software you should be able
  298.             to set the variables EXACTLY as described below, for EACH node
  299.             (more than likely in each batch file you use to bring up EACH node):
  300.  
  301.                             PCBDRIVE=C:
  302.                             ^^^^^^^^^
  303.                             PCBDIR=\NODE2
  304.                             ^^^^^^^^
  305.  
  306.             Info with a carat (^) under it, MUST be typed as is. The rest
  307.             depends on your naming conventions.
  308.  
  309.             This, in combination with the use of the optional environmental
  310.             variable described in the NON-STANDARD COM SUPPORT section, will
  311.             allow you to use one batch file and one config file to run this
  312.             door on all nodes.
  313.  
  314.  
  315.  
  316.  
  317.                                 WOFMAINT
  318.                                 ________
  319.  
  320.     This is the Wheel of Fortune utility maintenance progam. See below for a
  321.     list of WOFMAINT functions. To start WOFMAINT enter the following:
  322.  
  323.               WOFMAINT WHEEL.CFG (Substitute your config filename)
  324.  
  325.  
  326.  
  327.  
  328.  
  329.                            WOFMAINT FUNCTIONS
  330.                            __________________
  331.  
  332.         (1) Add WHEEL Puzzles to Database
  333.             Add puzzles/categories to WHEEL puzzle database.
  334.             WHEEL dataase will only hold 2000 puzzles.
  335.         (2) Add BONUS Puzzles to Database
  336.             Add puzzles/categories to BONUS puzzle database.
  337.             BONUS database will only hold 2000 puzzles.
  338.         (3) Import a Puzzle File
  339.             Import puzzle files you have created offline with your favorite
  340.             editor or word processor. See detailed explanation below under
  341.             "OFFLINE PUZZLE CREATION".
  342.         (4) Check For REGULAR and BONUS Puzzle Duplicates
  343.             You should use this option ANY time you either ADD or IMPORT puzzles
  344.         (5) Re-Cycle Used REGULAR and BONUS Puzzles
  345.             When puzzles are changed,the old ones are placed in a file
  346.             called WHEELQUE.OLD or BONUSQUE.OLD. At some point in time you
  347.             may want to add them back into the current database. This option
  348.             will place them at the end of the database file. PLEASE NOTE: the
  349.             databases will only hold a maximum of 2000 puzzles (2000 in the
  350.             BONUS and 2000 in the WHEEL).
  351.         (6) Manually Change Puzzles and Reset/Update Files
  352.             Creates new puzzles, Updates Hall of Fame, Resets HiScore,
  353.             Index and Save files.
  354.         (7) Initialize ALL Files (Initial Setup ONLY!)
  355.             Use only the first time you are setting up this door. It will
  356.             reset all files, so USE IT with CAUTION !!
  357.         (8) EXIT
  358.             Exit WOFMAINT to DOS.
  359.  
  360.  
  361.                              EVENT PROCESSING
  362.                              ________________
  363.  
  364.     After your caller completes all the puzzles you have defined, it becomes
  365.     necessary to change them and start a new game. This task can be done
  366.     manually, using WOFMAINT (option #6) or automatically, as part of your
  367.     nightly EVENT process.
  368.  
  369.     As a nightly EVENT, WOFMAINT checks to see if the number of players, as
  370.     defined in the configuration file, have completed all puzzles, in which
  371.     case it will automatically supply a new set of puzzles and reset/update
  372.     the appropriate files. The following is an EXAMPLE of what needs to be
  373.     placed in your nightly EVENT file:
  374.  
  375.  
  376.                CD\PCB\DOORS\WHEEL           Location of WOF files
  377.                WOFMAINT WHEEL.CFG /EVENT    EXE filename and config filename
  378.                CD\BBS
  379.                BOARD
  380.  
  381.  
  382.  
  383.  
  384.  
  385.                           OFFLINE PUZZLE CREATION
  386.                           _______________________
  387.  
  388.  
  389.     This Wheel of Fortune Door program has the ability to import files you
  390.     create offline, with your favorite editor or word processor. The file
  391.     format is simple:  PUZZLE,CATEGORY. The maximum length of each puzzle is
  392.     35 charcters and the maximum length of each category is 20 characters.
  393.     When this file is imported it is first checked to ensure that it conforms
  394.     to the length restrictions and then the program checks to ensure that
  395.     there is enough room in the database. If there is no room, you will
  396.     receive a message to that effect and you will have to wait until enough
  397.     puzzles are used and space is made available. If the length of any puzzle
  398.     or category is invalid, the offending puzzle will be displayed along with
  399.     which parts are in error. You will have to correct the problem and rerun
  400.     the import option.
  401.  
  402.     As a reminder, there are two (2) databases; REGULAR puzzles and BONUS
  403.     puzzles. You must create separate files for each and answer the prompt
  404.     with the appropriate file type.
  405.  
  406.     Once you have registered Wheel of Fortune you you will be able to call
  407.     Sunrise-80 BBS and pick up extra puzzles. When you log on the BBS go to
  408.     the Doors menu and choose the Door number that corresponds to "WOF puzzles".
  409.     We would appreciate it if you would contribute the puzzles you have made up,
  410.     by uploading them into the same door on out BBS.
  411.  
  412.  
  413.  
  414.                                ADOPT-A-DOOR
  415.                                ____________
  416.  
  417.  
  418.     Having been a Sysop for a number of years, I have had my share of problems
  419.     and frustrations getting financial support for my board's upkeep. A fellow
  420.     Sysop left a message on my board, not long ago, about a concept that was
  421.     being used by several boards around the country.
  422.  
  423.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  424.     would be the same as sending in a donation, only this way it is earmarked
  425.     for registering a particular door. In a way, the user feels he/she is
  426.     "getting something in return". As a Door author I have decided to build
  427.     this concept into each of my Door programs. The concept replaces the
  428.     usual message "tell the Sysop to register this Door" we find in most
  429.     doors.
  430.  
  431.     If the Door is unregisterd then a message appears on the opening screen
  432.     to that effect. After finishing or suspending a game, a message screen
  433.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  434.     caller to contact the Sysop to find out if there is any further details
  435.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  436.     time, etc to callers that ADOPT-A-DOOR.
  437.  
  438.     If the Door has been registered, either by the Sysop or other callers,
  439.     the names of those contributors will be displayed in the closing screen.
  440.  
  441.     NOTE: If you want to display the names of the callers that contributed
  442.           to registering the Door, you must create an ASCII file called
  443.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  444.           the name(s) of the contributors (one on each line, maximum of 5
  445.           entries, each a maximum of 30 characters long). This file must be
  446.           saved, in ASCII format, and placed in the Door directory.
  447.  
  448.  
  449.  
  450.                               LEGALITIES
  451.                               __________
  452.  
  453.  
  454.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  455.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  456.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  457.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  458.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  459.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  460.       OR BREACH OF ANY WARRANTY.
  461.  
  462.  
  463.  
  464.  
  465.  
  466.                              DISTRIBUTION
  467.                              ____________
  468.  
  469.    You may make this file available for downloading from your BBS or you may
  470.    upload it to any BBS of your choice, provided that you do not make any
  471.    changes to the contents of the archive (ZIP file). The archive and its
  472.    individual contents may not be used by any service that charges any money
  473.    whatsoever, without the written permission of the author.
  474.  
  475.  
  476.  
  477.  
  478.  
  479.                              REGISTRATION
  480.                              ____________
  481.  
  482.    Registration and the subsequent insertion of the registration number into
  483.    your configuation file, allows for the display of your BBS name on the
  484.    opening and closing screen as well as the reduction of a delay built into
  485.    the opening screen display along with the ability to change certain values
  486.    in the configuration file.
  487.  
  488.    To register your copy of WHEEL of FORTUNE, please fill out the registration
  489.    form (REGISTER.FRM) and mail it along with the registration fee to
  490.    the name and address on the form or supply a self-addressed stamped
  491.    envelope for registration number by return mail.t
  492.  
  493.    Be sure to use the proper upper/lower case when filling in your name and
  494.    BBS name, as they MUST match the way you entered them in the configuration
  495.    file.             ^^^^
  496.  
  497.    Based upon information supplied on the registration form, I will pre-
  498.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  499.    up your registration number.
  500.  
  501.  
  502.  
  503.                                  MISC
  504.                                  ____
  505.  
  506.    The latest version of WHEEL of FORTUNE and other fine SUNRISE DOOR programs
  507.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  508.  
  509.    Remember, should you have any problems, questions or suggestions, be sure
  510.    to drop me a message on either of the aforementioned BBS'.  I am now a
  511.    PCRelay node (SUNRISE) and can be reached thru the SYSOP, BBSDOORS,
  512.    PCBhints RIME conferences.
  513.