Documentation for BBS*TRIS Door Game (C)Copyright Robert Chambers, 1996-1997 WHAT IS BBS*TRIS? BBS*TRIS is a game in which falling game pieces must be maneuvered into place to form complete horizontal lines. Points are awarded for each piece that is placed on the board, with more points awarded each time a horizontal line is completed. Trick pieces enabled by the sysop control the difficulty of the game. SYSTEM REQUIREMENTS: 386 or better processor Requires ANSI graphics on the user's end ~165K memory WHAT ARE SOME OF THE FEATURES? * Optional activity log. * Bulletin generation. * Configureable game play options * Has a sysop chat mode. * Fossil aware. * No maintenance required. * Supports standard drop files such as DOOR.SYS (PCBoard/GAP), DORINFO1.DEF, EXITINFO.BBS, CHAIN.TXT, etc. * Supports multiple nodes. LIMITATIONS ON UNREGISTERED VERSION: The unregistered version will only allow each user to play 2 games per day. You must register the program to eliminate this restriction. See the section on registration below. HOW DO I INSTALL IT: This is simple, but you must follow these instructions. I am assuming that you are already familiar with the steps required to install a door on your BBS. If not, I would suggest that you read your manual first. This doc will not attempt to guide you through that. Step 1) Unzip all files into a single directory of your choice. Step 2) Create a batch file that your BBS will use to start the door. I use PCBoard, and my file looks something like this: @echo off cd\pcb\bbstris bbstris.exe c:\pcb\node1\door.sys /L IF "%INPCB"=="Y" EXIT %PCBDRIVE% %PCBDIR% board You may call the file whatever you like, subject to restrictions that may be enforced by your BBS software. Mine is simply called BBSTRIS, with no .BAT extension. Again, consult your manual. A little explanation of the startup batch file is in order here. The second line simply changes to the directory where all of your BBS*TRIS Door program files are found. (Remember you put them there in Step 1.) The second line is the name of the door program, BBSTRIS.EXE, followed by the complete path to your drop file and the (optional) log file switch. Notice that the drop file name is specified. If you are using PCBoard, you may also use the PCBoard environment variables for the path to the drop file. Like this: bbstris.exe %PCBDRIVE%%PCBDIR%\door.sys If you wish the program to log its activities, add "/L" after the path to the drop file like this: bbstris.exe %PCBDRIVE%%PCBDIR%\door.sys /L The program will create BBSTRIS.LOG which will contain information on door usage. See the section below on "LOGGING ACTIVITY". Finally, use whatever door exiting statements your software recommends. Your startup file will undoubtedly look different, but you get the general idea. Step 3) Setup your BBS software and configure any door menus, etc. that give the user access. Step 4) Edit the sample configuration file to suit your tastes and save it as BBSTRIS.CFG. It is *CRITICAL* that this file be named correctly and saved in the game file directory. Instructions for each line are contained in the sample file, SAMPLE.CFG. Note that you must specify a complete path and file name (without the extension) for the scores bulletin that will be created as the game is played. Step 5) You're finished! That wasn't so bad after all. PS-> Don't forget to advertise that you now have a new door on your system! RUNNING LOCAL: You can run the game in local mode if a drop file is in the program directory. DORINFO1.DEF is included in the archive for this purpose. Just place it in the door program file directory and execute the program by running BBSTRIS.EXE. You should be able to leave this file in your game directory with no problem since you have defined the path to the real drop file in your startup batch file. Note that the user name in the sample drop file will be added in the scores bulletin. Therefore you should only run locally to initially try out the game. Reset the game using RESET.BAT prior to putting it online. CUSTOMIZATION: - TITLE AND CHAMPION SCREENS If you want a new title screen you can do it! Create a new screen using your favorite ANSI editor, and call it TITLE.ANS. Leave enough room at the bottom for the additional registration text. It's *CRITICAL* that you name this file correctly. This will also work with the CHAMP.ANS file (current score leader), but you will be restricted to the same background color as the original. Try it and you'll see what I mean here. - INACTIVITY TIMEOUT AND MAXIMUM DOOR TIME You may specify the maximum time allowed in the door and the keyboard timeout limit by editing DOOR.CFG. Instructions are in this file and should be self explanatory. I don't recommend using a maximum door time. By limiting the number of games a user can play each day you can more effectively manage this. Your choice. - LOGGING ACTIVITY The program will provide logging of activity if the logging switch is included in the startup command line in your batch file. For example: bbstris.exe c:\pcb\node1\door.sys /L will cause the program to record entry and exit times in a file called BBSTRIS.LOG. This file can become lengthy if the door is used regularly. A suggestion is to enable logging when the door is initially installed to monitor its use. After a period of time you may wish to disable logging or trim the file occasionally (there are programs that will do this in an event). Please note that the switch (/L) is case specific and there must be a space between it and the path to the drop file. - TRICK PIECES There are three trick pieces that can be enabled or disabled in lines 5-7 of BRAIN.CFG. These pieces increase the difficulty of the game and can be set to activate at a certain score or can be disabled completely. See SAMPLE.CFG for details. MAINTENANCE: There is no maintenance! The game will run its own maintenance when the first player of the day enters the game. A score bulletin is created each time a game is completed. Both ansi and text versions (.ANS and .TXT) are created. MULTINODE USE: The game is set up to run on multiple nodes with multiple player access. You should follow your BBS software instructions on setting up the startup batch file for multiple nodes. RESETTING THE GAME: This has been made simple with the inclusion of RESET.BAT in the archive. This batch file will delete all files generated by the game (except bulletins, which will be overwritten the next time the game is played). Resetting the game should never be necessary since the game maintains itself. I run a monthly contest and award the high score leader a little more access to files, etc. This seems to encourage game play as well as a competitive atmosphere. I reset the game monthly using RESET.BAT. TROUBLE SHOOTING: In the event you have trouble maybe some of these tips will help you. This list is not very long yet, but will be added to as information becomes available. 1) The door will not open at all. It looks like it tries, but immediately shuts down and returns to the BBS. - This is almost certainly a sign that the startup file is not specifying the correct path and/or file name of the drop file. It's also possible that you have not set the board up correctly and the expected drop file is not being created. The startup batch file must include the full path and file name of the drop file as an argument to the executable, BBSTRIS.EXE. See the sample startup file above. 2) You are using DOOR.SYS and the door keeps logging you out when entering locally. - If you are not using the long GAP version (51 lines) of DOOR.SYS then either go to the long version or try DORINFO1.DEF. 3) The graphics don't behave exactly right (on the user's end) with the board running under Windows 95. - If you experience problems with this try running the window either full screen or in the foreground. This seems to solve the problem if you are running the X00 fossil driver. You might also try switching to the BNU fossil driver. This driver seems to work better with Win95. 4) The program is slow on some nodes, and I'm running Windows 95. - As far as I can tell this is a problem with running multiple DOS sessions under Win95. Make sure your "Idle Sensitivity" property for each node is all the way to the left, and that all nodes are running full screen. This is about the only thing that will help, though you may still experience slight delays due to the intense interactivity of the program. THE LEGAL STUFF: Users of BBS*TRIS Door must accept this disclaimer of warranty: "BBS*TRIS Door is supplied as is. The author disclaims all warranties, expressed or implied, including, without limitation, the warranties of merchantability and of fitness for any purpose. The author assumes no liability for damages, direct or consequential, which may result from its use." By registering you do NOT own this software. You have simply licensed it's use. You may use it on as many BBS nodes as you wish, as long as these nodes comprise a single bulletin board system. You may create as many instances of the program as you wish, as long as they all reside on a single bulletin board system. You are encouraged to pass a copy of BBS*TRIS along to your friends for evaluation. Please ask them to register their copy if they find that they can use it. You may NOT pass along your registration code, however. This should go without saying. REGISTRATION : This is not freeware; it is shareware. If you are not familiar with this concept it means that you are allowed to try the software free of charge for a period of time not to exceed 30 days. At the end of this time you must either register it or remove it from your system. I feel that the time invested in writing and testing the program was significant enough to justify a registration fee. The cost is $15 U.S., and payment may be made via check drawn on a United States bank. No credit cards are accepted. I will take your cash, but you send it at your own risk. To register fill out REGISTER.FRM (included) and send it, along with your check or money order, to the address on the form. I will respond to you with your registration either through U.S. Postal Service, Fidonet Netmail, or Internet E-Mail. The choice is yours; just be sure to specify which you prefer on the form. When you receive your registration code manually edit BBSTRIS.CFG and change the first two lines to your registered name and code number. Watch out for spaces at the end of the registration name; this is a common problem. Also remember that the registration name is space and case sensitive. The unregistered version will only support 2 games per day per user. Registration will remove this limitation and allow nearly unlimited games. Registration will also entitle you to free lifetime upgrades. There will be no automatic notification of upgrades. You can always get the latest version from my BBS, Tequilla Sunrise, at (504)-756-0383. Just type FREE at the main menu prompt. There is no charge (except LD charges if applicable) for the file or to become a member of the BBS. TECHNICAL SUPPORT: Technical support will be provided to both registered and non-registered users to the best of my ability. You may reach me via the following: Fidonet - Robert Chambers@1:3800/49 Internet EMail - chambers@premier.net Tequilla Sunrise BBS - (504)-756-0383 MANY THANKS!: Thanks to the faithful callers that kept playing, even when it didn't work. And to Lee, who wishes I'd spend more time with her, and less time with the keyboard.