home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / sunrise / sweeps13.zip / SWEEPS.DOC < prev    next >
Text File  |  1993-06-19  |  22KB  |  483 lines
  1.  
  2.                            SWEEPSTAKES DICE
  3.  
  4.                                  v1.3
  5.  
  6.                                   by
  7.  
  8.  
  9.                           Sunrise Door Software
  10.                               Al Lawrence
  11.  
  12.                             Sunrise-80  BBS
  13.  
  14.                          (404) 256-9525 (Data)
  15.                          (404) 705-9104 (Data)
  16.                   (404) 256-9518 (Voice, 9am-9:30pm EST)
  17.  
  18.  
  19.  
  20.                                 OVERVIEW
  21.                                 ________
  22.  
  23.    SWEEPSTAKES is a fast-paced dice game in which you will be betting on the
  24.    outcome of the roll of six dice.
  25.  
  26.    The object of the game is to accumulate as many points as possible and
  27.    gain as high a slot as possible in the High Score file.
  28.  
  29.  
  30.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  31.          created in the directory you run the door from.
  32.  
  33.  
  34.  
  35.                               INSTALLATION
  36.                               ____________
  37.  
  38.  
  39.    Installation is fairly easy and straight-forward. The following steps and
  40.    examples should have you up and running in a very short period of time.
  41.    It is assumed that you are familiar with setting up DOORS on your system.
  42.    To this end, only examples of the configuration file and Door batch file
  43.    are described.
  44.  
  45.       1) Create a directory to hold all SWEEPS files
  46.  
  47.       2) Unzip SWEEPSxx.ZIP into the the above directory
  48.  
  49.       3) Create a configuration file, with a name of your choice, or
  50.          modify the supplied SWEEPS.CFG file. A description follows:
  51.  
  52.             **                       Location of system file (See Below)
  53.             SUNRISE-80 BBS           Your BBS Name
  54.             Al                       Sysop's First name
  55.  
  56.             Lawrence                 Sysop's Last Name
  57.  
  58. |-----------------------------------------------------------------------------|
  59. | READ!     1                        CommPort  \ These 2 lines are required   |
  60. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  61. |-----------------------------------------------------------------------------|
  62.  
  63.             00000000                 Registration Number
  64.  
  65.    !    #   5                        Maximum # of Turns per day
  66.                                      (Sysop gets 999 in Registered version)
  67.                                      (Configurable... see option below    )
  68.  
  69.         #   0                        Max # of days a caller can make up, during
  70.                                      calls in one day. 0=Disable Make-up Option
  71.                                      Maximum value = 27, Minimum value = 1
  72.  
  73.         #   NONE                     Drive:\Path\Filename to contain the
  74.                                      Top Score Bulletin or enter NONE
  75.                                      for NO Bulletin creation.
  76.  
  77.         #   NONE                     Drive:\Path\Filename to contain the
  78.                                      Top Score Bulletin (Color) or enter NONE
  79.                                      for NO Bulletin creation.
  80.  
  81.         #   NONE                     Drive:\Path\Filename to contain the
  82.                                      Hall of Fame Bulletin or enter NONE
  83.                                      for NO Bulletin creation.
  84.  
  85.         #   NONE                     Drive:\Path\Filename to contain the
  86.                                      Hall of Fame Bulletin (Color) or enter NONE
  87.                                      for NO Bulletin creation.
  88.  
  89.  
  90.             1                        1 = DO NOT Display ADOPT-A-DOOR Message
  91.                                      2 = Display ADOPT-A-DOOR message
  92.  
  93.         #   2                        Keyboard timeout value in Minutes
  94.  
  95.     !   #   0                        Time Allowed in Door
  96.                                      (Sysop = Time Remaining - REG. VERSION)
  97.  
  98.         #   N                        Automatic game reset at end of month:
  99.                                        Y = Yes enable autoreset
  100.                                        N = Keep accumulating scores
  101.  
  102.             Y                        Y = Allow Sysop to have 999 turns/day
  103.                                      N = Don't Allow Sysop 999 turns/day
  104.  
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  108.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  109.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  110.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  111.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  112.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  113.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  114.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  115.  
  116.     @   #   XXXX/YYYY                 Blackout Range  From/To
  117.     @   #   XXXX/YYYY                 Blackout Range  From/To
  118.     @   #   XXXX/YYYY                 Blackout Range  From/To
  119.     @   #   XXXX/YYYY                 Blackout Range  From/To
  120.     @   #   XXXX/YYYY                 Blackout Range  From/To
  121.  
  122.           ** = Replace with ONE of the following:
  123.  
  124. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  125. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  126. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  127. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  128. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  129. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  130. C:\BBS\CHAIN.TXT                <- For WWIV systems
  131. C:\BBS\GTUSER.BBS               <- For GT Power
  132.                                    * if using this option you must put the
  133.                                      ComPort # on line 5 and the Node # on
  134.                                      line 6 of the configuration file
  135.  
  136.  
  137.            # = Requires registration to change to a different value.
  138.            ! = See "Plays Per Day/Door Time" Below
  139.            @ = See "Blackout Periods" Below
  140.  
  141.                NOTE: There are NO Blank Lines in the Config File!!
  142.  
  143.  
  144.       4) Create a batch file or modify the GROAN file supplied. A
  145.          description of this file follows:
  146.  
  147.             ECHO off
  148.             cd\BBS\DOORS\SWEEPS       Location of SWEEPS files
  149.             SWEEPS SWEEPS.CFG         EXE filename and CFG filename (Name
  150.                                       used in creating file in #3 above)
  151.             CD\BBS
  152.             BOARD
  153.  
  154.  
  155.        5) When running in more than one node, be sure to supply a
  156.           different configuration name for each node (your choice of name).
  157.  
  158.        6) If running with a multi-port board/Fossil Driver add
  159.           /FD to the line containing the CFG name as follows:
  160.  
  161.                         SWEEPS SWEEPS.CFG /FD
  162.  
  163.  
  164.  
  165.                             JACKPOT Points
  166.                             --------------
  167.  
  168. When you end up losing points, SWEEPS will place them into the "JACKPOT".
  169. This "JACKPOT" will continue to accumulate all points lost by any player.
  170. It will also accumulate the points lost by those playing on any other node(s)
  171. at the same time. The "JACKPOT" points will be updated on the players screen
  172. REAL TIME (at the moment the player on another node loses points). The
  173. "JACKPOT" points can be won by any player, if they roll 6 dice of the same
  174. value OR a straight (1-6) in strict numerical order. Minimum amount in the
  175. "JACKPOT" will be 10000 points.
  176.  
  177.  
  178.  
  179.                MAKE-UP DAYS (Registered version only)
  180.                --------------------------------------
  181.  
  182. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  183. during the current month and prior to the current call. You control whether
  184. to allow this option, as well as the number of days the caller can make up, on
  185. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  186. configuration file, turns the option OFF, any other value (up to a max of 27)
  187. turns the option ON and dictates the number of days the caller can make up.
  188.  
  189.  
  190. NOTE:      The number of games per day is calculated as follows...
  191.  
  192.            Games Allowed per day x Number of makeup days.
  193.  
  194. Example:   Games Allowed per day = 2
  195.            Max # of makeup days  = 4
  196.  
  197. If a caller logs in on 5/8/92 and this is their first call of the month, they
  198. would have a potential of 16 games to makeup and bring them current
  199. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  200. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  201. (games allowed * max # of makeup days).
  202.  
  203.  
  204.  
  205.              HALL OF FAME BULLETINS (Registered version only)
  206.              ------------------------------------------------
  207.  
  208. The program will automatically reset the game when the first caller of the
  209. month plays the game. The score file will be cleared and a set of Hall of Fame
  210. bulletin files will be created. The files will be called SUNHOF.ASC and
  211. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  212. directory as the SWEEPS.EXE file. You are responsible for COPYING the files to
  213. your bulletin area and renaming to a filename of your choice.
  214.  
  215. WARNING: The HOF files are cumulative files. That means they are read in each
  216.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  217.          the record of prior months winners!!!!
  218.  
  219.  
  220.  
  221.                           BLACKOUT PERIODS
  222.                           ________________
  223.  
  224.       Use the Blackout ranges option to define up to 5 time periods during
  225.       which you DO NOT want the Door to be played. If a caller tries to access
  226.       the Door during the Blackout period, they will be shown a message that
  227.       contains ALL the Blackout periods you have defined, and to try the Door
  228.       at a later time.
  229.  
  230.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  231.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  232.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  233.  
  234.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  235.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  236.                    a Blackout range.
  237.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  238.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  239.  
  240.  
  241.                           PLAYS Per DAY/DOOR Time
  242.                           _______________________
  243.  
  244.       Plays Per Day and Door Time can be controlled several ways:
  245.  
  246.       (1) You can use the Games Per Day, singular option, in the config
  247.           file above. This option, will affect ALL callers whose Security
  248.           Level is NOT defined in any of the 10 optional Security Level/
  249.           Plays Per Day entries in the config file.
  250.  
  251.       (2) You can use the Door Time, singular option, in the config file
  252.           above. This option, will affect ALL callers whose Security
  253.           Level is NOT defined in any of the 10 optional Security Level/
  254.           Plays Per Day/Door Time entries in the config file.
  255.  
  256.       (3) You can restrict the number of games a specific Security Level
  257.           will be allowed to play per day or REWARD specific Levels with
  258.           more Plays Per Day.
  259.  
  260.           Likewise, you can restrict the Play time for a specific Security
  261.           Level or REWARD specific Levels with more Door Time.
  262.  
  263.           These options are handled by the use of the 10 config
  264.           entries (000=00/00).
  265.  
  266.           The format of each entry is as follows:
  267.  
  268.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  269.                      where =  is a constant and MUST be included
  270.                      where YY is the # of games per day (must be 2 digits)
  271.                      where / is a constant and MUST be included
  272.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  273.  
  274.           If the callers Security Level is NOT defined, his/her Plays Per
  275.           Day and Door Time will be controlled by the values in items
  276.           (1) and (2), above, respectively..
  277.  
  278.           You may define up to 10 Security Levels. All unused entries must
  279.           be defined as   00=00/00
  280.         --------------------------------------------------------------------
  281.           Example: Suppose you had 3 Security Levels defined on your BBS as
  282.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  283.           wanted to set Plays Per Day as :     Subscriber=5
  284.                                            Visiting Sysop=2
  285.                                                   CoSysop=3
  286.                                                    Friend=10
  287.  
  288.           and Door Time as follows:     Subscriber=30 minutes
  289.                                     Visiting Sysop=20 minutes
  290.                                            CoSysop=10 minutes
  291.                                             Friend=remaining call time
  292.  
  293.  
  294.           You would set the Individual "Games per Day" config entry to 1 and
  295.           the individual "Door Time" to 5 minutes (these would be the
  296.           default number of games and default Time for all Security Levels
  297.           other than 20,30 or 40... make them any number you want). Next you
  298.           would replace 4 of the Security Level entries as :  020=05/30
  299.                                                               030=02/20
  300.                                                               040=03/10
  301.                                                               090=10/0
  302.  
  303.  
  304.  
  305.                         NON-STANDARD COM SUPPORT
  306.                         ________________________
  307.  
  308.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  309.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  310.       number after the configuration filename. Let's assume your Door is
  311.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  312.       passed to your Door would be:
  313.  
  314.                             FOOBAR FOOBAR.CFG /5
  315.  
  316.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  317.       normally used with COM1. No /x parameter is needed for the standard
  318.       IRQ's.
  319.  
  320.       As an alternative, you may use an environmental variable on the command
  321.       line. To use the variable (following the example above), place a
  322.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  323.       different IRQ number for each node). The command line would now look
  324.       like this:
  325.  
  326.                           FOOBAR FOOBAR.CFG /%IRQ%
  327.  
  328.       This, in combination with the use of the environmental variables
  329.       described in the MULTI-NODE SETUP section will allow you to use one
  330.       batch file and one config file to run this door on all nodes.
  331.  
  332.  
  333.  
  334.  
  335.                            MULTI-NODE SETUP
  336.                            ________________
  337.  
  338.       All Sunrise Doors are Multi-Node capable. Each node must have the
  339.       ability to access a configuration file which will have its own system
  340.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  341.       line. There are 2 ways to accomplish this:
  342.  
  343.       (1) Create a separate configuration file for each node. The only
  344.           difference between each file would be the location of the system
  345.           file for that particular node. For example, on my system there are 2
  346.           nodes and the first line of the config files would look like this:
  347.  
  348.                         NODE1:  H:\PCB1\DOOR.SYS
  349.                         NODE2:  H:\PCB2\DOOR.SYS
  350.  
  351.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  352.  
  353.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  354.           the following PCBoard environmental variables:
  355.  
  356.                  PCBDIR    (Directory containing the System file)
  357.                  PCBDRIVE  (Drive containing the System file)
  358.  
  359.           Thus, the first line of the SINGLE configuration file, for this Door
  360.           would look like this:
  361.  
  362.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  363.  
  364.       NOTE: This option, as described, assumes that you are running PCBoard
  365.             14.5a software. The environmental variables are automatically
  366.             created by the software for each node.
  367.  
  368.             HOWEVER, if you are running other BBS software you should be able
  369.             to set the variables EXACTLY as described below, for EACH node
  370.             (more than likely in each batch file you use to bring up EACH node):
  371.  
  372.                             PCBDRIVE=C:
  373.                             ^^^^^^^^^
  374.                             PCBDIR=\NODE2
  375.                             ^^^^^^^^
  376.  
  377.             Info with a carat (^) under it, MUST be typed as is. The rest
  378.             depends on your naming conventions.
  379.  
  380.             This, in combination with the use of the optional environmental
  381.             variable described in the NON-STANDARD COM SUPPORT section, will
  382.             allow you to use one batch file and one config file to run this
  383.             door on all nodes.
  384.  
  385.  
  386.                                ADOPT-A-DOOR
  387.                                ____________
  388.  
  389.     Having been a Sysop for a number of years, I have had my share of problems
  390.     and frustrations getting financial support for my board's upkeep. A fellow
  391.     Sysop left a message on my board, not long ago, about a concept that was
  392.     being used by several boards around the country.
  393.  
  394.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  395.     would be the same as sending in a donation, only this way it is earmarked
  396.     for registering a particular door. In a way, the user feels he/she is
  397.     "getting something in return". As a Door author I have decided to build
  398.     this concept into each of my Door programs. The concept replaces the
  399.     usual message "tell the Sysop to register this Door" we find in most
  400.     doors.
  401.  
  402.     If the Door is unregisterd then a message appears on the opening screen
  403.     to that effect. After finishing or suspending a game, a message screen
  404.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  405.     caller to contact the Sysop to find out if there is any further details
  406.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  407.     time, etc to callers that ADOPT-A-DOOR.
  408.  
  409.     If the Door has been registered, either by the Sysop or other callers,
  410.     the names of those contributors will be displayed in the closing screen.
  411.  
  412.     NOTE: If you want to display the names of the callers that contributed
  413.           to registering the Door, you must create an ASCII file called
  414.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  415.           the name(s) of the contributors (one on each line, maximum of 5
  416.           entries, each a maximum of 30 characters long). This file must be
  417.           saved, in ASCII format, and placed in the Door directory.
  418.  
  419.  
  420.  
  421.                               LEGALITIES
  422.                               __________
  423.  
  424.  
  425.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  426.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  427.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  428.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  429.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  430.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  431.       OR BREACH OF ANY WARRANTY.
  432.  
  433.  
  434.  
  435.  
  436.  
  437.                              DISTRIBUTION
  438.                              ____________
  439.  
  440.    You may make this file available for downloading from your BBS or you may
  441.    upload it to any BBS of your choice, provided that you do not make any
  442.    changes to the contents of the archive (ZIP file). The archive and its
  443.    individual contents may not be used by any service that charges any money
  444.    whatsoever, without the written permission of the author.
  445.  
  446.  
  447.  
  448.  
  449.  
  450.                              REGISTRATION
  451.                              ____________
  452.  
  453.    Registration and the subsequent insertion of the registration number into
  454.    your configuation file, allows for the display of your BBS name on the
  455.    opening and closing screen as well as the reduction of a delay built into
  456.    the opening screen display along with the ability to change certain
  457.    values in the configuration file.
  458.  
  459.    To register your copy of SWEEPSTAKES, please fill out the registration
  460.    form (REGISTER.FRM) and mail it along with the registration fee to
  461.    the name and address on the form.
  462.  
  463.    Be sure to use the proper upper/lower case when filling in your name and
  464.    BBS name, as they MUST match the way you entered them in the configuration
  465.    file.             ^^^^
  466.  
  467.    Based upon information supplied on the registration form, I will pre-
  468.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  469.    up your registration number.
  470.  
  471.  
  472.  
  473.                                  MISC
  474.                                  ____
  475.  
  476.    The latest version of SWEEPSTAKES DICE and other fine SUNRISE DOOR programs
  477.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  478.  
  479.    Remember, should you have any problems, questions or suggestions, be sure
  480.    to drop me a message on either of the aforementioned BBS', SmartNet (Sysops)
  481.    Rime (PCBhints, Common, Doors, Sysops) or FidoNet 1:133/410
  482.  
  483.