Word Shuffle 16-Bit Documentation

Version	3.4
Author/Contact	Al Lawrence/Sunrise Door Software
Overview	Word Shuffle is a word game whereby the computer has scrambled the letters of a word and you must unscramble it to make points. The game is pretty straight forward and the package also contains a program which add new puzzles to the database and as an event, will create new puzzles and start a new game, as soon as a pre-determined number of players have solved all the puzzles. This is done automatically, all you must do is ensure that there are an adequate supply of puzzles in the database. The same program used in the event process is the same one you will use to add words to the database. 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) 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
	! # 1	Number of plays per day/caller (1-3)
	# 0	Keyboard timeout value in Minutes
	50	Number of entries in the Top Score file
	# 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.
	# 20	Number of puzzles comprising the game(QUE)
	2	1 = DO NOT Display ADOPT-A-DOOR Message 2 = Display ADOPT-A-DOOR message
	3	The number of players that must complete all puzzles, before the puzzles are changed automatically by SHUFWORD, in your nightly event processing.
	! # 0	Time Allowed in Door (Sysop = Time Remaining)
	# Y	Y = Allow Sysop to have 999 games N = Do Not Allow Sysop 999 games
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	! # 000=00/00	Security Level/Games Allowed Per Day
	@ # XXXX/YYYY	Blackout Range From/To
	@ # XXXX/YYYY	Blackout Range From/To
	@ # XXXX/YYYY	Blackout Range From/To
	@ # XXXX/YYYY	Blackout Range From/To
	@ # XXXX/YYYY	Blackout Range From/To
	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>
	N	Y = Use Alias for Caller's name (Requires Door.Sys) N = Use Logon Name for Caller's name
	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 file ! = See "Plays Per Day" Below @ = See "Blackout Periods" Below

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.
Blackout Periods	Use the Blackout ranges option to define up to 5 time periods during which you DO NOT want the Door to be played. If a caller tries to access the Door during the Blackout period, they will be shown a message that contains ALL the Blackout periods you have defined, and to try the Door at a later time. Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where XXXX=beginning time and YYYY=the ending time. For example, 0930/1230 means to NOT allow the Door to be played between 9:30am and 12:30pm. IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format - DO NOT change the XXXX/YYYY entry UNLESS you want to assign a Blackout range. - You MUST use the MILITARY time format. Example: 2030=8:30pm 0900=9am, 0030=12:30am, 1700=5pm, etc.
Plays Per Day/Door Time	Plays Per Day and Door Time can be controlled several ways: (1) You can use the Games Per Day, singular option, in the Configuration file above. This option, will affect ALL callers whose Security Level is NOT defined in any of the 10 optional Security Level/Plays Per Day entries in the Configuration file. (2) You can use the Door Time, singular option, in the Configuration file above. This option, will affect ALL callers whose Security Level is NOT defined in any of the 10 optional Security Level/Plays Per Day/Door Time entries in the Configuration file. (3) You can restrict the number of games a specific Security Level will be allowed to play per day or REWARD specific Levels with more Plays Per Day. Likewise, you can restrict the Play time for a specific Security Level or REWARD specific Levels with more Door Time. These options are handled by the use of the 10 Configuration entries (000=00/00). The format of each entry is as follows: XXX=YY/ZZ where XXX is the Security Level (must be 3 digits) where = is a constant and MUST be included where YY is the # of games per day (must be 2 digits) where / is a constant and MUST be included where ZZ is num. minutes per Door entry (must be 2 digits) If the callers Security Level is NOT defined, his/her Plays Per Day and Door Time will be controlled by the values in items (1) and (2) above, respectively. You may define up to 10 Security Levels. All unused entries must be defined as 000=00/00 -------------------------------------------------------------------- Example: Suppose you had 3 Security Levels defined on your BBS as (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you wanted to set Plays Per Day as : Subscriber=5 Visiting Sysop=2 CoSysop=3 Friend=10 and Door Time as follows: Subscriber=30 minutes Visiting Sysop=20 minutes CoSysop=10 minutes Friend=remaining call time You would set the Individual "Games per Day" Configuration entry to 1 and the individual "Door Time" to 5 minutes (these would be the default number of games and default Time for all Security Levels other than 20,30 or 40... make them any number you want). Next you would replace 4 of the Security Level entries as : 020=05/30 030=02/20 040=03/10 090=10/0
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.
Adopt-A-Door	The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It would be the same as sending in a donation, only this way it is earmarked for registering a particular door. In a way, the user feels he/she is "getting something in return". As a Door author I have decided to build this concept into each of my Door programs. The concept replaces the usual message "tell the Sysop to register this Door" we find in most doors. If the Door is unregistered then a message appears on the opening screen to that effect. After finishing or suspending a game, a message screen is displayed about the ADOPT-A-DOOR concept. The message also tells the caller to contact the Sysop to find out if there is any further details to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online time, etc to callers that ADOPT-A-DOOR. If the Door has been registered, either by the Sysop or other callers, the names of those contributors will be displayed in the closing screen. NOTE: If you want to display the names of the callers that contributed to registering the Door, you must create an ASCII file called ADOPT.SYS. You create it with an ASCII text editor. Enter the names of the contributors (one on each line, maximum of 5 entries, each a maximum of 30 characters long). This file must be saved, in ASCII format, and placed in the Door directory.
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 SHUFFLE 16-Bit Documentation