Word Shuffle WINServer Documentation

Version	1.6
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 maintenance program to add new puzzles to the database or change the current set of puzzles. When run as an event, it 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 when run via an EVENT process. All you must do is ensure that there is 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.
Non-Registered Restrictions	- No Bulletins created - Puzzles per day limited to 1 - Game time limit disabled - Puzzle Database limited to 5 puzzles at any time
Installation	(1) Create a directory to hold all files (2) Unzip the archive into the above directory (3) MOVE the WCX file to your WC5 directory and delete it from the directory created in step (1) (4) Create a menu entry to run the wcBASIC Door and you MUST pass the FULL drive:\path of the directory as a command line parameter when defining the Door on the menu. An example follows: Program Name: SHUFFLE Parameter: c:\wc5\doors\SHUFFLE (5) Modify the supplied CFG file. A description follows:

CONFIGURATION FILE
# = Requires registration t o change to a different value. ** = You can allow certain security levels to play a specific number of times per day instead of the default number specified previously in the CFG file. The format of each line is: SECURITY LEVEL=NUMBER of GAMES (Ex: SYSOP=5) NOTE: There are NO Blank Lines in the Config File!!	SUNRISE-80 BBS	Your BBS Name
	Al Lawrence	Sysop's First AND Last name
	00000000	Registration Number
	# 2	# of puzzles presented to caller each day
	Y	Y = Log all callers to USAGEx N = Do not log callers
	2	1 = DO NOT Display ADOPT-A-DOOR Message 2 = Display ADOPT-A-DOOR message
	# NONE	Drive:\Path\Filename to contain the Top Score Bulletin or enter NONE for NO Bulletin creation.
	# Y	Y = Allow player to send PRIVATE messages from the Door Message Center N = Do NOT allow PRIVATE messages
	# 0	Place PRIVATE messages in this BBS Conf #
	# Y	Y = Allow player to send PUBLIC messages addressed to ALL from Message Center N = Do NOT allow PUBLIC messages
	# 1	Place PUBLIC messages in this BBS conf. #
	# Y	Y = Allow Player to Check for Mail from the Door Message Center N = Do NOT allow Check for Mail
	Y	Allow player to send EMAIL to Door Author
	xxxx@yyyyyyy.zzz	Door Author's EMAIL Address
	5	Number of Jumbles to solve
	2	Number of players that must answer ALL puzzles before game can change via your nightly EVENT process.
	# NONE	Full Drive\path\filename for High Score Bulletin file (HTML Format)
	NONE=0	**
	NONE=0	**
	NONE=0	**
	NONE=0	**
	NONE=0	**
	G	Door Rating. Default is G. Maximum Characters: 5

Maintenance	SHUFWORD: This is the Word Shuffle utility maintenance progam. This program is used to add words to the Shuffle database and to perform the nightly maintenance. Note: If running an unregistered copy you will be restricted to 5 words in the Shuffle database vs 1000 words in the registered copy and you will not be able to run as a nightly event. EVENT PROCESSING After your callers complete all the words you have defined, it becomes necessary to change them and start a new game. This task can be done manually, using SHUFWORD or automatically, as part of your nightly EVENT process. As a nightly EVENT, SHUFWORD checks to see if the number of players, as defined in the configuration file, have completed all words, in which case it will automatically supply a new set of words and reset/update the appropriate files. To run as an EVENT, the command line must contain the path to the SHUFFLE directory AND /EVENT. For example: wcrun -r shufword d:\wc5\doors\shuffle /event
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.
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 WINServer Documentation