Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

$FG HOME

From FlightGear wiki
Revision as of 13:44, 31 October 2015 by Hooray (Talk | contribs) (add working screen shot which got lost during wiki outage)

Jump to: navigation, search
Screen shot showing typical structure $FG_HOME

$FG_HOME is a placeholder variable representing the path to where user-specific FlightGear data is stored (not application data). Unlike $FG_ROOT, $FG_HOME is not an environment variable that needs to be configured for FlightGear to work. $FG_HOME is the only place were FlightGear data is written to as $FG_ROOT is generally read-only.

$FG_HOME is only used to refer to the operating system specific location for some settings/folders. The actual location of $FG_HOME is determined by the fgfs binary during startup and is a directory that varies with the operating system supported by FG (Windows, OS X and Linux).

Note$FG_HOME and the /sim/fg-home property should be considered read-only, because they cannot be affected during startup or at runtime.
Note  The Fgfsrc config file will not actually be saved in $FG_HOME, but just in $HOME

Content

In $FG_HOME is information stored between sessions. That information is foe example configuration/preferences, properties marked with the user-archive attribute and aircraft-specific settings (using the data helper class in aircraft.nas). $FG_HOME is also the location for the SQLite-based NavDB cache.

Common paths

You can determine the location of your $FG_HOME by using the property browser and checking the value of /sim/fg-home, but the usual paths are shown below.

The /sim/ property subtree is also the place where you can find other folders, such as fg-root, fg-scenery and the current working directory (fg-current).

Linux

~/.fgfs/

Mac OS X

~/Library/Application Support/FlightGear (to learn more about viewing hidden folders, see [1])

As all future FlightGear versions will take their preferences from here, it is a good idea to have their access available easily.

Desktop/Finder/Go/Go to Folder is where you need to start.

When given the option, input: ~/Library/Application Support/FlightGear

It is probably a good idea to have ~/Library/Application Support/FlightGear saved on a Stickies note just in case you forget it.

If you want/need to refer to any of these files frequently, you could make an alias of a file, or the whole folder, and place it somewhere easier to access. TerraSync data is also stored inside the user's home folder, as it is the only location we are permitted to write too, $HOME/Library/Application Support/FlightGear, which technically is the value of $FG_HOME.

The OS X launcher doesn't actually set this path (any more), this location is the default used by FlightGear itself. You can of course override these paths and set $FG_HOME or the TerraSync path manually, from the command line or a configuration file, but the default paths should do what you need.

Windows

FlightGear 3.0 and later

%HOME%/Documents/FlightGear

%HOME% is usually C:/Users/User name

Before FlightGear 3.0

%APPDATA%\flightgear.org\

%APPDATA% is another environment variable that depends on your Windows version. On XP and older, it can be found under C:\Documents and Settings\User name\Application Data. On Vista and later it can be found under C:\Users\User name\AppData\Roaming. The folder is hidden by default. See these instructions to show the folder.

Use in troubleshooting

As one user once said, "When in doubt delete $FG_HOME". Many problems, including corrupted databases, broken TerraSync and many others can be fixed by deleting fgfs_0.txt, fgfs.txt, terrasync_cache, and the Navaids database.

When you encounter problems, try deleting the files, but always keep the fgfs.log and fgfs_0.log log files to help in troubleshooting.

Related content

Wiki articles