FGo! - A simple GUI launcher for FlightGear.

-------------------------------------------------------------------------------

MINIMUM REQUIREMENTS

Operating system GNU/Linux
FlightGear
Python 2.6.8 *
TKinter
Python Imaging Library (PIL) 1.1.6 (with ImageTk module) **
Tcl/Tk 8.5

*  FGo! is compatible only with Python 2.x series.
** This library is not mandatory to run FGo! but aircraft thumbnails 
   will not be displayed without it.

-------------------------------------------------------------------------------

INSTALLATION

This program requires no installation, but Python (with Tkinter and
PIL modules) and Tcl/Tk library need to be installed prior FGo!'s first run.
All of them should be available in the repositories. In Debian based
distributions you may be required to install these packages:
python, python-tk, python-imaging, python-imaging-tk, tcl8.x and tk8.x.

You may simply choose python-imaging-tk, and your manager should automatically
install all other required dependencies.

For Slackware GNU/Linux and compatible systems, a SlackBuild script for FGo! is
available. The included script will generate a package that allows for a clean,
system-wide installation of the program. The SlackBuild can be downloaded from
http://www.slackbuilds.org. On default Slackware systems no additional packages
are required.

-------------------------------------------------------------------------------

RUNNING

FGo! does not provide its own window to print FlightGear's messages, that's why
the best method to run the application is to run it from command line. Open
a terminal, navigate to directory where the FGo! was unpacked and run it using
"python fgo" or "./fgo" command, or if your system offers this feature,
you can simply click on the fgo icon and choose in dialog option:
Run in terminal. In the last two cases, make sure that fgo file is
an executable.

Starting from version 1.3.0, you don't need to navigate to its main directory
before starting it. You can now simply create symbolic link to "fgo" file,
and place it whatever you want, or run it from any location with command like:
python ~/fgo_main_folder/fgo .

-------------------------------------------------------------------------------

CONFIGURATION

In order to use FGo! you need to first set it up. Open preferences window
(in menu choose: Settings => Preferences) and fill in empty entry fields.

FlightGear settings:

    Path to executable file - enter the path to "fgfs" file, or "run_fgfs.sh",
        if you are using download_and_compile.sh scripts.

    FG_ROOT - path to FlightGear's main directory.

    FG_SCENERY - path to scenery. You can specify more than one path
        (separated by a colon) in order from highest to lowest layer.

    Additional aircraft path - path to additional aircraft directory.
        Multiple directories separated by a colon can be included. Leave it
        empty if you are not using additional aircraft directories.

    Working directory - optional parameter specifying FlightGear's working
        directory. That is the directory where logs or screen-shots
        will be saved. If left blank, the working directory is the user's
        home directory.

TerraSync settings:

    Path to executable file - enter the path to "terrasync" file, or
        "run_terrasync.sh", if you are using download_and_compile.sh scripts.

    Scenery path - directory where TerraSync saves downloaded scenery.

    Port - a port address used by TerraSync.

Miscellaneous:

    Change language - choose another language. If language not selected,
        FGo! will try to choose the system language.

    Airport data source - select data source where FGo! will be looking for
        information about runways or parking positions. There are two options:

        Default - FGo! will show runway numbers based on ~/.fgo/apt file,
            which is generated from FG_ROOT/Airports/apt.dat.gz database.
            Parking names will be taken from FG_ROOT/AI/Airports directory.

        Scenery - FGo! will show runway numbers based on ~/.fgo/apt file,
            which is generated from FG_ROOT/Airports/apt.dat.gz database.
            Parking names will be taken from FG_SCENERY/Airports folder
            - or folders - if multiple scenery paths are provided.

        Generally speaking: "Default" option will tell FGo! to show the same
        data that FlightGear uses by default when selecting starting location,
        while "Scenery" option will tell FGo! to look for that data
        directly in scenery folder. In that latter case, you may add
        --prop:/sim/paths/use-custom-scenery-data=true argument into command
        line options window to tell FlightGear to use the same data.

        If not sure which option you should choose, the best is to stick
        with the default setting.

    Airport database update - two options to choose from:
        Automatic - FGo! will try to keep track of changes of 
	    FG_ROOT/Airports/apt.dat.gz file, and will rebuild its airport 
	    database when need it.
		
        Manual - "Rebuild Airport Database" button needs to be used every time 
            FG_ROOT/Airports/apt.dat.gz is changed.

    Rebuild Airport Database - build new airport database from current
        FG_ROOT/Airports/apt.dat.gz. Useful in case when apt.dat.gz file
        has been updated.

Filling the first three entries is necessary for proper operation of
the program - the rest is optional. When you are done with configuration,
click "Save Settings" button. After a few moments, in the main window should
appear a list of available aircraft and airports.

Changes in FlightGear's settings are applied immediately after clicking on
"Save Settings" button, however changes in TerraSync and language settings
may require restarting FGo!.

-------------------------------------------------------------------------------

MAIN MENU ITEMS

File:

    Load - load specified config file.

    Save as... - save settings to specified config file.

    Save & Quit - save settings and quit the application.

    Quit - quit the application.

Settings:

    Show installed airports only - only airports present in scenery actually
        installed on the hard drive will be shown on the airport list.

    Update list of installed airports - scan hard drive for installed scenery
        and update the airport list. It works only if "Show installed airports
        only" is selected.

    Preferences - open preferences window.

Tools:

    METAR - show METAR report for selected (or nearest) airport. These reports
        are downloaded from http://weather.noaa.gov/

Help:

    Help - open "Help" window.

    About - open "About" window.

-------------------------------------------------------------------------------

COMMAND LINE OPTIONS WINDOW

In text window at the bottom, you can write command line options that will be
passed to FlightGear.

Few options are provided by default, for more examples consult FlightGear
documentation or check Wiki at:
http://wiki.flightgear.org/index.php/Command_Line_Options

-------------------------------------------------------------------------------

TIPS&TRICKS

* If airport data source was set to "Scenery", then information about
  airport's park positions may not be available until corresponding scenery
  is installed.

* You can start a flight from an aircraft carrier. In a middle panel click on
  current airport ICAO code (right under aircraft picture) and choose one from
  available ships. ICAO code will then change to selected ship's name,
  and will be highlighted blue to indicate that you're now in "carrier mode".
  Corresponding scenario will be selected automatically.
  To be able to choose airports again, you need to click on carrier name,
  and from popup list select "None".

* In "Select Scenario" list, you can right click on any scenario to see its
  description (if available).

* Window resolution is saved when "Save&Quit" button is clicked.

* If you would like to distinguish FGo! launcher from other files,
  you can replace its default icon with picture called "fgo.png"
  located in "fgo/data/pics" directory.

-------------------------------------------------------------------------------

KNOWN BUGS AND LIMITATIONS

* FGo! does not track if TerraSync has been actually closed before starting
  a new instance of it. If "TerraSync" checkbutton is unchecked and checked
  again in short period of time, "error binding to port 5501" message may be
  shown in a console. It indicates that old instance of TerraSync does not
  finished downloading data yet. In that case, wait until download is finished
  and check "TerraSync" checkbutton again.

* Very long parking places names does not fit in parking button.

-------------------------------------------------------------------------------

                                             Thank you for using this software,
                                             Robert 'erobo' Leda  <erobo@wp.pl>
