                      XBARON(tm) Version 1.46
          Program Extensions for Red Baron w/Mission Builder
                Written by Bob Church  CIS: 73207,3242
                Copyright (c) 1995 All Rights Reserved


                    === DISCLAIMER/AGREEMENT ===

Users of the XBaron package must accept this disclaimer of warranty:

 "This software is supplied on an AS IS basis. The author specifically
  disclaims ANY warranty, expressed or implied, as to the fitness for
  any particular purpose of the software. Under no circumstances will
  the author be liable for any direct, consequential, special, indirect,
  or other damages including, but not limited to, loss of data, profit,
  or the use of the software arising from the distribution, use, misuse,
  or inability to use the software. YOU USE THIS SOFTWARE AT YOUR OWN
  RISK. BY USING THE SOFTWARE, YOU AGREE TO THE TERMS OF USAGE SET FORTH
  IN THIS DISCLAIMER."


                        === INTRODUCTION ===

The XBaron package consists of a patch and support programs for use with
Dynamix' Red Baron w/Mission Builder. XBaron provides several extensions
which will improve and enhance the performance of Red Baron, especially on
486/33 and faster computers.

The major features of XBaron are:

  1. A Frame Rate Limiter in the simulation that limits maximum frame
     rate to a value that allows Red Baron to run at optimum performance.

  2. A Frame Rate Limiter in the VCR that regulates playback time so
     it is the same as the record time.

  3. Additional keyboard functions available in the VCR for adjusting
     tape speed during playback.

  4. Improved joystick routines with provision for adjustable response
     curves and adjustable dead zone settings.

  5. Additional joystick button functions as well as the capability to
     reassign individual functions to any available button.

  6. Built-in support for the Thrustmaster FCS/PFCS hat switch for
     controlling cockpit views.

  7. Built-in support for proportional analog throttle to replace the
     'ratchet' analog throttle that RB provides.

  8. Optional  support for proportional analog rudder to replace the
     'off-on' analog rudder that RB provides.

  9. Optional support for a partial rudder-aileron linkage that adds
     a little roll whenever the pedals are depressed.  


                     === XBARON INSTALLATION ===

                           *** WARNING ***

This program make permanent modifications to the RB.EXE file. Once the patch
is made, there is no easy way to restore the program to it's original form.
So long as you have a backup of the RB.EXE file, all you need to do is copy
the old one back to restore things to normal operation. Please make a back
up copy of RB.EXE before proceeding with the installation.

Required Files
--------------

Installation of XBaron is relatively simple. It is a good idea to install
XBaron to a fresh, unpatched copy of RB.EXE since other patches may interfere
with the install process. For installation to be successful there must be 5
files present in your BARON directory:

       1. RB.EXE
       2. BARON.COM or GCD.COM
       3. XBINST.EXE
       4. XBARON.COM
       5. XBSETUP.EXE

The first two files are distributed with Red Baron, the other three are
included with the XBaron package. BARON.COM is supplied with the floppy
version of RB, GCD.COM is supplied with the CD version. You must have
one or the other of these in the BARON directory, you don't need both.
By 'BARON directory', I mean the directory where you currently have Red
Baron installed. This is usually C:\DYNAMIX\BARON for the floppy version
and C:\SIERRA\REDBARON for the CD version, but other possibilities do
exist.

In the ACES CD collection, there is another GCD.COM in the A10 directory.
This one won't work. You need the one that is 742 bytes long from the 
REDBARON directory. The one in the A10 directory is 956 bytes long. 

CD Version Note
---------------

Currently, the CD version of RB must be installed to the hard disk, i.e.
a full install, for XBaron to operate. XBaron has to patch RB.EXE, and
that can't be done while it is on the CD. It does not seem to be possible
to run RB.EXE alone from the hard disk while the rest of the files reside
on the CD, so a full installation is apparently the only option. Be sure
to see the section on XBARON operation for details on setting up the 
command line switches for the CD version.

Install Procedure
-----------------

