Word Stairway 16-Bit Documentation

Version	2.1
Author/Contact	Al Lawrence/Sunrise Door Software
Overview	STAIRWAY is a VERY challenging word game that will put your vocabulary skills to the test. The computer selects the starting letter and the player must make words ranging from 2-7 letters in length. A rather extensive Dictionary is included! NOTE: Most errors will be logged to a file called DFRAME.ERR, which is created in the directory you run the door from.
Non-Registered Restrictions	- No Bulletins created - Games per day limited to 2 - Keyboard timeout value limited to 2 minutes - Makeup days disabled - Game time limit disabled - Extra Points disabled - Bonus Value must be 1000 points - Can not send/receive messages to/from other players
Installation	(1) Create a directory to hold all files (2) Unzip the archive into the above directory (3) Create a batch file or modify the batch file supplied. An example description of this file follows: ECHO off cd\PCB\DOORS\ACEY Location of ACEY files ACEY ACEY.CFG filename and CFG filename (Name used in creating file 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
	# 2	Keyboard timeout value in Minutes
	! # 2	Maximum # of Games per day (MAX=99)
	# 0	Max # of days a caller can make up, during calls in one day. 0=Disable Make-up Option Maximum value = 27, Minimum value = 1
	# N	Automatic game reset at end of month: Y = Yes enable auto reset N = Keep accumulating scores
	! # 0	Time Allowed in Door (Sysop = Time Remaining)
	2	*** FUTURE ****
	# NONE	Drive:\Path\Filename to contain the Top Score Bulletin or enter NONE for NO Bulletin creation.
	# NONE	Drive:\Path\Filename to contain the Top Score Bulletin (Color) or enter NONE for NO Bulletin creation.
	# NONE	Drive:\Path\Filename to contain the Hall of Fame Bulletin or enter NONE for NO Bulletin creation.
	# NONE	Drive:\Path\Filename to contain the Hall of Fame Bulletin (Color) or enter NONE for NO Bulletin creation.
	# Y	Y = Allow Sysop to have 26 games N = Do Not Allow Sysop 26 games
	# 1000	Bonus earned if ALL Stairs are completed
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	000=00/00	*** FUTURE ****
	XXXX/YYYY	*** FUTURE ****
	XXXX/YYYY	*** FUTURE ****
	XXXX/YYYY	*** FUTURE ****
	XXXX/YYYY	*** FUTURE ****
	XXXX/YYYY	*** FUTURE ****
	000	Unique 3-digit number used as a suffix for the exported score file name, if you wish to participate in an Inter-BBS game. 000=no Inter-BBS participation.
	N	Y = Force Caller to respond to Instructions <y/n). May need this with Digiboards. N = Allow caller to press ENTER in response to Instructions <y/N>
	0	Use this option to LIMIT the number of HIGH SCORE entries to be displayed. A ZERO(0) = NO LIMIT
	0	Number of months to keep in the SUNHOF files (Hall of Fame). 0 = ALL
	N	Y = Use Alias for Caller's name (Requires Door.Sys) N = Use Logon Name for Caller's name
	# Y	Y = Allow Messages to be sent/received N = Do NOT allow messages to be sent/read
	Y	Y = Log all callers to USAGEx N = Do not log callers
	G	Door Rating. Default is G. Maximum Characters: 5
	** 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 fileclass

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.
Usage Log	As an option, we provide you with the ability to log every player to a text file. IF you enter Y in the CFG file to log callers, the Door will place the caller's name as well as the ON and OFF times each time a caller selects the Door. A separate file will be created for each Node and the name of the file will be USAGEx, where x is the Node number. You may delete these files at any time and the Door will recreate them the next time a caller enters the Door. If you do NOT want to continue logging callers, change the CFG file entry to N.
Make-Up-Days	The Make-Up-Day feature allows the caller to make up any plays he/she missed during the current month and prior to the current call. You control whether to allow this option, as well as the number of days the caller can make up, on any particular days worth of calls. Entering a 0 (zero) for this option, in the configuration file, turns the option OFF, any other value (up to a max of 27) turns the option ON and dictates the number of days the caller can make up. NOTE: The number of games per day is calculated as follows... Games Allowed per day x Number of makeup days. Example: Games Allowed per day = 2 Max # of makeup days = 4 If a caller logs in on 5/8/01 and this is their first call of the month, they would have a potential of 16 games to makeup and bring them current (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8 (games allowed * max # of makeup days).
Hall Of Fame Bulletins	The program will automatically reset the game when the first caller of the month plays the game. The score file will be cleared and a Hall of Fame file will be created. The file will be called SUNHOF.SCO. The files will be placed in the Door directory. This file is written with WC @ codes and will display in color or black and white depending on the callers' setting. WARNING: The HOF file is a cumulative file. That means it is read in each month and updated. DO NOT DELETE THE FILE!!!! or you will lose the record of prior months winners!!!!
Player-to-Player MESSAGES	In the REGISTERED version of the Door, your players will be able to send messages back and forth to each other. All messages are PRIVATE and all messages are maintained within the Door itself and has no connection to the BBS' message bases. The Message file (PAIR3.MSG) will be restarted when the Door game restarts at the beginning of each month. If you do not restart your games on the first of each month then you must manually delete the MSG file. The file will continue to grow if not deleted and restarted.
InterBBS Option	The Inter-BBS option is used when you are looking for a way to expand the competition beyond just running it on your BBS alone. With this option you can join with any number of other BBS' to create some very 'heated' scoring competition and exchange messages. The Inter-BBS option has its own High Score file and when High Scores are displayed, on participating BBS', the name of the BBS on which the score was obtained will also be displayed. At the end of the month, the Inter-BBS scores will be reset automatically and a winner will be determined and displayed as part of the High Score display in the next month. This option requires that the Door be registered. The InterBBS files (EXE, HIS, DOC, etc) can be found in the included file called IBBSxx.ZIP (xx = version). Updates to this file will always be found on our WEB site. The Inter-BBS option uses the 'HUB' and 'NODE' concept. The 'HUB' is the central/controlling BBS to whom all the other BBS' ('NODES') upload/transfer their score files. The 'HUB' then merges all score files and makes a merged file available for the 'NODES' to download/transfer.
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.

WORD STAIRWAY 16-Bit Documentation