-----------------------------------------------------------------------
 WELCOME
-----------------------------------------------------------------------
Thankyou for trying out my FreeBasic door development kit. This kit is
very simple but should be enough to get you off the ground writing door
games for modern Telnet BBSes.

This has been tested on Linux/Mystic, Windows might work, but is
currently untested.

-----------------------------------------------------------------------
 FUNCTIONS
-----------------------------------------------------------------------

** DoorKitInit(ByVal dropFile As String) As Integer

Call this function first, and pass it the full path and filename of the
drop file, currently this must be a DOOR.SYS drop file.

** DoorKitGetUserAlias() As String

Returns the User's Handle or Alias

** DoorKitGetFirstName() As String

Returns the User's First Name

** DoorKitGetLastName() As String

Returns the User's Last Name

** DoorKitSendFile(ByVal fileName As String) As Integer

Send an ANSI Graphics file. This function is SAUCE aware and will strip
any SAUCE tags off.

** DoorKitPrint(ByVal s as String) As Integer

Print a string, the following embedded macros are defined:

	`black`         - change the foreground to black
	`red` 		    - change the foreground to red
	`green`			- change the foreground to green
	`yellow`		- change the foreground to yellow
	`blue`			- change the foreground to blue
	`magenta`		- change the foreground to magenta
	`cyan`			- change the foreground to cyan
	`white`			- change the foreground to white
	`bright black`	- change the foreground to bright black
	`bright red`	- change the foreground to bright red
	`bright green`	- change the foreground to bright green
	`bright yellow`	- change the foreground to bright yellow
	`bright blue`	- change the foreground to bright blue
	`bright magenta`- change the foreground to bright magenta
	`bright cyan`	- change the foreground to bright cyan
	`bright white`	- change the foreground to bright white
	
** DoorKitPrintLn(ByVal s as String) as Integer

Same as DoorKitPrint but appends a newline sequence.

** DoorKitClearScreen() as Integer

Clears the screen (and Homes the cursor)

** DoorKitGetLine(ByVal length as Integer) as String

Retrieves a string up to a certain length from the user

** DoorKitGetLocation() As String

Returns the user's location

** DoorKitGetSysopName() As String

Returns the Sysop's name

** DoorKitGetNode() As Integer

Returns the node number

** DoorKitGetBirthday() As String

Returns the user's birthday as a string

** DoorKitGetSecLevel() As Integer

Returns the user's security level

** DoorKitGetSecondsLeft() As Integer

Returns the number of seconds left the user had when entering the door.
