$FG ROOT: Difference between revisions

379 bytes added ,  19 January 2015
Highlighting $FG_DATA confusion; rephrasing in hope of better clarity; copyedit
m (fgdata vs. fgroot confusion)
(Highlighting $FG_DATA confusion; rephrasing in hope of better clarity; copyedit)
Line 1: Line 1:
'''$FG_ROOT''' is referred to as the main data directory of [[FlightGear]], containing the so called ''base package'' (default [[aircraft]] and [[scenery]], [[Menubar|GUI]] files, sounds, 3D models etc). With '''fgdata''' being the name of the gitorious repository containing the base package<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>. 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''. 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> (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#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!''')
: {{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\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.}}
== $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 Gitorious repository containing the base package is named <code>''fgdata''</code>.<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/>
<references/>
[[Category:Special directories|ROOT]]
[[Category:Special directories|ROOT]]