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