Once everything is ready, the basic procedure is straightforward:

  1. Run the program XBINST to install the patches into RB.EXE.

  2. Run the XBSETUP program to configure and calibrate XBaron.

  3. Run XBARON to fly Red Baron. If you are using the CD version be
     sure to check the section on XBARON Operation for details on
     setting up the command line switches for the CD version.

That's all there is to it.


                       === RUNNING XBINST ===

You must run XBINST to install the patches into RB and to set up the 
XBARON.COM file so it can run. Just type:

                            XBINST<enter>

at the DOS prompt. You will be asked to verify that you indeed want to
modify the RB.EXE file. If you answer Yes, the patch will be installed.
If you answer No, the patch will be cancelled.

There are several error messages that can occur when you run XBINST. They
are self-explanatory, generally dealing with the inability of XBINST to
locate the correct versions of the required files.

                        === USING XBSETUP ===

The XBSetup utility is used to configure and to calibrate XBaron to work
on your system. To run XBSetup just type:

                            XBSETUP<enter>

at the DOS prompt. You will need to have a mouse installed to use XBSetup.

The XBSetup screen is divided into 3 general areas. To the left are the
Analog Setup Screens, to the right is an area that allows selection of
the various XBaron functions via 'check boxes'. Just below the function
selections are two buttons used for saving the current configuration and
exiting from XBSetup.

Changing the Settings
---------------------

The various settings available in XBSetup are changed using buttons,
check boxes, and sliders. Accessing these is done using the mouse. The
mouse cursor 'hot spot' is just slightly ahead of the center of the
propeller. To press a button, place the cursor on the button and click
the left mouse button. To change a check box, place the cursor at the
check box and click the left button, The check will alternately turn off
and on with each click. To use one of the sliders, place the cursor on
the slider knob, hold down the left button, and drag the slider up and
down the track.

Hat/Throttle Options
--------------------

At the upper right corner of the XBSetup screen is a section marked
'- Hat/Throttle Options -'. There are two checkboxes there labelled
'TM Hat' and 'Throttle'.

Throttle
--------

Checking this box will configure XBaron to treat the Joystick 2 Y-Axis 
as an analog throttle. The throttle is proportional.

TM Hat
------

Checking this box will configure XBaron to treat the Joystick 2 Y-Axis 
input as a Thrustmaster FCS 'hat' switch and use it for view selection. 
The provided views are:

        a. Hat Forward - Look Up
        b. Hat Left - Look Left
        c. Hat Right - Look Right
        d. Hat Back - Look Back

The view will be held so long as the hat is held. When the hat is released, 
the view will return to Forward.

Rudder Options
--------------

Immediately below the Y2 Axis Setup area on the XBSetup screen is an
area marked '- Rudder Options -'. There are two checkboxes available
in this area, one marked 'Analog' and a second marked 'Roll'. The
default is to have both of these options turned off. 

Analog Rudder
-------------

Checking the 'Analog' option implements proportional rudder control in 
RB. RB's normal rudder action is an 'all-or-nothing' proposition. There 
is no rudder action at all until you reach a certain threshold at which 
point the rudder provides full action. With proportional rudder selected, 
the amount of rudder action is variable and will be controlled  by the 
amount of pedal travel.

Unfortunately, RB apparently does not record variable rudder input when 
you save the mission to tape. A tape recorded with proportional rudder 
enabled does not play back correctly. Consequently, XBaron is set up 
to disable the proportional rudder option any time you answer 'Yes' to 
the 'Do You Want To Save This Mission To Tape?' question that is asked 
at the beginning of every mission. Proportional rudders are also disabled 
whenever you enter the Mission Recorder. This is done so that if you 
'Enter Simulation', the proportional rudders will not corrupt an existing 
tape.

This action is taken whether you are starting or restarting a mission. If 
you elect to tape the first flight, then decide not to tape the replay,the 
proportional rudders will be re-enabled during the replay. The inability 
to tape a mission precludes proportional rudder from being used during RB 
Tourney play.

