Links Golf v4.0 - BBS Door Program
Links Country Club Golf. Play a round of
9 or 18 holes. Includes course architect
so that you may customize your course to
your board. Now includes ANSI display for
each hole. Supports baud rates to 115,200,
COM0-15, non-standard IRQ's and fossil based
multi-port digiboards. 08/31/93
Author:Robert Neal NOT CRIPPLED!
Supports USERS.SYS, DOOR.SYS, DORINFOx.DEF,
SFDOORS.DAT, PCBOARD.SYS, CALLINFO.BBS,
TRIBBS.SYS, USERINFO.DAT, and GTUSER.BBS BBS
file formats.

Corporate Headquarters BBS (815) 886-3233
(815) 886-9381

T H E L I N K S C O U N T R Y C L U B G O L F
v4.0

MULTI-BBS Support
Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
UltraBBS, Telegard, TriTel, and Remote Access

Copyright 1993
by Robert Neal
317 Hickory Avenue
Romeoville, IL 60441



Changes to this documentation file from the previous version are
indicated by "|" in the left hand margin. This should make finding
changes to the documentation much easier and faster for those upgrading
from previous versions.

The Links Country Club Golf (Links) is released as SHAREWARE. You are granted
a limited license to evaluate the program. Try it out, if you continue to use
it you are required to register the program.

============================================================================
To register the program print the file MAILER.TXT and complete the
information requested. Or use your VISA/MASTERCARD and register online
by call (815) 886-9381, type CHARGE at the main menu prompt.
============================================================================

Links is a golfing simulation game, with either 9 or 18 holes offered
for play. Users golf by making their club selection, woods, irons,
wedges and putter. Yardage is determined by a set standard plus a random
variable to keep the game interesting.

THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
CHARGE AND 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.



FEATURES OF THE LINKS COUTNRY CLUB GOLF
=======================================

- Ansi color support.

- Terminates cleanly through exit code even on runtime error.

- Automatically creates a top score listing suitable for inclusion
as a text/bulletin file for display within your BBS.

- Detects loss of carrier.

- Operates in local mode (either direct from BBS or from command line).

- Sysop function keys to return to the board, chat mode, user stats,
increase/decrease time, etc.

- Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS, Ultra BBS,
Telegard, TriTel and Remote Access.

- Support for baud rates up to 115,200

| - Support for COM0-15. Optional command line for non-standard IRQ's.

- Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%

- Fully Multi-Node compatible.

- Course editor (LINKARCH) added to customize the course layout.
For REGISTERED versions only.

- Optional automated monthly rollover maintenance.

- Supports fossil based, multi-port digiboards, as used with PCBoard
/M version.

| - ANSI representation of each hole



CONFIGURING THE PROGRAM

You may use GCONFIG.EXE to create and/or edit the configuration files.
To use GCONFIG, type GCONFIG GOLF.CFG. This editor will allow you to
enter the appropriate configuration editor within it's own full screen
editor. GCONFIG will also convert registration data from version prior
to v3.3 to the new method used beginning with v3.3. Below is the layout
of the GOLF.CFG file if you wish to edit it manually.


C:\PCB\PCBOARD.SYS
Corporate Headquarters
Bob
Neal
0

Line 1 = Full pathname of your door file. Formats supported by this
program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
GTUSER.BBS, DOOR.SYS, and TRIBBS.SYS. When using
USERINFO.DAT, DOOR.SYS must be in the same
directory as USERINFO.DAT.
Line 2 = BBS name
Line 3 = Sysop First Name
Line 4 = Sysop Last Name
Line 5 = Registration number. Leave as 0 if unregistered.


Note: This door supports the PCBoard environment variables %PCBDRIVE%
and %PCBDIR%. Non-PCBoard systems may also use these variables by
including the following either in your BBS batch or AUTOEXEC.BAT file:

SET PCBDRIVE=C: <- Drive letter of your BBS files
SET PCBDIR=\BBS <- Path of your BBS files

Then, in your GOLF.CFG file, on the first line you may put:

%PCBDRIVE%%PCBDIR%\PCBOARD.SYS, %PCBDRIVE%%PCBDIR%\DOOR.SYS, etc.

