home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / BUYDOR12.ZIP / BUYADOOR.DOC < prev    next >
Text File  |  1993-09-14  |  15KB  |  360 lines
  1.  
  2.  
  3.                             Buy-A-Door
  4.  
  5.                               v1.2
  6.  
  7.                                by
  8.  
  9.                           Mike Liddekee
  10.  
  11.                             
  12.                            Support BBS
  13.                          Prime Base BBS
  14.                          (804) 587-4289
  15.                          (804) 587-4382
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                             OVERVIEW
  23.                             --------
  24.  
  25. Buy-A-Door is a stand-alone program that can be executed after
  26. every Door program completes and before it returns to your BBS. 
  27. It will display a message that encourages your callers to donate
  28. to the BBS by adopting a given door or group of doors and having
  29. his/her name displayed every time the particular door is
  30. executed. There are 2 options available with Buy-A-Door:
  31.  
  32.    OPTION 1, UNREGISTERED version, will display a hard-coded      
  33.    (non-changeable) message describing the Adopt-A-Door concept   
  34.    to your callers. The REGISTERED version will allow you to      
  35.    create your own message (10 lines, 62 characters per line).
  36.  
  37.    OPTION 2 will display the names of the callers (max of 6) that 
  38.    have contributed to the registration of that particular door.  
  39.    This file is an  ASCII file you create with the names of the 
  40.    callers (Max 30 char/name). The name of the file is your       
  41.    choice, but the name must match with the name in the           
  42.    configuration file.  
  43.  
  44.  
  45.  
  46.   
  47.  
  48.  
  49. NOTE: Runtime errors will be logged to a file called DFRAME.ERR   
  50.       which is created in the directory you run the door from.
  51.  
  52.  
  53.  
  54.      
  55.                           INSTALLATION
  56.                           ------------
  57.  
  58. Installation is fairly easy and straight-forward. The following
  59. steps and examples should have you up and running in a very short
  60. period of time.  It is assumed that you are familiar with setting
  61. up DOORS on your system.  To this end, only examples of the
  62. configuration file and Door batch file are described.
  63.  
  64.       1) Create a directory to hold all Buy-A-Door files
  65.  
  66.       2) Unzip ADPTMExx.ZIP into the the above directory
  67.  
  68.       3) Create a configuration file, with a name of your choice, 
  69.          or modify the supplied BUYDOOR.CFG file. A description     
  70.          follows:
  71.  
  72.         *   C:\PCB\DOOR.SYS          Location of system files     
  73.                                      (see below)
  74.             The Playroom BBS         Your BBS Name
  75.             Mike                     Sysop's First Name
  76.             Liddekee                 Sysop's Last Name
  77.  
  78. |---------------------------------------------------------------|
  79. | READ!     1          CommPort  \ These 2 lines are required   |
  80. | READ!     1          Node #    / ONLY for GTUSER.BBS          |
  81. |---------------------------------------------------------------|
  82.  
  83.         $   1                        1=Initial Message Display
  84.                                      2=Display Callers Names That 
  85.                                        Contributed
  86.         $   ADOPT.DOR                File Name Containing Initial 
  87.                                      Display
  88.         $   THANK.YOU                     File Name Containing    
  89.                                           Contributing Callers
  90.         $   30                       Number of SECONDS To Keep    
  91.                                      Msg On Screen
  92.       ! $   0                        Security level that will     
  93.                                      bypass the DOOR
  94.       ! $   0                        Security level that will     
  95.                                      bypass the DOOR
  96.       ! $   0                        Security level that will     
  97.                                      bypass the DOOR
  98.       ! $   0                        Security level that will     
  99.                                      bypass the DOOR
  100.       ! $   0                        Security level that will     
  101.                                      bypass the DOOR
  102.         $   N                        Enable credit card feature 
  103.         
  104.         * = Replace with ONE of the following:
  105.  
  106. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using      
  107.                                    PCBOARD.SYS only
  108. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to 
  109.                                    v3.0)
  110. C:\BBS\DOOR.SYS                 <- For ANY systems that support   
  111.                                    DOOR.SYS 
  112. C:\BBS\DORINFOx.DEF             <- For ANY systems that support   
  113.                                    DORINFOx.DEF
  114. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  115. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  116. C:\BBS\GTUSER.BBS               <- For GT Power (if using this    
  117.                                    option you must put the        
  118.                                    ComPort # on line 5 and the    
  119.                                    Node # on line 6 of the        
  120.                                    configuration file)
  121.  
  122.  
  123.  
  124.         $ = Requires registration to change to a different value
  125.         ! = If callers Security level matches any one of these    
  126.         levels, Buy-A-Door will bypass the registeratio screens
  127.  
  128.  
  129.       4) Add Buy-A-Door to the batch file that runs the Door,      
  130.          after whose completion you want the Buy-A-Door message    
  131.          to be displayed. An example of the Door we want to run   
  132.          Buy-A-Door after:
  133.  
  134.             ECHO OFF
  135.             CD\PCB\DOORS\PROGRAM      Location of Door Files
  136.             DOOR DOOR.CFG             EXE filename and CFG        
  137.                                       filename
  138.             CD\PCB\DOORS\BUYADOOR      Location of ADOPT Files
  139.             BUYADOOR BUYADOOR.CFG      EXE and CFG Filename        
  140.                                       created in #3 above.
  141.             CD\PCB
  142.             BOARD
  143.  
  144.  
  145.        5) When running in more than one node, be sure to supply a
  146.           different configuration name for each node (your choice 
  147.           of name).
  148.  
  149.        6) If running with multi-port boards add /FD to the line   
  150.           containing the CFG name as follows:
  151.  
  152.                     Buyadoor Buyadoor.CFG /FD
  153.  
  154.                   
  155.                       CREDIT CARD FEATURE
  156.                       -------------------
  157.  
  158.        Buy-A-Door now allows users to make donations with a credit 
  159.        card.  To set up this feature you must do the 
  160.        following:
  161.  
  162.                1. Edit the last line of the CFG file.  Change this
  163.                   setting to "Y" minus the quotes.
  164.  
  165.                2. Create a file called CCARD.CFG.  This file contains
  166.                   10 lines.  You must enter the name of the card or
  167.                   cards that you support on each line.  If you don't
  168.                   have 10 cards you must enter NONE on the remaining
  169.                   10 lines.  You're only allowed to enter a desc. of
  170.                   up to 15 characters on each line.
  171.  
  172.        And you're ready to go!  All donations will be written to a 
  173.        file in the Buy-A-Door directory called DONATION.TXT.
  174.        
  175.  
  176.                     NON-STANDARD COM SUPPORT
  177.                     ________________________
  178.  
  179.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 =     
  180.       IRQ4 and COM2/COM4 = IRQ3. If you wish to use a             
  181.       non-standard IRQ, add the IRQ number after the              
  182.       configuration filename. Let's assume your Door is called    
  183.       FOOBAR and you want to use COM1 and IRQ5. The command line
  184.       
  185.       passed to your Door would be:
  186.  
  187.                       FOOBAR FOOBAR.CFG /5
  188.  
  189.       The /5 tells FOOBAR to use IRQ5 rather than the standard    
  190.       IRQ4 that is normally used with COM1. No /x parameter is    
  191.       needed for the standardIRQ's.
  192.  
  193.       As an alternative, you may use an environmental variable on 
  194.       the command line. To use the variable (following the        
  195.       example above), place a SET IRQ=5 in the batch file used to 
  196.       bring up your BBS (you would need a different IRQ number    
  197.       for each node). The command line would now look like this:
  198.  
  199.                     FOOBAR FOOBAR.CFG /%IRQ%
  200.  
  201.       This, in combination with the use of the environmental      
  202.       variables described in the MULTI-NODE SETUP section will    
  203.       allow you to use one batch file and one config file to run  
  204.       this door on all nodes.
  205.  
  206.  
  207.  
  208.  
  209.                            MULTI-NODE SETUP
  210.                            ________________
  211.  
  212.       Buy-A-Door Multi-Node capable. Each node must have the
  213.       ability to access a configuration file which will have its  
  214.       own system file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc)  
  215.       defined on the first line. There are 2 ways to accomplish   
  216.       this:
  217.  
  218.       (1) Create a separate configuration file for each node. The 
  219.           only difference between each file would be the location 
  220.           of the system file for that particular node. For        
  221.           example, on my system there are 2 nodes and the first   
  222.           line of the config files would look like this:
  223.  
  224.                         NODE1:  C:\PCB1\DOOR.SYS
  225.                         NODE2:  C:\PCB2\DOOR.SYS
  226.  
  227.           Thus, if you have a 4 node BBS, you will need 4         
  228.           configuration files.
  229.  
  230.       (2) Use ONE configuration file for ALL nodes. This Door     
  231.           will recognize the following PCBoard environmental      
  232.           variables:
  233.  
  234.                  PCBDIR    (Directory containing the System file)
  235.                  PCBDRIVE  (Drive containing the System file)
  236.  
  237.           Thus, the first line of the SINGLE configuration file,  
  238.           
  239.           for this Door would look like this:
  240.  
  241.                    %PCBDRIVE%%PCBDIR%\DOOR.SYS
  242.  
  243.       NOTE: This option, as described, assumes that you are       
  244.       running PCBoard 14.5a software. The environmental variables 
  245.       are automatically created by the software for each node.
  246.  
  247.       HOWEVER, if you are running other BBS software you should   
  248.       be able to set the variables EXACTLY as described below,    
  249.       for EACH node (more than likely in each batch file you use  
  250.       to bring up EACH node):
  251.  
  252.                             PCBDRIVE=C:
  253.                             ^^^^^^^^^
  254.                             PCBDIR=\NODE2
  255.                             ^^^^^^^^
  256.  
  257.       Info with a carat (^) under it, MUST be typed as is. The    
  258.       rest depends on your naming conventions.  This, in          
  259.       combination with the use of the optional environmental
  260.       variable described in the NON-STANDARD COM SUPPORT section, 
  261.       will allow you to use one batch file and one config file to 
  262.       run this door on all nodes.
  263.  
  264.  
  265.  
  266.                            LEGALITIES
  267.                            __________
  268.  
  269.  
  270.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED    
  271.       "AS IS" WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY,    
  272.       INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF      
  273.       MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO 
  274.       EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND           
  275.       PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  276.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE   
  277.       THEREOF OR BREACH OF ANY WARRANTY.
  278.  
  279.  
  280.  
  281.                           DISTRIBUTION
  282.                           ____________
  283.  
  284.    You may make this file available for downloading from your BBS 
  285.    or you may upload it to any BBS of your choice, provided that  
  286.    you do not make any changes to the contents of the archive     
  287.    (ZIP file). The archive and its individual contents may not be 
  288.    used by any service that charges any money whatsoever, without 
  289.    the written permission of the author.
  290.  
  291.  
  292.  
  293.                           REGISTRATION
  294.                           ____________
  295.  
  296.    I am not a for "Crippleware" concept, and this program reflects 
  297.    that feeling. This is a full-featured program, whose functionality 
  298.    is not hampered in any way, whether you register it or not.  
  299.    Registration and the receipt of your KEY file into the Buy-A-Door 
  300.    directory allows for the changing of certain default values in the 
  301.    configuration file.                                          
  302.         
  303.    To register your copy of Buy-A-Door, please fill out the registration 
  304.    form (REGISTER.FRM) and mail it along with the registraiton fee to 
  305.    the name and address on the form. MUST be payable in US funds!!!!
  306.  
  307.    Be sure to use the proper upper/lower case when filling in     
  308.    your name and BBS name, as they MUST match the way you entered 
  309.    them in the configuration file. ^^^^ 
  310.  
  311.    You will then be able to call Prime Base and receive your KEY file.
  312.    Leave a message to Mike Liddekee requesting your key and I will make 
  313.    it available to you in a private message or you may include $5 and 
  314.    I will send you the KEY file back by return mail along with the 
  315.    latest version of Buy-A-Door.
  316.  
  317.  
  318.                               MISC
  319.                               ____
  320.  
  321.    The latest version of Buy-A-Door and other fine door programs,  
  322.    are always available for download from Prime Base BBS at 
  323.    (804) 256-587-4289 or (804) 587-4382 .  Join conference #1 to
  324.    download the latest releases.  You may also download doors by
  325.    William Rountree, sysop of Prime Base BBS
  326.  
  327.    Remember, should you have any problems, questions or           
  328.    suggestions, be sure to drop me a message on the              
  329.    aforementioned BBS or call me voice at (501) 268-1431 anyday!
  330.  
  331.    This program is also available on the following BBSes:
  332.  
  333.         Salt Air     -  810-261-8974 / 8975 / 8976
  334.         Wildcat HQ   -  805-395-0650
  335.         Com-Dat BBS  -  503-681-0543 / 640-0278
  336.  
  337.    as well as many more fine BBS around the country.
  338.  
  339.  
  340.                         ACKNOWLEDGEMENTS
  341.                         ----------------
  342.  
  343.    I would like to thank the following for their help with my 
  344.    programming:
  345.  
  346.         William Rountree - Without his help this and other 
  347.                            programs would not be possible and
  348.                            for allowing me to use his BBS as
  349.                            my support board
  350.                            Thanks William!!
  351.  
  352.         Cam DeBuck       - For his help with some of the coding.
  353.                            Thanks Cam!!
  354.  
  355.         Mike Jordan      - For helping distribute the program 
  356.                            around.  Thanks Mike!!
  357.    
  358.    
  359.    And to the late Ted Freeman for an outstanding Door Library.
  360.