FSASMLIB.DLL 6.0.0 -- README.TXT
================================

FSASMLIB.DLL is a FREEWARE add-on module for use with Microsoft(R) Flight
Simulator(tm) for Windows 95 (FS6).  FSASMLIB.DLL is required for scenery
compiled with FSASM, the Freeware Scenery Assembler.  This version of
FSASMLIB.DLL contains the FSASM Object Library for FSASM generated scenery
and the Flight Data Recorder for recording your flights.

* Contents of this README
  - Installing FSASMLIB.DLL
  - Uninstalling FSASMLIB.DLL
  - Using the Flight Data Recorder
  - Technical Notes
  - How to Contact the Authors
  - Getting the Latest Version of FSASMLIB.DLL
  - Disclaimer
  - Redistribution Terms
  - Copyright
    
      
Installing FSASMLIB.DLL
-----------------------

Sceneries created by FSASM will not work properly without FSASMLIB.DLL,
which contains the library of scenery objects.

To install, run the Install.exe program which comes with FSASMLIB.DLL.  The
Install program checks the Windows registry for the location of your Flight
Simulator directory.  Install then looks for a previously installed version
of FSASMLIB.DLL.  If the previously installed version of FSASMLIB.DLL is
newer, Install keeps it.  Otherwise, Install copies the new version into
your Flight Simulator MODULES subdirectory.

NOTE:  If you want to force Install to use a Flight Simulator directory
other than the one listed in the Windows registry, you can specify your
preferred directory on the Install command line.  For example,

  Install c:\mygames\fs6


Uninstalling FSASMLIB.DLL
-------------------------

To remove FSASMLIB.DLL from your system, simply go to your Flight Simulator
MODULES subdirectory and delete it.  Understand that removing FSASMLIB.DLL
will prevent any sceneries that use it from working properly.  Using these
sceneries without having FSASMLIB.DLL installed may cause Flight Simulator
to exit with an "invalid page fault" error message.


Using the Flight Data Recorder
------------------------------

When enabled, the Flight Data Recorder saves the position, orientation, and
several other parameters of your aircraft to a flight data file at
one-second intervals.  After your flight, you can analyze the flight data
file with a spreadsheet program to see how well you and the aircraft
performed.  

Several popular freeware programs use data files created by the Flight Data
Recorder.  To make a flight plan and then compare it with your actual
flight track, use NAV by Ted Wright.  To generate dynamic scenery that
follows the course of a recorded flight, use DynaGen by Andrew Roach.  Both
programs are available for downloading from ftp.iup.edu.

The Flight Data Recorder is controlled by changing the settings in the
Flight Data Recorder dialog box.  To open the Flight Data Recorder dialog
box, select Flight Data Recorder...  from the FSASM menu item.

The following options are available:

* Enable recorder

  To start the recorder, put a check mark in the box next to this option.

  To stop the recorder, clear the check box.

  If you quit Flight Simulator with the recorder enabled, the recorder
  will start automatically next time you run Flight Simulator.

* FltRec v0.2 compatibility

  Place a check mark in this box if you want the recorder to output data
  files that are backward compatible with version 0.2 of the Flight Data
  Recorder.  Version 0.2 of the recorder was released as a FSO add-on
  module for FS5.

  Note:  If you use a version of NAV, by Ted Wright, prior to version 1.7
  or if you use DynaGen, by Andrew Roach, enable this option and set the
  output format to binary (see notes on setting output format below).

* Existing data file:  Overwrite/Append

  Select Overwrite to create a new flight recorder data file each time you
  run Flight Simulator or restart the Flight Data Recorder.  

  Select Append to add to the existing flight recorder data file. 

* Output format: Text/Binary

  Normally, you should use the Text option, which causes the Flight Data
  Recorder to save data to a text file.  You can easily load this text file
  in to Microsoft Excel or another spreadsheet program to make charts of
  your flight.
  
  The Binary option causes the recorder to save flight data to a binary
  data file.  Binary data can not be used easily with a spreadsheet but
  binary data may be useful for third-party add-ons that use flight
  recorder data. 

* Output file name:

  This option sets the name of the file used to record your flight.  
  Click the Browse button to select a different file name.


Technical Notes
---------------

* Disabling the FSASM menu item

If want to remove the FSASM menu item from the Flight Simulator menu, use a
text editor, such as NOTEPAD, to edit or create a file named FSASMLIB.INI
in your Flight Simulator directory.  Then insert the following lines at
the top of the file:

[FSASMLIB]
AddMenuItem=1

