Sunrise Door and Home Software Friday November 24, 2017  





ADOPT-A-DOOR 16-Bit Documentation

Download PDF Version

Version 3.5
Author/Contact Al Lawrence/Sunrise Door Software
Overview ADOPT is a stand-alone program that can be executed after every Door program completes and before it returns to your BBS. It will display a message that encourages your callers to donate to the BBS by adopting a given door or group of doors and having his/her name displayed every time the particular door is executed. There are 2 options available with ADOPT:

OPTION 1

UNREGISTERED version, will display a hard-coded (non-changeable) message describing the Adopt-A-Door concept to your callers. The REGISTERED version will allow you to create your own message (15 lines, 62 characters per line).

OPTION 2 Will display the names of the callers (max of 8) that have contributed to the registration of that particular door. This file is an ASCII file you create with the names of the callers (Max 30 char/name). The name of the file is your choice, but the name must match with the name in the configuration file.

NOTE: Most errors will be logged to a file called DFRAME.ERR, which is created in the directory you run the door from.
Installation (1) Create a directory to hold all files
(2) Unzip the archive into the above directory
(3) Add ADOPT to the batch file that runs the Door, after whose completion you want the ADOPT-A-DOOR message to be     displayed. Using Yahtzee as the example of the Door we want to run ADOPT after:

ECHO off
cd\PCB\DOORS\YAHTZEE        Location of Yahtzee files
YAHTZEE YAHTZEE.CFG EXE    filename and CFG filename
CD\PCB\DOORS\ADOPT          Location of ADOPT Files
ADOPT ADOPT.CFG          EXE and UNIQUE .CNF Filename created in #3 above.
CD\PCB
BOARD

(4) When running in more than one node, be sure to supply a different configuration name for each node (your choice of name).

(5) If running with Fossil-based multi-port boards add /FD to the line containing the CFG name in the following example:

ACEY ACEY.CFG /FD

(6) Create a configuration file, with a name of your choice, or modify the supplied CFG file. A description follows:
 

CONFIGURATION FILE

# = Requires registration to change to a different value.


NOTE: There are NO Blank Lines in the Config File!!
** Location of system file (See Below)
SUNRISE BBS Your BBS name
Al Sysop's First name
Lawrence Sysop's Last name
1
1
Comm Port \     These 2 lines are required
      Node # /     ONLY for GTUSER.BBS
00000000 Registration Number
1 1=Initial Message Display
2=Display Callers Names That Contributed
# 201 ASCII Character Used TO Form Message Border
# NONE File Name Containing Contributing Callers
# 30 Number of SECONDS To Keep Message On Screen
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
! 0 Security level that will bypass the DOOR
** Replace with ONE of the following:

C:\bbs\PCBOARD.SYS         <- For PCBoard systems using PCBOARD.SYS only
C:\BBS\CALLINFO.BBS         <- For Wildcat! systems (prior to v3.0)
C:\BBS\DOOR.SYS              <- For ANY systems that support DOOR.SYS
C:\BBS\DORINFOx.DEF        <- For ANY systems that support DORINFOx.DEF
C:\BBS\SFDOORS.DAT        <- For Spitfire systems.
c:\bbs\TRIBBS.SYS             <- For TriBBS systems.
C:\BBS\GTUSER.BBS           <- For GT Power     * if using this option you must put the
                                                                         ComPort # on line 5 and the Node # on
                                                                         line 6 of the configuration file

! = If callers Security level matches any one of these levels, the Adopt-A-Door program will NOT run!

Maintenance None
Troubleshooting (1) If you are running this Door on a 486 system and encounter errors such as

ERROR 6.... OVERFLOW Error
ERROR 5.... ILLEGAL Function Call (may be associated with other problems)
KEYBOARD Timeout after 5 minutes

You may have to put the following line in your AUTOEXEC.BAT file:

SET NO87=ON

