                    Documentation for BBS Checkers Door Game
                         Written by Robert V. Chambers
                               Copyright (c) 1996


WHAT IS BBS CHECKERS?
BBS  Checkers  allows users to play a  standard  game of checkers against each
other.  Players  can start and join games,  send messages in a game, and learn
how  the  game  is  played. There  is  no  maintenance;  everything is handled
automatically.  The  game  generates a scores  bulletin  in both ansi and text
format  as  well  as  a who-beat-who  bulletin.  Setup  is simple and straight
forward.

SYSTEM REQUIREMENTS:
386 or better processor
Requires ANSI graphics on the user's end
~170K memory

WHAT ARE SOME OF THE FEATURES?
*  Up to 200 simultaneous games.
*  Optional activity log.
*  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.
*  Runs on multiple nodes (one player only).
*  Sysop configurable path\filename for scores bulletin.
*  In-game messaging for players

LIMITATIONS ON UNREGISTERED VERSION:
The  unregistered version will only allow a single  user to be involved in two
games  simultaneously.  You  must  register  the  program  to  eliminate  this
restriction. See the section on registration below.

UPGRADING FROM A PREVIOUS VERSION:
Unzip  all  files  in the archive over  your  existing  door files. If you are
upgrading  from V1.1 then on line 5  of CHECKERS.CFG add the complete path and
file  name  (without the extension) for the  scores bulletin you would like to
create.  See SAMPLE.CFG for more details  and example. Upgrading from versions
later than V1.1 do not require any modifications. That's it!

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\checkers
        checkers.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 CHECKERS,
        with no .BAT extension. Again, consult your manual.

        A  little explanation of the startup batch  file is in order here. The
        first  line simply changes to the directory where all of your Checkers
        program  files are found. (Remember you put them there in Step 1.) The
        second line is the name of the door program, CHECKERS.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:

                        checkers.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:

                      checkers.exe %PCBDRIVE%%PCBDIR%\door.sys /L

        The program will create CHECKERS.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
        CHECKERS.CFG.  Instructions for each line  are contained in the sample
        file, SAMPLE.CFG.

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 CHECKERS.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. This is offered only for the purposes of demonstrating the game prior to
installation.

CUSTOMIZATION:

- TITLE SCREEN
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.

- 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.  Be  sure that you leave your  users enough time to think about a
move!

- 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:

                     checkers.exe c:\pcb\node1\door.sys /L

will cause the program to record entry/exit times and game deletions in a file
called  CHECKERS.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 or when  you add something special that you want
your users to view or download. 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.

MAINTENANCE:
There  is no maintenance! The game will run its own maintenance when the first
player  of  the day enters the game.  In  addition to deleting games that have
expired  due to lack of play both  GAMES.DAT and WINNERS.DAT will be backed up
in  the  game  directory.  The  backup  files  will  be  named  GAMES.BAK  and
WINNERS.BAK.  Hopefully  you will never need  this, but occasionally things do
happen.

MULTINODE USE:
The  game is set up to run on multiple nodes, but at this time only one player
may  be  in  the  game at a time. If  for  some  reason the door does not exit
properly (power failure, etc.) you will need to delete the file INUSE.DAT from
the  Checkers directory. The presence of this  tiny file signals the game that
another  player is currently playing and prevents others from entering. I have
an entry in my nightly event that attempts to delete this file just in case it
happens to exist.

HOW TO RESET THE GAME:
You  should never need to reset the game, but in case you want to a batch file
is  included  (RESET.BAT)  that will delete  all  files necessary to reset the
game.  "News"  files  will be deleted,  but  bulletins  will not. Backup files
(GAMES.BAK and WINNERS.BAK) will not be deleted.

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, CHECKERS.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. The DORINFO style drop file has
been successfully tested on Maximus.

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, but is  not feasible if running more than one
node. Try switching to the BNU fossil driver. This driver seems to work better
with  Win95,  and  cleared up the graphics  problem  for  me (I was previously
running X00).


THE LEGAL STUFF:
Users  of BBS Checkers Door Game must accept this disclaimer of warranty: "BBS
Checkers  Door  Game 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 the use
of BBS Checkers Door Game."

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 Checkers along to your friends for
evaluation.  Please  encourage 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 CHECKERS.CFG and change
the first two lines to your registered name and code number. The first line is
case  and space specific. Watch out for  spaces at the end of the registration
name.

The  unregistered  version will only support  two simultaneous games per user.
Registration  will  remove  this limitation and allow  the  user to join up to
twenty 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 all of the users that put up with the frustration of playing a game
during  the testing phase and made many  helpful suggestions along the way. In
particular  thanks to John Noble, who played me to the first win (I think John
won  this  one),  and  to Bernie Ballard  who  helped  me test the program and
continually challenged me to add new and necessary functionality to the game.

Thanks to all you guys!  I owe you one!

