$FG ROOT: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Cleanup)
(Added an early reference to FGData for clarity.)
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
'''$FG_ROOT''' is refered to as the main directory of [[FlightGear]], containing the so called ''base package'' (default [[aircraft]] and [[scenery]], [[Menubar|GUI]] files etc). When running FlightGear from a [[command line]], you can set $FG_ROOT via <tt>--fg-root=path/to/root</tt>. In [[FGRun]], it is set on the paths page, previous to the aircraft selection page.
The environment variable <code>'''$FG_ROOT'''</code> is referring to the path of the main data directory of [[FlightGear]], which contains the so called ''base package'', also known as [[FGData]]. The base package consists of the default [[aircraft]] and [[scenery]], [[Menubar|GUI]] files, sounds, 3D models etc.


As of FlightGear 2.4, it is advised to install additional scenery and aircraft in [[$FG_SCENERY]] and [[$FG_AIRCRAFT]] directories outside $FG_ROOT. This allow for maintaining the additional stuff when installing a new version of FlightGear.
When running FlightGear from a [[command line]], you can set <code>$FG_ROOT</code> via <code>--fg-root=path/to/root</code>. In [[FGRun]], it is set on the paths page, previous to the aircraft selection page.


=== Common paths ===
As of FlightGear 2.4, it is advised to install additional scenery and aircraft in <code>[[$FG_SCENERY]]</code> and <code>[[$FG_AIRCRAFT]]</code> directories outside <code>$FG_ROOT</code>. This allow for maintaining the additional stuff when installing a new version of FlightGear.
* '''Mac OS X:''' <tt>Applications/FlightGear.app/Contents/Resources/data/</tt>
: $FG_ROOT is not installed automatically. See [[New to FlightGear#Installing on Mac OS X|New to FlightGear]] for an installation manual.
* '''Ubuntu:''' <tt>/usr/share/games/flightgear/</tt>
* '''Windows:''' <tt>Program Files\FlightGear\data\</tt> (default, '''see note!''')
: Newer Windows versions are very, very protective about the <tt>Program Files</tt> folder and installing FlightGear into this folder makes it prone to any problems relating to file read/write permissions. Hence, installing FlightGear into <tt>Program Files</tt> on Windows Vista and later is not recommended.


== Common paths ==
* '''Mac OS X:''' <code>Applications/FlightGear.app/Contents/Resources/data/</code> (right-click on FlightGear.app and select "Show Package Contents" to see the Contents folder)
: <code>$FG_ROOT</code> is not installed automatically. See [[New to FlightGear#Installing on Mac OS X|New to FlightGear]] for an installation manual.
* '''Ubuntu:''' <code>/usr/share/games/flightgear/</code>
* '''Windows:''' <code>Program Files\FlightGear 2016.1.1\data\</code> (default, '''see note!''')
{{note|Newer '''Windows''' versions are very, very protective about the '''<code>Program Files</code> folder'''.
Installing FlightGear into this folder makes it prone to any problems relating to file read/write permissions. Hence, installing FlightGear into <code>Program Files</code> on Windows Vista and later is not recommended. ''(I have yet to see where installing it outside of the default location actually helps - '''jaxsin''')''}}
== $FG_DATA ==
You will sometimes see <code>$FG_ROOT</code> erroneously being mentioned as <code>'''$FG_DATA'''</code>.  While there is no <code>$FG_DATA</code> environment variable, the SourceForge repository containing the base package is named <code>[[FGData]]</code> and was earlier named <code>fgdata</code> in Gitorious.<ref>https://www.mail-archive.com/search?q=fgdata&l=flightgear-devel%40lists.sourceforge.net</ref><ref>https://www.mail-archive.com/search?l=flightgear-devel%40lists.sourceforge.net&q=fg_data&x=0&y=0</ref>
== References ==
<references/>
[[Category:Special directories|ROOT]]
[[Category:Special directories|ROOT]]


Line 15: Line 25:
[[fr:$FG ROOT]]
[[fr:$FG ROOT]]
[[nl:$FG_ROOT]]
[[nl:$FG_ROOT]]
[[es:$FG_ROOT]]

Revision as of 15:42, 14 May 2016

The environment variable $FG_ROOT is referring to the path of the main data directory of FlightGear, which contains the so called base package, also known as FGData. The base package consists of the default aircraft and scenery, GUI files, sounds, 3D models etc.

When running FlightGear from a command line, you can set $FG_ROOT via --fg-root=path/to/root. In FGRun, it is set on the paths page, previous to the aircraft selection page.

As of FlightGear 2.4, it is advised to install additional scenery and aircraft in $FG_SCENERY and $FG_AIRCRAFT directories outside $FG_ROOT. This allow for maintaining the additional stuff when installing a new version of FlightGear.

Common paths

  • Mac OS X: Applications/FlightGear.app/Contents/Resources/data/ (right-click on FlightGear.app and select "Show Package Contents" to see the Contents folder)
$FG_ROOT is not installed automatically. See New to FlightGear for an installation manual.
  • Ubuntu: /usr/share/games/flightgear/
  • Windows: Program Files\FlightGear 2016.1.1\data\ (default, see note!)
Note  Newer Windows versions are very, very protective about the Program Files folder.

Installing FlightGear into this folder makes it prone to any problems relating to file read/write permissions. Hence, installing FlightGear into Program Files on Windows Vista and later is not recommended. (I have yet to see where installing it outside of the default location actually helps - jaxsin)

$FG_DATA

You will sometimes see $FG_ROOT erroneously being mentioned as $FG_DATA. While there is no $FG_DATA environment variable, the SourceForge repository containing the base package is named FGData and was earlier named fgdata in Gitorious.[1][2]

References