This allows you to use just one .CFG file for multi-node operation.



EXECUTING PROGRAM
=================

To execute the program, enter the filename followed by the config file
name (ie GOLF GOLF.CFG). If you are running the program from the command
line, you may optionally enter GOLF.EXE LOCAL. The only problem with this is
the default user name sysop is used instead of the username on your board.
This is good for testing the game before putting it on your system, but
you should once play begins execute the program locally from your BBS or
consistantly run the game from the command line when you play.

This documentation will not go into the details of how you set-up a door
program on your BBS. It is assumed that you have a working knowledge of
how to complete this task. As each BBS is different, trying to explain
the installation procedure for every BBS is not possible.

You may also specify a non-standard IRQ. Put the IRQ number after the
.CFG on the command line. For example: GOLF GOLF.CFG /5. This example tells
the program to use IRQ 5 instead of the standard IRQ.

You may also use the procedure above and create a variable IRQ so that
you can pass the IRQ setting as: GOLF GOLF.CFG /%IRQ%.

Some users may have had conflicts when using non-standard IRQ's on
Novell/Netware systems. Novell seems to use the "/" character for
parameter passing. You may not optionally use the "*" character instead
of the "/", for example GOLF GOLF.CFG *%IRQ% is valid. Both "*" and "/"
will work.

FOSSIL DRIVER
=============

Links Golf now includes support for FOSSIL drivers. This means that the
program will now work with Digiboard (for Wildcat IM and PCBoard/M
versions) and other fossil based multi-port boards. To activate the
Fossil driver support just include /FD on the command line in your door
batch file.

For example: GOLF GOLF.CFG /FD

If no Fossil driver is available, Links Golf will display a message
indicating such and exit cleanly.



FILES USED
===========

GOLF.EXE - The program itself
GOLF.DOC - Documentation for the sysop to run The Links
GOLF.CFG - Configuration file
GOLF.FIL - Best scores file (top 5)
GOLF.CRS - Data file of the course. New to version 2.0 is the option to
alter the course layout by using the program LINKARCH.
NON-REGISTERED users may NOT alter the course. The file
LINKARCH has been included for you to see how easy it is to
modify the course to your own personal layout. If you are
using a NON-REGISTERED version DO NOT alter the course, either
with a text editor or the LINKARCH program. Doing so will
result in the game failing to load.
GOLF.LOG - This file is created when the program is run. This file will
contain a synopsis of activity in the door, who played,
number of holes played and even if they got a whole in one.
|HOLExx.ANS- ANSI graphic representation of each hole. Graphics included
| with this program are for the default course. If you make
| any modifications to the course with LINKARCH, you will need
| to modify the respective HOLExx.ANS file using your favorite
| ANSI editor.
|BALL.ANS - ANSI image of golf ball.
|OPEN.ANS - ANSI image displayed at start up of program.


REINITIALIZING THE SCOREBOARD
=============================

Every so often you may want to reset the scoreboard (especially when you
have the scoreboard filled with LOW scores that would be difficult or
impossible to better). To reset the scoreboard enter GOLF INIT and the
game will automatically reinitialize the scoreboard. You may also copy
over the original unmodified scoreboard included in this archive to
esentially reset the game.


MONTHLY ROLLOVER MAINTENANCE
============================

You may optionally have Links Golf automatically rollover the scoreboard
on a monthly basis by entering GOLF MAINTxx (where xx is the day of the
month you want to rollover the scoreboard). For example, to reset your
scoreboard on the first of each month, enter GOLF MAINT1. To reset on
the 15th, enter GOLF MAINT15. This command should be run as part of your
BBS nightly event processing. If maintenance is not required, the
program will exit cleanly. If maintenance is required, the program
will automatically reset the scoreboard information.




THE GAME ITSELF
===============

The game starts by displaying The Links opening screen (please do not
modify this or any other part of the game), and will ask the user if he
wants to use ANSI colors. While the door info file passes the variable for
if a user has ANSI on or off, this gives those players a chance who may have
ANSI off for normal BBS useage to use ANSI colors while in the door.

From here he is asked if he wants to play 9 or 18 holes. If he selects 9
holes he is then asked if he wishes to play the front 9 or back 9. He is
then asked if he wishes to read the instructions on how to play The Links.

