home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / sunrise / wof54.zip / WHEEL.DOC < prev    next >
Text File  |  1993-07-18  |  24KB  |  511 lines
  1.  
  2.                             WHEEL of FORTUNE
  3.  
  4.                                   v5.4
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                        (404) 256-9525 (19.2)
  12.                        (404) 705-9104 (14.4)
  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\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  137. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  138. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  139. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  140. C:\BBS\CHAIN.TXT                <- For WWIV systems
  141. C:\BBS\GTUSER.BBS               <- For GT Power
  142.                                    * if using this option you must put the
  143.                                      ComPort # on line 5 and the Node # on
  144.                                      line 6 of the configuration file
  145.  
  146.  
  147.  
  148.          # =  Requires registration to change to a different value
  149.          @ =  See "Blackout Periods" Below
  150.  
  151.  
  152.               NOTE:THERE ARE TO BE NO BLANK LINES IN THIS FILE !
  153.  
  154.       4) Run WOFMAINT WHEEL.CFG (or name you gave to config file)
  155.  
  156.           ********************* To Setup Program ****************************
  157.           *                                                                 *
  158.           *     Note filename is the filename you chose in #3 above.        *
  159.           *     ASSUMING that filename from #3 above is  WHEEL.CFG,         *
  160.           *     type the following:                                         *
  161.           *                                                                 *
  162.           *                  WOFMAINT WHEEL.CFG                          *
  163.           *                                                                 *
  164.           *******************************************************************
  165.  
  166.              Choose menu option #7. (NOTE: READ PROMPTS CAREFULLY !!!)
  167.              This will create and initialize all the required files in
  168.              the directory you created in # 1) above. The program will
  169.              display the names of the files being created. Uses config
  170.              file from #3 above! You will be returned to the main menu
  171.              after initialization. Choose option "8" to exit WOFMAINT.
  172.  
  173.       5) Create a batch file or modify the WHEEL file supplied. A
  174.          description of this file follows:
  175.  
  176.             ECHO off
  177.             CD\bbs\DOORS\WHEEL        Location of Wheel of Fortune Files
  178.             WHEEL WHEEL.CFG           EXE filename and CFG filename (Name
  179.                                       used in creating file in #3 above)
  180.             CD\bbs
  181.             BOARD
  182.  
  183.                  NOTE: THERE ARE NO BLANK LINES IN THIS FILE
  184.  
  185.        6) When running more than one node, be sure to supply a different
  186.           configuration name for each node (your choice of name) and
  187.           change the first entry in the .CFG (if necessary).
  188.  
  189.        7) If running with Fossil-based multi-port boards add
  190.            /FD to the line containing the CFG name as follows:
  191.  
  192.                          WHEEL WHEEL.CFG /FD
  193.  
  194.  
  195.  
  196.                       CALLER SUPPLIED PUZZLES
  197.                       _______________________
  198.  
  199.       If enough time remains, the caller will be given the option to enter
  200.       puzzles for you to use in the databases. This is optional and is
  201.       controlled by an entry in the CONFIG file (see Config description above).
  202.  
  203.       These entries will reside in a separate file, WOFUSER.PUZ. It will be
  204.       your responsibility to check the entries out, add a category to each one
  205.       and import them into the WHEEL and/or BONUS databases. Be sure to delete
  206.       the file when you are finished with it, as WOF will add on to the file
  207.       if it is found in the WHEEL directory. If not found it creates a new one.
  208.  
  209.       NOTE: This option is only available if Door is registered!
  210.  
  211.  
  212.                           BLACKOUT PERIODS
  213.                           ________________
  214.  
  215.       Use the Blackout ranges option to define up to 5 time periods during
  216.       which you DO NOT want the Door to be played. If a caller tries to access
  217.       the Door during the Blackout period, they will be shown a message that
  218.       contains ALL the Blackout periods you have defined, and to try the Door
  219.       at a later time.
  220.  
  221.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  222.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  223.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  224.  
  225.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  226.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  227.                    a Blackout range.
  228.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  229.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  230.  
  231.  
  232.                         NON-STANDARD COM SUPPORT
  233.                         ________________________
  234.  
  235.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  236.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  237.       number after the configuration filename. Let's assume your Door is
  238.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  239.       passed to your Door would be:
  240.  
  241.                             FOOBAR FOOBAR.CFG /5
  242.  
  243.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  244.       normally used with COM1. No /x parameter is needed for the standard
  245.       IRQ's.
  246.  
  247.       As an alternative, you may use an environmental variable on the command
  248.       line. To use the variable (following the example above), place a
  249.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  250.       different IRQ number for each node). The command line would now look
  251.       like this:
  252.  
  253.                           FOOBAR FOOBAR.CFG /%IRQ%
  254.  
  255.       This, in combination with the use of the environmental variables
  256.       described in the MULTI-NODE SETUP section will allow you to use one
  257.       batch file and one config file to run this door on all nodes.
  258.  
  259.  
  260.  
  261.  
  262.                            MULTI-NODE SETUP
  263.                            ________________
  264.  
  265.       All Sunrise Doors are Multi-Node capable. Each node must have the
  266.       ability to access a configuration file which will have its own system
  267.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  268.       line. There are 2 ways to accomplish this:
  269.  
  270.       (1) Create a separate configuration file for each node. The only
  271.           difference between each file would be the location of the system
  272.           file for that particular node. For example, on my system there are 2
  273.           nodes and the first line of the config files would look like this:
  274.  
  275.                         NODE1:  H:\PCB1\DOOR.SYS
  276.                         NODE2:  H:\PCB2\DOOR.SYS
  277.  
  278.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  279.  
  280.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  281.           the following PCBoard environmental variables:
  282.  
  283.                  PCBDIR    (Directory containing the System file)
  284.                  PCBDRIVE  (Drive containing the System file)
  285.  
  286.           Thus, the first line of the SINGLE configuration file, for this Door
  287.           would look like this:
  288.  
  289.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  290.  
  291.       NOTE: This option, as described, assumes that you are running PCBoard
  292.             14.5a software. The environmental variables are automatically
  293.             created by the software for each node.
  294.  
  295.             HOWEVER, if you are running other BBS software you should be able
  296.             to set the variables EXACTLY as described below, for EACH node
  297.             (more than likely in each batch file you use to bring up EACH node):
  298.  
  299.                             PCBDRIVE=C:
  300.                             ^^^^^^^^^
  301.                             PCBDIR=\NODE2
  302.                             ^^^^^^^^
  303.  
  304.             Info with a carat (^) under it, MUST be typed as is. The rest
  305.             depends on your naming conventions.
  306.  
  307.             This, in combination with the use of the optional environmental
  308.             variable described in the NON-STANDARD COM SUPPORT section, will
  309.             allow you to use one batch file and one config file to run this
  310.             door on all nodes.
  311.  
  312.  
  313.  
  314.  
  315.                                 WOFMAINT
  316.                                 ________
  317.  
  318.     This is the Wheel of Fortune utility maintenance progam. See below for a
  319.     list of WOFMAINT functions. To start WOFMAINT enter the following:
  320.  
  321.               WOFMAINT WHEEL.CFG (Substitute your config filename)
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                            WOFMAINT FUNCTIONS
  328.                            __________________
  329.  
  330.         (1) Add WHEEL Puzzles to Database
  331.             Add puzzles/categories to WHEEL puzzle database.
  332.             WHEEL dataase will only hold 2000 puzzles.
  333.         (2) Add BONUS Puzzles to Database
  334.             Add puzzles/categories to BONUS puzzle database.
  335.             BONUS database will only hold 2000 puzzles.
  336.         (3) Import a Puzzle File
  337.             Import puzzle files you have created offline with your favorite
  338.             editor or word processor. See detailed explanation below under
  339.             "OFFLINE PUZZLE CREATION".
  340.         (4) Check For REGULAR and BONUS Puzzle Duplicates
  341.             You should use this option ANY time you either ADD or IMPORT puzzles
  342.         (5) Re-Cycle Used REGULAR and BONUS Puzzles
  343.             When puzzles are changed,the old ones are placed in a file
  344.             called WHEELQUE.OLD or BONUSQUE.OLD. At some point in time you
  345.             may want to add them back into the current database. This option
  346.             will place them at the end of the database file. PLEASE NOTE: the
  347.             databases will only hold a maximum of 2000 puzzles (2000 in the
  348.             BONUS and 2000 in the WHEEL).
  349.         (6) Manually Change Puzzles and Reset/Update Files
  350.             Creates new puzzles, Updates Hall of Fame, Resets HiScore,
  351.             Index and Save files.
  352.         (7) Initialize ALL Files (Initial Setup ONLY!)
  353.             Use only the first time you are setting up this door. It will
  354.             reset all files, so USE IT with CAUTION !!
  355.         (8) EXIT
  356.             Exit WOFMAINT to DOS.
  357.  
  358.  
  359.                              EVENT PROCESSING
  360.                              ________________
  361.  
  362.     After your caller completes all the puzzles you have defined, it becomes
  363.     necessary to change them and start a new game. This task can be done
  364.     manually, using WOFMAINT (option #6) or automatically, as part of your
  365.     nightly EVENT process.
  366.  
  367.     As a nightly EVENT, WOFMAINT checks to see if the number of players, as
  368.     defined in the configuration file, have completed all puzzles, in which
  369.     case it will automatically supply a new set of puzzles and reset/update
  370.     the appropriate files. The following is an EXAMPLE of what needs to be
  371.     placed in your nightly EVENT file:
  372.  
  373.  
  374.                CD\PCB\DOORS\WHEEL           Location of WOF files
  375.                WOFMAINT WHEEL.CFG /EVENT    EXE filename and config filename
  376.                CD\BBS
  377.                BOARD
  378.  
  379.  
  380.  
  381.  
  382.  
  383.                           OFFLINE PUZZLE CREATION
  384.                           _______________________
  385.  
  386.  
  387.     This Wheel of Fortune Door program has the ability to import files you
  388.     create offline, with your favorite editor or word processor. The file
  389.     format is simple:  PUZZLE,CATEGORY. The maximum length of each puzzle is
  390.     35 charcters and the maximum length of each category is 20 characters.
  391.     When this file is imported it is first checked to ensure that it conforms
  392.     to the length restrictions and then the program checks to ensure that
  393.     there is enough room in the database. If there is no room, you will
  394.     receive a message to that effect and you will have to wait until enough
  395.     puzzles are used and space is made available. If the length of any puzzle
  396.     or category is invalid, the offending puzzle will be displayed along with
  397.     which parts are in error. You will have to correct the problem and rerun
  398.     the import option.
  399.  
  400.     As a reminder, there are two (2) databases; REGULAR puzzles and BONUS
  401.     puzzles. You must create separate files for each and answer the prompt
  402.     with the appropriate file type.
  403.  
  404.     Once you have registered Wheel of Fortune you you will be able to call
  405.     Sunrise-80 BBS and pick up extra puzzles. When you log on the BBS go to
  406.     the Doors menu and choose the Door number that corresponds to "WOF puzzles".
  407.     We would appreciate it if you would contribute the puzzles you have made up,
  408.     by uploading them into the same door on out BBS.
  409.  
  410.  
  411.  
  412.                                ADOPT-A-DOOR
  413.                                ____________
  414.  
  415.  
  416.     Having been a Sysop for a number of years, I have had my share of problems
  417.     and frustrations getting financial support for my board's upkeep. A fellow
  418.     Sysop left a message on my board, not long ago, about a concept that was
  419.     being used by several boards around the country.
  420.  
  421.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  422.     would be the same as sending in a donation, only this way it is earmarked
  423.     for registering a particular door. In a way, the user feels he/she is
  424.     "getting something in return". As a Door author I have decided to build
  425.     this concept into each of my Door programs. The concept replaces the
  426.     usual message "tell the Sysop to register this Door" we find in most
  427.     doors.
  428.  
  429.     If the Door is unregisterd then a message appears on the opening screen
  430.     to that effect. After finishing or suspending a game, a message screen
  431.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  432.     caller to contact the Sysop to find out if there is any further details
  433.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  434.     time, etc to callers that ADOPT-A-DOOR.
  435.  
  436.     If the Door has been registered, either by the Sysop or other callers,
  437.     the names of those contributors will be displayed in the closing screen.
  438.  
  439.     NOTE: If you want to display the names of the callers that contributed
  440.           to registering the Door, you must create an ASCII file called
  441.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  442.           the name(s) of the contributors (one on each line, maximum of 5
  443.           entries, each a maximum of 30 characters long). This file must be
  444.           saved, in ASCII format, and placed in the Door directory.
  445.  
  446.  
  447.  
  448.                               LEGALITIES
  449.                               __________
  450.  
  451.  
  452.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  453.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  454.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  455.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  456.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  457.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  458.       OR BREACH OF ANY WARRANTY.
  459.  
  460.  
  461.  
  462.  
  463.  
  464.                              DISTRIBUTION
  465.                              ____________
  466.  
  467.    You may make this file available for downloading from your BBS or you may
  468.    upload it to any BBS of your choice, provided that you do not make any
  469.    changes to the contents of the archive (ZIP file). The archive and its
  470.    individual contents may not be used by any service that charges any money
  471.    whatsoever, without the written permission of the author.
  472.  
  473.  
  474.  
  475.  
  476.  
  477.                              REGISTRATION
  478.                              ____________
  479.  
  480.    Registration and the subsequent insertion of the registration number into
  481.    your configuation file, allows for the display of your BBS name on the
  482.    opening and closing screen as well as the reduction of a delay built into
  483.    the opening screen display along with the ability to change certain values
  484.    in the configuration file.
  485.  
  486.    To register your copy of WHEEL of FORTUNE, please fill out the registration
  487.    form (REGISTER.FRM) and mail it along with the registration fee to
  488.    the name and address on the form or supply a self-addressed stamped
  489.    envelope for registration number by return mail.t
  490.  
  491.    Be sure to use the proper upper/lower case when filling in your name and
  492.    BBS name, as they MUST match the way you entered them in the configuration
  493.    file.             ^^^^
  494.  
  495.    Based upon information supplied on the registration form, I will pre-
  496.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  497.    up your registration number.
  498.  
  499.  
  500.  
  501.                                  MISC
  502.                                  ____
  503.  
  504.    The latest version of WHEEL of FORTUNE and other fine SUNRISE DOOR programs
  505.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  506.  
  507.    Remember, should you have any problems, questions or suggestions, be sure
  508.    to drop me a message on either of the aforementioned BBS'.  I am now a
  509.    PCRelay node (SUNRISE) and can be reached thru the SYSOP, BBSDOORS,
  510.    PCBhints RIME conferences.
  511.