Synchronet External Program Configuration Documentation
-------------------------------------------------------

Synchronet has been designed to eliminate the need for batch files and
data file conversion programs to run external programs (door) on your BBS.
Synchronet supports many different data file types (listed below):

Software	File Name(s)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GAP		DOOR.SYS (IN and OUT)
WWIV		CHAIN.TXT
RBBS/QuickBBS	DORINFO#.DEF and EXITINFO.BBS (IN and OUT)
Wildcat! 2.x	CALLINFO.BBS
PCBOARD.SYS	PCBOARD.SYS and USERS.SYS (IN and OUT)
MegaMail	UTIDOOR.TXT
Solar Realms	DOORFILE.SR
Synchronet	XTRN.DAT and MODUSER.DAT (IN)

*******************
Call-back Verifiers
*******************
Call-back verification and user upgrade programs for other BBS packages may be
used, as long as the program supports the DOOR.SYS, EXITINFO.BBS, USERS.SYS,
or MODUSER.DAT file format. To allow a program to modify the user data, you
must set the option "Modify User Data" to "Yes". The following user data
items may be updated with the following formats:

DOOR.SYS:	Main Level, Main Flags, Expiration Date, and Minutes
EXITINFO.BBS:	Main Level and Main Flags
USERS.SYS:	Main Level and Expiration Date
MODUSER.DAT:	Main Level, Transfer Level, Main Flags, Transfer Flags,
		Exemptions, Restrictions, Expiration Date, and Credits

*********************************
Installing a New External Program
*********************************
Install your new external program into a sub-directory off your XTRN directory.

Example: C:\SBBS\XTRN\TRADEWAR

If your program asks you to provide the directory where the BBS software is
installed or where the data file will be located, enter the directory where
you have installed the program (C:\SBBS\XTRN\TRADEWAR). Note: this is usually
only required for programs that do NOT support multiple nodes.

**********************************
Configuring a New External Program
**********************************
Run SCFG from any NODE directory (or hit 'C' at the Waiting For Call screen).
Select "External Programs" and hit enter. Now select "Online Programs" and
hit enter. Move the lightbar to the location where you would like your new
program to appear on the list (with ARROWS, HOME, or END keys). Hit the
INSERT key. Enter a description for your new external program.

Example: Trade Wars 2002

Now your new external program appears in the list. Hit ENTER to edit the
configuration for this program.

Start-up Directory
~~~~~~~~~~~~~~~~~~
The start-up directory will be the current directory when the program is
started. Move the lightbar down to "Start-up Directory" and hit ENTER. Enter
the path to the directory where you installed your program.

Example: ..\XTRN\TRADEWAR

     or: C:\SBBS\XTRN\TRADEWAR

Command Line
~~~~~~~~~~~~
Now move the ligtbar down to "Command Line" and hit ENTER. Now enter the
command to execute your external program. If the path and filename for the
BBS data file is required on the command line, use %f to represent the
path and filename. See SPECS.DOC for other available command line specifiers.

Example: radgame %f

Clean-up Command Line
~~~~~~~~~~~~~~~~~~~~~
If your external program requires a clean-up command line (usually only
multiuser programs), select "Clean-up Command Line" and enter the required
command line for your program. Note: Most programs do NOT require this option.

Cost in Credits
~~~~~~~~~~~~~~~
If you wish your users to be charged credits when running this program, select
"Cost in Credits" and enter the required amount. Users with the 'X' exemption
will not be charged.

Minimum Age
~~~~~~~~~~~
If you wish to limit the age of users who have access to this program, select
"Minimum Age" and enter the minimum required age.

Minimum Main Level and Required Main Flags
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you wish to limit which users have access to this program by Main Level
or Main Flag(s), select and set those options accordingly.

ANSI Required
~~~~~~~~~~~~~
If ANSI terminal emulation is required for this program, select "ANSI Required"
and set this option to "Yes".

Multiuser
~~~~~~~~~
If this program supports multiple simultaneous users, select "Multiuser" and
set this option to "Yes".

Intercept I/O Interrupts
~~~~~~~~~~~~~~~~~~~~~~~~
If this program does NOT have it's own modem communications I/O and does NOT
use a FOSSIL driver, select "Intercept I/O Interrupts" and set it to "Yes".
Note: Most programs require this option be set to "No". Programs written
specifically for WWIV or Synchronet BBS software, should usually have this
option set to "Yes". Consult the documentation for the program if you are
unsure. If you do set this option to "Yes", and the program was not written
specifically for Synchronet, you'll need to place the following string at
the BEGINNING of your comand line: "%!dcdwatch %&".

Example: %!dcdwatch %& foodfite %f

Without the use of the DCDWATCH, the program will hang if a user drops
carrier (hangs-up) while using the program.