Rudder Roll
-----------

The second selection under Rudder Options is 'Roll'. Selecting 'Roll'
couples a portion of the rudder input over to the aileron input. This
provides a small amount of roll whenever rudder is applied and gives a
somewhat more realistic feeling to the sim. The amount of roll is
proportional to the amount of pedal travel regardless of whether the
rudders are operating in normal or proportional mode.

Rudder Roll will work okay with the VCR and is legal for use in RB
Tourney competition. Rudder Roll is not turned off when a mission is
recorded.

Rudder Pedal Adjustment
-----------------------

Some of the beta testers had some trouble with the 'Roll' option. The
aircraft would roll to the left but not to the right. If you have that 
problem, first be sure that the rudder and aileron calibrations in XBSetup 
is correct. Then go into RB and do an ALT-C calibration after you're flying. 
If those steps don't eliminate the problem, then it's likely that the pot 
in your rudder pedals needs adjustment. For a lack of right rudder, watch 
the value being returned from the X2 axis with a stick test program such 
as TMS or TMSA. Normally, the pot has to be adjusted to increase the value 
at center. On the RCS, Try slipping the pot about 1 tooth on the drive gear 
and then go through the calibration procedures again. 

Button Setup
------------

Below the Y2 Axis Setup area is an area labeled '- Button Setup -'.
This is a 'grid' of check boxes. There is one column for each of the four
joystick button inputs, and one line for each of the functions available
from XBaron.

The four buttons are designated B1, B2, B3, and B4. B1 is normally the
trigger input, B2 is used to switch between internal and external views.
Buttons B3 and B4 are available on some joysticks, and are available if
a second two-button joystick is being used for throttle/rudder control.

You can assign any of the four buttons to any of the supported functions,
of which there are six:

  1. Guns - This function fires the guns. It is the normal analog trigger
     function provided by RB. The normal assignment is to Button B1, but
     it may be assigned to any available button. Note that whatever button
     it is assigned to becomes the 'Trigger' input and must be used to
     answer RB's calibration prompts, click menu buttons, etc.

  2. Ext. Views - This is the normal analog input that switches between
     internal and external views. The default assignment is to Button B2,
     but it may be assigned to any available button. Pressing the button
     will switch between internal and external views and back.

  3. Look Up - Assigning this function to a button will provide an UP
     view so long as that button is held down.

  4. Look Back - Assigning this function to a button will provide a BACK
     view so long as the button is held down.

  5. Blip Throttle - Assigning this function to a button will give that
     button ON/OFF control of the engine. Holding the button down cuts
     throttle to minimum, releasing the button restores throttle to it's
     maximum.

  6. Std Thr - Assigning this function to a button produces a '7'throttle
     character to return to cruising speed.

  7. Decr Thr - Assigning this function to a button produces a '-'throttle
     character for reducing throttle.

  8. Unjam - Assigning this function to a button produces a 'u' character
     to unjam the machine gun.

You can only assign one button to each function, and you can only assign
one function to each button. If you assign a function which is currently
assigned to another button, the other button will automatically be cleared.
If you assign a button to a new function, it's old function will likewise
be cleared. When the function is cleared, the check mark will disappear
from it's associated box.

Analog Setup
------------

Once the Y2 Axis Setup and the Button Setup are completed, you should set
up and calibrate the Analog Inputs. This is done in the left hand area of
the screen.

The Analog Setup section is composed of four small graphics displays, one
for each of the four analog inputs on a standard game port. The displays
are labeled to indicate which axis it controls. Each display is composed
of four components:

  1. A small graphic screen that indicates the current axis response.

  2. A 'slider' labeled 'RC' which controls the response curve for
     the axis.

  3. A 'slider' labeled 'DZ' which controls the amount of dead zone
     for the axis.

  4. A small button marked 'Cal' which is used to initiate a calibration
     sequence for that axis.

Curve Displays
--------------