(2) If you encounter an Error 62 (Input Past End of File), BEFORE you see the opening screen of the Door, your problem will more than likely be associated with the CFG file. The error 62 means that you do not have enough entries in the CFG. Compare your CFG file with the CFG definition in the DOC file.

(3) If you encounter an ERROR 70... Permission Denied, this will more than likely mean that you DO NOT have SHARE loaded. SHARE is a DOS file that comes with your version of DOS. To load it type the word SHARE at the DOS prompt. To load it permanently type the word SHARE on a line by itself in your AUTOEXEC.BAT file, any place prior to the loading of your BBS
software. There have been numerous reports that loading SHARE high causes some problems, so to be on the safe side, do not load it high.
Non-Standard COM
Support
Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ number after the configuration filename. Let's assume your Door is called FOOBAR and you want to use COM1 and IRQ5. The command line passed to your Door would be:

FOOBAR FOOBAR.CFG /5

The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is normally used with COM1. No /x parameter is needed for the standard IRQ's.

As an alternative, you may use an environmental variable on the command line. To use the variable (following the example above), place a SET IRQ=5 in the batch file used to bring up your BBS (you would need a different IRQ number for each node). The command line would now look like this:

FOOBAR FOOBAR.CFG /%IRQ%

This, in combination with the use of the environmental variables described in the MULTI-NODE SETUP section will allow you to use one batch file and one Configuration file to run this door on all nodes.
Multi-Node Setup All Sunrise Doors are Multi-Node capable. Each node must have the ability to access a Configuration file which will have its own system file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first line. There are 2 ways to accomplish this:

(1) Create a separate configuration file for each node. The only difference between each file would be the location of the system
file for that particular node. For example, on my system there are 2 nodes and the first line of the Configuration files would look like this:

NODE1: H:\PCB1\DOOR.SYS
NODE2: H:\PCB2\DOOR.SYS

Thus, if you have a 4 node BBS, you will need 4 configuration files.

(2) Use ONE configuration file for ALL nodes. This Door will recognize the following PCBoard/Wildcat environmental variables:

PCBDIR (Directory containing the System file)
PCBDRIVE (Drive containing the System file)
WCNODEID (Active Node Number)

Thus, the first line of the SINGLE configuration file, for this Door would look like this:

%PCBDRIVE%%PCBDIR%\DOOR.SYS
c:\wc30\wcwork\node%wcnodeid%\door.sys

NOTE: This option, as described, assumes that you are running PCB or Wildcat software. The environmental variables are automatically created by the software for each node.

HOWEVER, if you are running other BBS software you should be able to set the variables EXACTLY as described below, for EACH node (more than likely in each batch file you use to bring up EACH node):

PCBDRIVE=C:
^^^^^^^^^
PCBDIR=\NODE2
^^^^^^^^

Info with a carat (^) under it, MUST be typed as is. The rest depends on your naming conventions.

This, in combination with the use of the optional environmental variable described in the NON-STANDARD COM SUPPORT section, will allow you to use one batch file and one Configuration file to run this door on all nodes.
Legalities THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
Distribution You may make this file available for downloading from your BBS or you may upload it to any BBS or WEB site of your choice, provided that you do not make any changes to the contents of the archive (ZIP/EXE file). The archive and its individual contents may not be used by any service that charges any money whatsoever, without the written permission of the author.
Registration Registration and the subsequent insertion of the registration number into your configuration file, allows for the display of your BBS name on the opening and closing screen as well as the reduction of a delay built into the opening screen display along with the ability to change certain values in the configuration file.

Once a door is registered, any changes to registration information (Sysop name or BBS Name) will require the doors to be re-registered at the registration fee in effect at that time.

Be sure to use the proper upper/lower case when filling in your name and BBS name, as they MUST match the way you entered them in the configuration file.
Misc. The latest version this product, along with and other fine DOOR and HOME EDITION products are always available for download from this web site.


Moving Eye Line

Moving Eye Line


Last modified: August 11, 2013        Valid XHTML 1.0 Transitional