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