The curve displays indicate how the control surface will respond relative
to the movement of the stick. At center stick, the control output will be
at the center of the graph. This is the neutral position. As the stick is
move loft and right (or forward and back in the case of the joystick
Y-Axis), the control surface movement will follow the yellow curve. Full
right stick movement will place the control surface at the upper right
corner of the display, full left stick will place the control surface at
the lower left corner.

RC Slider
---------

The mid-position on the RC slider provides a neutral response curve. That
is indicated by a straight line going from the lower left to the upper right
corner of the graph. In this position, the response is linear. 25% of maximum
stick movement will provide 25% of full control surface travel, 50% of maximum
stick movement will provide 50% of control surface travel, etc.

As the RC slider is moved below the midpoint, a curvature will appear in
the graph. The curve will show a 'flatter' section near the center with a
progressively 'steeper' curve out near the endpoints. This corresponds to
relatively small control surface movements near center stick with more rapid
movements as the stick is move farther off center. This give fine adjustment
for small stick movement but still provides full control surface travel when
the stick is pushed to the extremes. The farther below center the RC slider
is set, the flatter the center and the steeper the curves are out toward
the end.

Pushing the RC slider above the center position results in a quicker stick
response near center, with a flattening out near the end points. This results
in a more sensitive stick response since even 50% of stick travel can provide
nearly 100% of control surface movement.

DZ Slider
---------

The DZ slider provides adjustment of the 'dead zone' for the axis. Dead
zone is the area around center stick in which movement of the stick has
no effect. Widening the dead zone can be useful when a particular stick
has 'loose' centering, i.e. doesn't always come back to a precise position
when it's released. The stick must be within the dead zone for level flight
and for internal/external view switching to occur,

Zero dead zone occurs when the slider is all the way down. Moving the
slider up scale will result in more and more dead zone being added. The
curve display will adjust to give an indication of how much dead zone is
being provided.

Cal Button
----------

The Cal Button is used to initiate a calibration sequence for the axis.
You should calibrate all axes that are going to be used. This need only
be done once, unless you change joysticks or replace some other bit of
hardware.

To calibrate an axis, just click on the Cal button. A series of prompts
will appear in the graph display window. Just follow the prompts, it's
all pretty self-explanatory.

If you have an WCS and wish to use either the throttle or the FCS hat
in analog mode, the switches on the WCS must be in the correct position
both during calibration and when flying a mission. For analog throttle,
the red WCS switch must be in the analog position and the black WCS
switch must be in the digital position. To use the FCS hat, the black
switch must be in analog and the red switch must be in digital.

Analog Response Curves
----------------------

When you run XBSetup, you'll see the four analog response adjustment windows
and the button reassignment block. The displays are fairly intuitive, a
straight line from the lower left to the upper right denotes linear joystick
scaling. Moving the RC (Response Curve) slider below center results in
response that is flatter near center, steeper at the ends. Moving the slider
above center accomplishes just the opposite. The DZ slider adjusts dead zone
for that channel. Move the sliders around a bit, you'll see what's going on.
I've defaulted the response curves to something that's worked pretty well
here, you can change them to suit your own tastes.

Rudder Response Adjustment
--------------------------

The Rudder setup is a little strange. RB doesn't actually provide true
proportional rudders. Instead, there's a point where the rudders 'snap'
to full deflection, just like if you hit a rudder key. The best set up
for the rudder sliders is to push the RC slider all the way up, this
provides a very steep response and a very fast switching action. With the
RC slider at the top, the actual trip point in terms of pedal movement
can be set using the DZ dead zone slider. Less dead zone will result in
the rudder flipping with less pedal travel. This makes it easy to adjust
the point at which the rudder will respond.

Hat/Throttle Setup
------------------

There is a curve for the Hat/Throttle input, and the sliders can be
adjusted, but any adjustment made is ignored by XBaron. The response must
be flat for the Hat and Throttle routines in XBaron to operate properly.
You do need to calibrate the Hat/Throttle input if you are going to use
the XBaron hat or throttle options.