NOTE:  If you have previously used the Flight Data Recorder, FSASMLIB.DLL
will have already created a copy of FSASMLIB.INI in your Flight Simulator
directory to save your preferences.  Please don't modify FSASMLIB.INI in
any way other than by following the instructions given for disabling the
FSASM menu item.  Any other settings that appear in FSASMLIB.INI should be
changed by using the FSASM menu (so you probably don't want to disable it :).


* Flight Data Recorder binary data format

This information will only be useful to C programmers who want to work with
binary data files output by the Flight Data Recorder.

When the Flight Data Recorder is operating in binary mode (and not in
FltRec v0.2 compatibility mode), it outputs a record of flight data once
per second.  The format of each record is defined by the FLTREC_DATA
structure shown below.  Note:  You must set your compiler's structure
packing to one or two bytes for the FLTREC_DATA structure to be usable.  A
WORD is a 16-bit unsigned integer.  A DWORD is a 32-bit unsigned integer.

typedef struct tagFLTREC_DATA
{
  // FSASMLIB.DLL version
  WORD   wVersion1;   // 6
  WORD   wVersion2;   // 0
  WORD   wVersion3;   // 0
  WORD   wVersion4;   // build id

  // time of day
  WORD   wClockHour;  // hour
  WORD   wClockMin;   // minute
  WORD   wClockSec;   // second

  // position
  DWORD  dwLatLo;     // latitude  (low dword)
  DWORD  dwLatHi;     // latitude  (high dword)
  DWORD  dwLonLo;     // longitude (low dword)
  DWORD  dwLonHi;     // longitude (high dword)
  DWORD  dwAltLo;     // altitude  (low dword)
  DWORD  dwAltHi;     // altitude  (high dword)

  // orientation
  // angles: 180 deg == 0x8000
  DWORD  dwPitch;      // pitch
  DWORD  dwBank;       // bank
  DWORD  dwHeading;    // heading

  // airspeed
  // units: 256 * meters/second
  DWORD  dwTAS;        // true
  DWORD  dwIAS;        // indicated

  // fuel tank quantities 
  // percentages: 100% == 0x800000
  DWORD  dwFuelLeftPct;     // left
  DWORD  dwFuelLeftAuxPct;  // left aux
  DWORD  dwFuelRightPct;    // right
  DWORD  dwFuelRightAuxPct; // right aux

  // gear position
  // up == 0, down == 0xFFFF
  WORD   wGear1;
  WORD   wGear2;
  WORD   wGear3;

} FLTREC_DATA;


How to Contact the Authors
--------------------------

You may contact the authors of FSASMLIB.DLL via the email addresses shown
below:

* Adam Szofran
    Internet:    zof@halcyon.com
    Compuserve:  >INTERNET:zof@halcyon.com

* John Blackie
    Internet:    100032.532@compuserve.com
    Compuserve:  100032,532


Getting the Latest Version of FSASMLIB.DLL
------------------------------------------

The latest version of FSASMLIB.DLL or the Freeware Scenery Assembler may be
obtained from the following locations:

* Internet

    http://www.halcyon.com/zof/fsasm.html
    ftp://ftp.halcyon.com/pub/users/zof/
      New versions, updates, and add-ons will always be available here
      first.  Other goodies may appear here from time to time.

    ftp://ftp.iup.edu
      Check the UPLOADS: directory.  You must use the colon in the
      directory name.

* Compuserve

    GO FSFORUM


Disclaimer
----------

FSASMLIB.DLL comes with no warranty or claim of fitness or reliability. 
FSASMLIB.DLL is distributed AS IS, USE AT YOUR OWN RISK.  The authors of
FSASMLIB.DLL have absolutely no affiliation whatsoever with Microsoft
Corporation.  Neither the authors of FSASMLIB.DLL, nor Microsoft
Corporation shall be held liable for any loss of data, down time, loss of
revenue or any other direct or indirect damage or claims caused by
FSASMLIB.DLL or FILES USED IN CONJUCTION with FSASMLIB.DLL.


Redistribution Terms
--------------------

FSASMLIB.DLL is FREEWARE, and:

* MAY NOT BE sold.

* MAY NOT BE uploaded to, nor archived in, BBSs which charge file
  download fees.

* MAY NOT BE uploaded to, nor archived in, BBSs which are partly or wholly 
  beneficially owned or operated by a commercial enterprise which is
  engaged in the sale of computer hardware or software.

* MAY NOT BE redistributed with computer hardware or software for which
  money is charged.

* MAY NOT BE redistributed by a commercial publisher in any form or under
  any pretext.  This prohibition includes but is not limited to floppy
  disks and CD-ROMs distributed with magazines or books.

* MAY NOT BE redistributed on floppy disk, CD-ROM, nor in any other printed
  or electronic storage form for which money is charged, nor as part of a
  package for which money is charged.  This prohibition includes but is not
  limited to any form of redistribution for which any type of materials or
  handling fees are charged.

* MAY NOT BE disassembled, decompiled, decomposed, decoded, nor reverse
  engineered.

Subject to the exclusions listed above, the archive containing FSASMLIB.DLL
may be uploaded to BBSs and otherwise redistributed on a FREEWARE basis as
long as the original compressed archive and its contents are not modified
in any way.

THERE ARE NO EXCEPTIONS to the redistribution terms stated above.


Copyright
---------

FSASMLIB.DLL carries the following copyrights:

Copyright (C) 1995-1997 by Adam Szofran.  All rights reserved.
Copyright (C) 1995-1997 by John Blackie.  All rights reserved.

Microsoft is a registered trademark of Microsoft Corporation.
Flight Simulator is a trademark of Microsoft Corporation.


<end-of-file>
