1,746
edits
$FG HOME: Difference between revisions
Jump to navigation
Jump to search
Update with recent change of location of $FG_HOME in Windows, from Documents to Downloads. Update article intro with a bit more detail. Not sure which point release of 2020.3 did the move, or if it came with the first 2020.3
(→Use in troubleshooting: +link: Commonly used debugging tools#fgfs.log) |
(Update with recent change of location of $FG_HOME in Windows, from Documents to Downloads. Update article intro with a bit more detail. Not sure which point release of 2020.3 did the move, or if it came with the first 2020.3) |
||
| Line 2: | Line 2: | ||
[[File:Fghome-3.7.png|400px|right|Screen shot showing typical structure [[$FG_HOME]]]] | [[File:Fghome-3.7.png|400px|right|Screen shot showing typical structure [[$FG_HOME]]]] | ||
<code>'''$FG_HOME'''</code> is an environment variable indicating the main location where user-specific FlightGear data is stored (not application data). <code>$FG_HOME</code> is a notable place were FlightGear data is written to | <code>'''$FG_HOME'''</code> is an environment variable indicating the main location where user-specific FlightGear data is stored (not application data). <code>$FG_HOME</code> is a notable place were FlightGear data is written to. <code>$FG_HOME</code> is also where data downloaded by FlightGear like [[TerraSync]] scenery or Aircraft data is written to, by default. | ||
<code>$FG_HOME</code> is normally used to refer to the operating system specific location for some settings/folders. Its default value is determined by the <code>fgfs</code> binary during startup and is a directory that varies with the operating system supported by FG (Windows, OS X and Linux). ''It is [https://sourceforge.net/p/flightgear/mailman/message/34995089/ highly recommended] to rely on the default value (i.e., not setting <code>$FG_HOME</code> yourself in any way), unless you Really Know What You Are Doing™.'' | <code>$FG_HOME</code> should not be confused with <code>[[$FG_ROOT]]</code>, which is generally read-only. | ||
<code>$FG_HOME</code> is normally used to refer to the operating system specific location for some settings/folders. Its default value is determined by the <code>fgfs</code> binary during startup and is a directory that varies with the operating system supported by FG (Windows, OS X and Linux). ''It is [https://sourceforge.net/p/flightgear/mailman/message/34995089/ highly recommended] to rely on the default value (i.e., not setting <code>$FG_HOME</code> yourself in any way), unless you Really Know What You Are Doing™.'' | |||
Very advanced users (i.e. power users and developers) who wish to run parallel installs of FlightGear can specify a different <code>$FG_HOME</code> for each install as described below. | |||
{{note|The <code>/sim/fg-home</code> property should be considered read-only, for similar reasons why <code>$FG_HOME</code> shouldn't be explicitly set by users.}} | {{note|The <code>/sim/fg-home</code> property should be considered read-only, for similar reasons why <code>$FG_HOME</code> shouldn't be explicitly set by users.}} | ||
| Line 40: | Line 44: | ||
=== Windows === | === Windows === | ||
==== FlightGear 2020.3 and later ==== | |||
<code>%userprofile%\Downloads\FlightGear</code> | |||
<code>%userprofile%</code> is the directory that contains the [https://docs.microsoft.com/en-us/previous-versions/windows/desktop/legacy/bb776892(v=vs.85) Windows user profile] ([http://web.archive.org/web/20210320110758/https://docs.microsoft.com/en-us/previous-versions/windows/desktop/legacy/bb776892%28v=vs.85%29 perm])<code>.</code>Ways to find the<code>%userprofile%</code> directory: 1). Press <code>Windows key+R</code>or bring up the RUN box. Type <code>%userprofile%</code> to open. 2). In command prompt, type <code>cd</code> <code>%userprofile%</code> | |||
<code>%userprofile%</code> is<code>%homedrive%\Users\''User name''</code> by default. Usually on most peoples systems: <Code>%homedrive%</Code> is C:\. | |||
For example if your user profile was called <code>MyUserProfile</code>, it would most often be located under <code>C:\Users\MyUserProfile</code> . Then the path to <code>$FG_HOME</code> would be <code>C:\Users\MyUserProfile\Downloads\FlightGear.</code> | |||
In 2020.3.x the [[FlightGear Qt launcher|qt-launcher]] will notify users who have data in the old location under <code>%userprofile%\Documents\FlightGear</code>, and prompt users to move files to the new location under <code>%userprofile%\Downloads\FlightGear</code>. | |||
==== FlightGear 3.0 and later ==== | ==== FlightGear 3.0 and later ==== | ||
<code>%userprofile%\Documents\FlightGear</code> | <code>%userprofile%\Documents\FlightGear</code> | ||