Calibration
-----------

In the corner of each of the response boxes is a CAL button. You need to
calibrate the axes you're using once to get the best response out of the
XBaron patch. To calibrate a particular axis, click on the 'Cal' button
in the lower right corner of it's associated curve display. A series
of prompts will appear which will lead you through the necessary steps.

Do the calibration carefully, especially the center calibration. XBaron
uses these values to compensate for asymmetrical joystick response, and
it is necessary that the values be accurate, and bad values here can
result in less than optimum control response.

Saving Your Configuration
-------------------------

Once all the various assignments have been made and the analog axes
have been calibrated, you have to save your configuration. Just click
on the 'Save Config' button at the bottom right of the screen. The data
is written directly to XBARON.COM for its use. If you rerun XBSetup at
a later time, the current settings will be reloaded so you can see whet
you had and make whatever corrections are necessary.

Exiting to DOS
--------------

Once the configuration has been saved, everything is ready to go. Just click
on the 'Exit to DOS' button at the lower right corner of the screen to quit
XBSetup and return to the DOS prompt. You can also hit the ESC key twice
in succession to exit from XBSetup.


                     === XBARON OPERATION ===

You run XBaron in pretty much the same manner as you would run standard
RB. The only real difference is that you need to run XBARON.COM to start
Red Baron rather than the standard BARON.COM (GCD.COM on the CD Version)
that comes with RB. There are no TSRs to run or other special steps to
take. 

Floppy Verion
-------------

For the Floppy version of RB, just log over to your BARON directory and 
type:

                           XBARON<enter>

The Main Menu will come up and Red Baron will function the same as if the
program were started using BARON.COM.

CD Version
----------

Running XBaron for the CD version is a little bit more involved. The CD
version requires a directory specification to be passed to it so RB knows
where to look for its files. To find out what the specification is, you
can TYPE the BARONCD.BAT file that you normally run to start RB. It will
look something like this:

 @echo off 
 C: 
 cd \SIERRA\REDBARON 
 gcd -nC:\SIERRA\REDBARON 
 C: 

You need to run XBaron with the same options as GCD has on the fourth line:
 
                 XBARON -nC:\SIERRA\REDBARON

or whatever is in your BARONCD.BAT file. The easiest thing is just to copy
the BARONCD.BAT file to one called XBARONCD.BAT. Then edit the file using
DOS EDIT or some other pure ASCII text editor and change the reference from
'GCD' to 'XBARON'. Something like this:

 @echo off 
 C: 
 cd \SIERRA\REDBARON 
 XBARON -nC:\SIERRA\REDBARON 
 C: 

Then you can just use XBARONCD to start XBaron and you won't need to remember
the directory spec each time. If you don't add the directory spec to the
XBaron command line, your tapes and custom missions will end up in the
wrong directories, your careers won't advance, ROSTER.DAT won't get updated,
etc.

XBaron Error Messages
---------------------

There is only one possible error message when running XBARON.COM. If you
haven't run XBINST, you'll get a message to that effect and XBARON will
exit to DOS. Run the XBINST program and that will eliminate the error.

Red Baron Calibration
---------------------

The first time you run XBARON, you should do a standard ALT-C calibration
of the joystick when you get into the cockpit. This aligns Red Barons
internal joystick scaling with joystick routines used by XBaron.

Frame Rate Limiter
------------------

The Frame Rate Limiter is in operation whenever you are in the flight
portion of RB. It's operation is completely transparent to the user.
Basically, RB requires a minimum frame time to operate correctly. If
a frame comes along that is shorter than that minimum, then RB does
not do the flight model calculations correctly. The Frame Rate Limiter
in XBaron does not have any effect until a frame comes along which is
too short for RB to deal with. It then extends the frame by adding
just enough delay to bring the frame time up to the minimum acceptable
to RB. XBaron won't cost you any frame rate unless the frame is too
fast, if it's already over the minimum then the limiter has no effect.

