FlightGear configuration via XML: Difference between revisions

Jump to navigation Jump to search
m
(→‎defaults.xml and autosave.xml: Try to edit first part for clarity, absolutely spell everything out from the pov of a reasonably new user, one who might be uncomfortable with editing text files. Add tip. Use note template. To do: look at other parts)
m (→‎defaults.xml and autosave.xml: fix & cleanup start)
Line 12: Line 12:
On startup Flightgear reads both <code>autosave.xml</code> and <code>defaults.xml</code> to find values for all configuration settings. Flightgear then stores these settings in the [[Property_tree|property tree]] after which the parts of Flightgear that need settings will use them. These two files are [[XML|XML text files]] and you can easily read or edit them using a simple text editor.
On startup Flightgear reads both <code>autosave.xml</code> and <code>defaults.xml</code> to find values for all configuration settings. Flightgear then stores these settings in the [[Property_tree|property tree]] after which the parts of Flightgear that need settings will use them. These two files are [[XML|XML text files]] and you can easily read or edit them using a simple text editor.


* {{Base Package Resource|filename=preferences.xml}} is a XML text file that contains the ''default configuration'' settings. It comes already installed with Flightgear. <code>defaults.xml</code> should '''not''' be changed by users.
* {{Base Package Resource|filename=preferences.xml}} is a XML text file that contains the ''default configuration'' settings. It comes already installed with Flightgear.  
: <code>defaults.xml</code> should '''not''' be changed by users.


* <code>autosave.xml</code> is a XML text file that contains ''changes'' to ''some'' settings contained in <code>defaults.xml</code>. Changes to these settings are saved between sessions. <code>autosave.xml</code> can be safely edited by users.
* <code>autosave.xml</code> is a XML text file that contains ''changes'' to ''some'' settings contained in <code>defaults.xml</code>. Changes to these settings are saved between sessions.  
: <code>autosave.xml</code> should not be edited by users. If you want to set properties at startup a new custom settings XML file should be created instead of editing <code>autosave.xml</code>.


:: Note only some settings are saved between sessions. Settings which are to be saved have an XML attribute: <code>userarchive</code>. Changes to other settings will not be saved, and Flightgear will start up in the next session with the defaults from <code>defaults.xml</code>.
:: Note only some settings are saved between sessions. Settings which are to be saved have an XML attribute: <code>userarchive</code>. Changes to other settings will not be saved, and Flightgear will start up in the next session with the defaults from <code>defaults.xml</code>.


:: If you want to restore default settings ('factory defaults') to see if a problem goes away you can delete <code>autosave.xml</code>. You can also back up the file and restore it later. See [[Troubleshooting_problems]].
:: If you want to restore default settings ('factory defaults') to see if a problem goes away you can delete <code>autosave.xml</code>. You can also back up the file and restore it later. See [[Troubleshooting_problems|troubleshooting]].


{{Note|We should absolutely stop telling anyone to edit {{Base Package Resource|filename=preferences.xml}} in FG_ROOT; any documentation or advice which says to should be changed ASAP. <ref>{{cite web
{{Note|We should absolutely stop telling anyone to edit {{Base Package Resource|filename=preferences.xml}} in FG_ROOT; any documentation or advice which says to should be changed ASAP. <ref>{{cite web
1,746

edits

Navigation menu