Shrink BBS
~~~~~~~~~~
If this program requires a large amount of free memory, you'll probably want
to select "Shrink BBS" and set it to "Yes". This causes Synchronet to shrink
to 16k before executing the program, giving it much more available RAM.
Programs that use WWIV color codes (native WWIV programs) can not be used
in conjunction with the "Shrink BBS" option.

Modify User Data
~~~~~~~~~~~~~~~~
If this program can modify the current user's data through one of the
supported data file types (see Call-back Verifiers above), select "Modify
User Data" and set it to "Yes".

Uses WWIV Color Codes
~~~~~~~~~~~~~~~~~~~~~
If this program uses WWIV color codes, you'll need to set both "Uses WWIV
Color Codes" and "Intercept I/O Interrupts" to "Yes". Don't forget to use
DCDWATCH in your command line. See "Intercept I/O Interrupts" for more
information on how to use DCDWATCH.

Execute on Event
~~~~~~~~~~~~~~~~
If you want this program to run automatically during user logon, logoff,
new user application, or a user's birthday, use this option to select
the desired event.

Menu Command Keys
~~~~~~~~~~~~~~~~~
If you would like the program to be able to be executed from the Main or
Transfer prompts, use this option to define the key to start the event
from one or both prompts.

BBS Data File Type
~~~~~~~~~~~~~~~~~~
If your program requires a BBS data file (most do), use this option to
select the type of data file to create. After selecting the data file type,
you will be prompted for the directory you want the file to be created in.
In general, for multiuser programs or programs that can have the path and
filename of the data file included on the command line, select the
"Node Directory". For single user programs that require the data file to
be in the current directory, select "Start-up Directory". The location for
the data file is specified on this option line with a (N) for node directory
or (S) for start-up directory.

**********************************
Examples for some popular programs
**********************************

Trade Wars 2002 v1.03
~~~~~~~~~~~~~~~~~~~~~
Start-up Directory		..\XTRN\TRADEWAR
Command Line			tw2002
Clean-up Command Line
ANSI Required			Yes
Multiuser			No
Intercept I/O Interrupts	No
Shrink BBS			Yes
Modify User Data		No
Uses WWIV Color Codes		No
BBS Data File Type	    (S) WWIV		CHAIN.TXT

Notes: Be sure to install in XTRN\TRADEWAR and NOT XTRN\TRADEWAR\TRADEWAR.
       Does not work with non-standard COM ports.
       Slow under DESQview due to non-interrupt driven output.
       If running multiple nodes with a combination of high-speed and low-speed
       modems, contact Digital Dynamics for necessary patch program
       information.

Barren Realms Elite
~~~~~~~~~~~~~~~~~~~
Start-up Directory		..\XTRN\BRE
Command Line			bre
Clean-up Command Line
ANSI Required			No
Multiuser			No
Intercept I/O Interrupts	No
Shrink BBS			Yes
Modify User Data		No
Uses WWIV Color Codes		No
BBS Data File Type	    (S) Solar Realms	DOORFILE.SR

Notes: Delete BRE.BAT from your XTRN\BRE directory after running INSTALL.
       Edit RESOURCE.DAT for use with non-standard COM ports.

Food Fight (for WWIV)
~~~~~~~~~~~~~~~~~~~~~
Start-up Directory		..\XTRN\FOOD
Command Line			%!dcdwatch %& foodfite %f
Clean-up Command Line
ANSI Required			No
Multiuser			No
Intercept I/O Interrupts	Yes
Shrink BBS			No
Modify User Data		No
Uses WWIV Color Codes		Yes
BBS Data File Type	    (N) WWIV		CHAIN.TXT

Phantasia
~~~~~~~~~
Start-up Directory		..\XTRN\PHANT
Command Line			phant %f PORT:%u:%i
Clean-up Command Line
ANSI Required			Yes
Multiuser			Yes
Intercept I/O Interrupts	No
Shrink BBS			Yes
Modify User Data		No
Uses WWIV Color Codes		No
BBS Data File Type	    (N) GAP		DOOR.SYS

Global War
~~~~~~~~~~
Start-up Directory		..\XTRN\GWAR
Command Line (single node)	war /w %f
Command Line (multiple nodes)	war /w %f /n war%#.cfg
Clean-up Command Line
ANSI Required			Yes
Multiuser			Yes
Intercept I/O Interrupts	No
Shrink BBS			Yes
Modify User Data		No
Uses WWIV Color Codes		No
BBS Data File Type	    (N) WWIV		CHAIN.TXT

Notes: If running multiple nodes, must create a WARx.CFG for each node
       (x is node number) in your XTRN\GWAR directory.
       Example: WAR1.CFG, WAR2.CFG, WAR3.CFG etc.

/* End of XTRN.DOC */