When prompted for club selection entering QUIT (or 'Q') will terminate
play. Entering HELP (or 'H') will display a listing of available clubs
and approximate distances.

|An ANSI representation of each hole is included with this program. If
|the user has ANSI capabilities, the graphic image will be displayed. If
|the user does not have ANSI capabilities, the program will not display
|the image.

After the user has played all 9 or 18 holes his ranking is shown if he
beats one of the top 5 scores. The best score file is then updated and
the program asks the user if he wishes to play again or not.

SYSOP KEYS ACTIVE

F3 - Toggles the printer On/Off. Value is passed to PCBoard and/or
written to DOOR.SYS and USERS.SYS
F4 - Toggles the Page Bell on/off. Value is passed to PCBoard
and/or written to DOOR.SYS and USERS.SYS
F5 - DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
F7 - Toggles the Caller Alarm On/Off. Value is passed to PCBoard
and/or written to DOOR.SYS and USERS.SYS
F8 - Returns the caller involuntarily to the BBS.
F9 - Toggles the local display On/Off. Value is passed to PCBoard
and/or written to DOOR.SYS and USERS.SYS
F10 - Activates SysOp CHAT mode within the DOOR.
ESC - Deactivates CHAT mode. DOOR is resumed.
UP - Give the caller extra time while in the DOOR.
DN - Subtract time from the caller while in the DOOR.
HOME - HELP key for Status Line options.
ALT-N - SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
ALT-X - PCBoard will exit after current caller logs off. Value is
passed to PCBoard. Not available on non-PCBoard systems.





THE LINKS COURSE EDITOR (LINKARCH.EXE)
======================================

The file GOLF.CRS contains the information concerning the course layout
and MUST be edited using LINKARCH. Attempts to edit the program with a
text editor will result in the game failing to execute.

The course editor should only be used by REGISTERED users of The Links
Country Club Golf. NON-REGISTERED versions will fail to execute if the
orignal GOLF.CRS file is edited in anyway.

The LINKARCH file is contained in this archived file so that previously
registered users have the file available without needing to request it
and also so that NON-REGISTERED users can see how easy it is to edit
the course, though any changes made will not be saved.

When using the course editor you should be certain to keep the par
for the front and back nine the same. As a rule of thumb, distances
less than 250 yards should be a par 3, 250-375 a par 4 and anything over
375 yards should be set as par 5.



CONTACT ME FOR SUPPORT
======================

If you encounter any problem you may contact me at Corporate Headquarters
BBS (815) 886-3233 or (815) 886-9381 (v.32bis 1200-14400).

This program has been run extensively on my system and through the years
on the systems of many who have registered (and probably more who
haven't registered) this program. I feel confident that the program will
perform as planned. If you do encounter any bugs (or features as some
might call them), please inform me of the problem so that future
releases can be corrected.

In addition to my BBS, I also hang around the SYSOPS, DOORS and BBS
SOFTWARE message conferences on the RIME network. You can send me
messages via this network.

If you have any suggestions for improvements for this program, please feel
free to let me know. This game has included suggestions from users of my
BBS as well as the beta testing BBS.

TROUBLESHOOTING
=====================

If you are running this on a 486 system and encounter problems, you may
need to put 'SET NO87=ON' in your AUTOEXEC.BAT file or you may place
this in the GOLF batch file just before the line GOLF GOLF.CFG, for
example:

@ECHO OFF
C:
CD \GOLF
SET NO87=ON
GOLF GOLF.CFG
%PCBDRIVE%
CD %PCBDIR%
IF (%INPCB%)==(Y) EXIT
BOARD


If you are running on a 486 system with co-processor under DesqView, you
may alternately set Math Coprocessor in each window to YES.




DISTRIBUTION SITE:

As always you can find the latest version of Links available for
downloading from Corporate Headquarters BBS.

Corporate Headquarters BBS Node #1 (815)886-3233 (1200-14400 v.32bis)
Node #2 (815)886-9381 (1200-14400 v.32bis)


You may register online using your Visa or MasterCard by calling the
support BBS and typing CHARGE at the main menu prompt.