There are several problems that are caused by high frame rates. The most
obvious is the general speed-up of game functions, on faster machines this
makes the game largely unplayable. Problems also appear in the enemy AI,
causing them to not execute their offensive and defensive maneuvers
correctly. A third problem occurs which renders the 'Time Slider' that
is normally used to control the overall speed of the simulation to be
largely ineffective. With the Frame Rate Limiter in operation, all these
problems are overcome.

XBaron does not provide any 'advantage' to the player, other than to restore
Red Baron to proper operation, and is acceptable for use in the RB Tourneys
held in the CIS FSForum.

VCR Operation
-------------

The VCR will operate just as it does in standard RB. The operation of the
VCR limiter is transparent. You will notice that any tape recorded under
XBaron on a 486/33 or faster computer will playback on any other machine
486/33 or faster at the correct speed, providing the playback machine is
also running XBaron. This speed regulation means that tapes recorded on a
P90 will playback correctly on a 486/33 and vice-versa.

There are three new keyboard commands available in the VCR to control the
speed of playback. These can be useful for editing tapes, and for adjusting
the playback speed when a tape that was recorded on a slow machine not
running XBaron is played back on a faster machine.

The three additional keys are:

     S - Run the tape at a Slower speed.

     D - Reset the Default playback speed.

     F - Run the tape at a Faster speed.

Pressing the 'S' and 'F' keys repeatedly will have a progressively more
pronounced effect on playback speed. This is especially true of the 'S'
key. Running the tape faster can only be done up to the maximum frame
rate available on the playback machine, and on machines of 486/33 and
486/66 is may not be possible to increase the speed significantly.

You can return the playback speed to it's standard value at any time
by pressing the 'D' key. This locks the playback to the same clock
that was used during record and guarantees the playback time will be
equivalent to the record time, subject to the ability of both the
record and playback machines to achieve frame rates of at least 20
frames per second. This is generally the case on  machines 486/33 and
faster.

                     === ACKNOWLEDGEMENTS ===

I would like to thank Nick Bell, George Elizondo, James Johnson, Scott Mobley, 
Ed Paquette, Randall Penn, and Mark Shurtleff for their efforts in the beta 
testing of the original RBLimit patch and the later XBaron program. I'd also 
like to give a special thanks to George Elizondo and Scott Mobley for helping 
with the testing of the tape speed and gunfire duration. Thanks to all of you 
for your help and suggestions. I hope you're all pleased with the results.


                          === NOTICES ===

Trademarks
---------
CompuServe is a trademark of CompuServe, Inc.
Red Baron is a trademark of Dynamix/Sierra On-Line, Inc.

These programs are not in any way connected with or endorsed or supported
by CompuServe, Inc., Dynamix, Inc., or Sierra On-Line, Inc.

Distribution Notice
-------------------

This program is being released by the author as freeware. It is NOT public
domain! You may copy and use the program freely. You may distribute it to
whomever you like but:

         1. Do NOT distribute modified versions.
         2. Do NOT remove the copyright notice.
         3. ALWAYS distribute with the documentation.

No other limitations are placed on the usage of the software. No fee is
charged for the use of the software.


                     === TECHNICAL SUPPORT ===

If you have problems, bug reports, suggestions, or comments on the XBaron
program, you can contact me on CompuServe at 73207,3242. E-Mail is best,
although I normally check in on FSForum relatively frequently. XBaron is
an ongoing project which I expect to update as time goes along. If you have
any ideas for improving the program or any functions you'd like to see
added, please send them along.


                      === REVISION HISTORY ===

Version       Date         Revision Notes
---------------------------------------------------------------------
V1.44  05/02/95  Initial release.
V1.45  05/10/95  Beta only, not released.
V1.46  05/28/95  Added support in XBINST for German version of RB.
                 Added Support for proportional rudders.
                 Added Support for linked rudder/aileron.
                 Added 'Decr Thr', 'Std Thr', and 'Unjam' to Button Menu.
                 Fixed character handler to avoid XBaron/keyboard collisions.
