home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / sunrise / adopt30.zip / ADOPT.DOC < prev    next >
Text File  |  1993-06-19  |  13KB  |  306 lines
  1.  
  2.                             ADOPT - A - DOOR
  3.  
  4.                                   v3.0
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    ADOPT is a stand-alone program that can be executed after every Door program
  21.    completes and before it returns to your BBS.  It will display a message that
  22.    encourages your callers to donate to the BBS by adopting a given door or
  23.    group of doors and having his/her name displayed every time the particular
  24.    door is executed. There are 2 options available with ADOPT:
  25.  
  26.    OPTION 1, UNREGISTERED version, will display a hard-coded (non-changeable)
  27.    message describing the Adopt-A-Door concept to your callers. The REGISTERED
  28.    version will allow you to create your own message (15 lines, 62 characters
  29.    per line).
  30.  
  31.    OPTION 2 will display the names of the callers (max of 8) that have
  32.    contributed to the registration of that particular door. This file is an
  33.    ASCII file you create with the names of the callers (Max 30 char/name). The
  34.    name of the file is your choice, but the name must match with the name in
  35.    the configuration file.
  36.  
  37.  
  38.  
  39.    NOTE: Runtime errors will be logged to a file called DFRAME.ERR which is
  40.          created in the directory you run the door from.
  41.  
  42.  
  43.  
  44.                               INSTALLATION
  45.                               ____________
  46.  
  47.  
  48.    Installation is fairly easy and straight-forward. The following steps and
  49.    examples should have you up and running in a very short period of time.
  50.    It is assumed that you are familiar with setting up DOORS on your system.
  51.    To this end, only examples of the configuration file and Door batch file
  52.    are described.
  53.  
  54.       1) Create a directory to hold all ADOPT files
  55.  
  56.       2) Unzip ADOPTxx.ZIP into the the above directory
  57.  
  58.       3) Create a configuration file, with a name of your choice, or
  59.          modify the supplied ADOPT.CFG file. A description follows:
  60.  
  61.             **                       Location of system files (see below)
  62.             SUNRISE-80 BBS           Your BBS Name
  63.             Al                       Sysop's First Name
  64.             Lawrence                 Sysop's Last Name
  65.  
  66. |-----------------------------------------------------------------------------|
  67. | READ!     1                        CommPort  \ These 2 lines are required   |
  68. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  69. |-----------------------------------------------------------------------------|
  70.  
  71.             00000000                 Registration Number
  72.             1                        1=Initial Message Display
  73.                                      2=Display Callers Names That Contributed
  74.        #    201                      ASCII Character Used TO Form Message Border
  75.        #    NONE                     File Name Containing Initial Display
  76.        #    NONE                     File Name Containing Contributing Callers
  77.        #    30                       Number of SECONDS To Keep Msg On Screen
  78.        !    0                        Security level that will bypass the DOOR
  79.        !    0                        Security level that will bypass the DOOR
  80.        !    0                        Security level that will bypass the DOOR
  81.        !    0                        Security level that will bypass the DOOR
  82.        !    0                        Security level that will bypass the DOOR
  83.        !    0                        Security level that will bypass the DOOR
  84.        !    0                        Security level that will bypass the DOOR
  85.        !    0                        Security level that will bypass the DOOR
  86.        !    0                        Security level that will bypass the DOOR
  87.        !    0                        Security level that will bypass the DOOR
  88.  
  89.        ** = Replace with ONE of the following:
  90.  
  91. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  92. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  93. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  94. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  95. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  96. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  97. C:\BBS\CHAIN.TXT                <- For WWIV systems
  98. C:\BBS\GTUSER.BBS               <- For GT Power
  99.                                    * if using this option you must put the
  100.                                      ComPort # on line 5 and the Node # on
  101.                                      line 6 of the configuration file
  102.  
  103.  
  104.  
  105.         # = Requires registration to change to a different value
  106.         ! = If callers Security level matches any one of these levels,
  107.             the Adopt-A-Door program will NOT run!
  108.  
  109.  
  110.       4) Add ADOPT to the batch file that runs the Door, after whose completion
  111.          you want the ADOPT-A-DOOR message to be displayed. Using Yahtzee as
  112.          the example of the Door we want to run ADOPT after:
  113.  
  114.             ECHO off
  115.             cd\PCB\DOORS\YAHTZEE      Location of Yahtzee files
  116.             YAHTZEE YAHTZEE.CNF       EXE filename and CNF filename
  117.             CD\PCB\DOORS\ADOPT        Location of ADOPT Files
  118.             ADOPT ADOPTYAH.CFG        EXE and UNIQUE .CNF Filename created
  119.                                       in #3 above.
  120.             CD\PCB
  121.             BOARD
  122.  
  123.  
  124.        5) When running in more than one node, be sure to supply a
  125.           different configuration name for each node (your choice of name).
  126.  
  127.        6) If running with multi-port boards add /FD to the line containing
  128.           the CFG name as follows:
  129.  
  130.                         ADOPT Adopt.CFG /FD
  131.  
  132.  
  133.  
  134.                         NON-STANDARD COM SUPPORT
  135.                         ________________________
  136.  
  137.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  138.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  139.       number after the configuration filename. Let's assume your Door is
  140.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  141.       passed to your Door would be:
  142.  
  143.                             FOOBAR FOOBAR.CFG /5
  144.  
  145.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  146.       normally used with COM1. No /x parameter is needed for the standard
  147.       IRQ's.
  148.  
  149.       As an alternative, you may use an environmental variable on the command
  150.       line. To use the variable (following the example above), place a
  151.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  152.       different IRQ number for each node). The command line would now look
  153.       like this:
  154.  
  155.                           FOOBAR FOOBAR.CFG /%IRQ%
  156.  
  157.       This, in combination with the use of the environmental variables
  158.       described in the MULTI-NODE SETUP section will allow you to use one
  159.       batch file and one config file to run this door on all nodes.
  160.  
  161.  
  162.  
  163.  
  164.                            MULTI-NODE SETUP
  165.                            ________________
  166.  
  167.       All Sunrise Doors are Multi-Node capable. Each node must have the
  168.       ability to access a configuration file which will have its own system
  169.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  170.       line. There are 2 ways to accomplish this:
  171.  
  172.       (1) Create a separate configuration file for each node. The only
  173.           difference between each file would be the location of the system
  174.           file for that particular node. For example, on my system there are 2
  175.           nodes and the first line of the config files would look like this:
  176.  
  177.                         NODE1:  H:\PCB1\DOOR.SYS
  178.                         NODE2:  H:\PCB2\DOOR.SYS
  179.  
  180.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  181.  
  182.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  183.           the following PCBoard environmental variables:
  184.  
  185.                  PCBDIR    (Directory containing the System file)
  186.                  PCBDRIVE  (Drive containing the System file)
  187.  
  188.           Thus, the first line of the SINGLE configuration file, for this Door
  189.           would look like this:
  190.  
  191.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  192.  
  193.       NOTE: This option, as described, assumes that you are running PCBoard
  194.             14.5a software. The environmental variables are automatically
  195.             created by the software for each node.
  196.  
  197.             HOWEVER, if you are running other BBS software you should be able
  198.             to set the variables EXACTLY as described below, for EACH node
  199.             (more than likely in each batch file you use to bring up EACH node):
  200.  
  201.                             PCBDRIVE=C:
  202.                             ^^^^^^^^^
  203.                             PCBDIR=\NODE2
  204.                             ^^^^^^^^
  205.  
  206.             Info with a carat (^) under it, MUST be typed as is. The rest
  207.             depends on your naming conventions.
  208.  
  209.             This, in combination with the use of the optional environmental
  210.             variable described in the NON-STANDARD COM SUPPORT section, will
  211.             allow you to use one batch file and one config file to run this
  212.             door on all nodes.
  213.  
  214.  
  215.  
  216.  
  217.                             ADOPT-A-DOOR  CONCEPT
  218.                             _____________________
  219.  
  220.     Having been a Sysop for a number of years, I have had my share of problems
  221.     and frustrations getting financial support for my board's upkeep. A fellow
  222.     Sysop left a message on my board, not long ago, about a concept that was
  223.     being used by several boards around the country.
  224.  
  225.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  226.     would be the same as sending in a donation, only this way it is earmarked
  227.     for registering a particular door. In a way, the user feels he/she is
  228.     "getting something in return". As a Door author I have decided to build
  229.     this concept into each of my Door programs. The concept replaces the
  230.     usual message "tell the Sysop to register this Door" we find in most
  231.     doors.
  232.  
  233.     At the same time I have developed this stand-alone program that will carry
  234.     this concept one step forward so as to be able to use it with any of your
  235.     door programs.
  236.  
  237.  
  238.  
  239.  
  240.                               LEGALITIES
  241.                               __________
  242.  
  243.  
  244.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  245.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  246.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  247.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  248.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  249.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  250.       OR BREACH OF ANY WARRANTY.
  251.  
  252.  
  253.  
  254.  
  255.  
  256.                              DISTRIBUTION
  257.                              ____________
  258.  
  259.    You may make this file available for downloading from your BBS or you may
  260.    upload it to any BBS of your choice, provided that you do not make any
  261.    changes to the contents of the archive (ZIP file). The archive and its
  262.    individual contents may not be used by any service that charges any money
  263.    whatsoever, without the written permission of the author.
  264.  
  265.  
  266.  
  267.  
  268.  
  269.                              REGISTRATION
  270.                              ____________
  271.  
  272.    I am not a subscriber to the "Crippleware" concept, and this program
  273.    reflects that philosophy. This is a full-featured program, whose
  274.    functionality is not hampered in any way, whether you register it or not.
  275.    Registration and the subsequent insertion of the registration number into
  276.    your configuation file, allows for the changing of certain default values
  277.    in the configuration file.
  278.  
  279.    To register your copy of ADOPT, please fill out the registration form
  280.    (REGISTER.FRM) and mail it along with the registraiton fee to
  281.    the name and address on the form. MUST be payable in US funds!!!!
  282.  
  283.    Be sure to use the proper upper/lower case when filling in your name and
  284.    BBS name, as they MUST match the way you entered them in the configuration
  285.    file.             ^^^^
  286.  
  287.    Based upon information supplied on the registration form, I will pre-
  288.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  289.    up your registration number or you may include a self-addressed stamped
  290.    envelope and I will send registration back by return mail.
  291.  
  292.  
  293.  
  294.                                  MISC
  295.                                  ____
  296.  
  297.    The latest version of ADOPT and other fine SUNRISE DOOR programs, are
  298.    always available for download from SUNRISE-80 BBS (404-256-9525 HST 19.2),
  299.    on first call!
  300.  
  301.    Remember, should you have any problems, questions or suggestions, be sure
  302.    to drop me a message on either of the aforementioned BBS or via the DOORS
  303.    conference on PCRELAY (RIME).  NODE=Sunrise
  304.  
  305.  
  306.