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