Howto:Install scenery: Difference between revisions

Jump to navigation Jump to search
Rewriting parts of the article
m (→‎Types of scenery: Rephrasing the caution messagebox)
(Rewriting parts of the article)
Line 17: Line 17:
: Reasonable level of detail scenery spanning the world and scenery objects, such as for example landmarks and airport buildings.
: Reasonable level of detail scenery spanning the world and scenery objects, such as for example landmarks and airport buildings.
; TerraSync scenery
; TerraSync scenery
: Basically the same as the world scenery. In addition it also contains the latest scenery objects added to the [[Scenery Objects Database|scenery objects database]] by fellow FlightGear users.
: Basically the same as the world scenery. In addition it also contains the latest scenery objects added by fellow FlightGear users to the [[Scenery Objects Database|scenery objects database]].
; Custom scenery
; Custom scenery
: Non-official scenery covering all the way from small areas to very large areas, often with a high level of detail.
: Non-official scenery covering all the way from small areas to very large areas, often with a high level of detail.
The default scenery is two 1 by 1 degree tiles surrounding the San Francisco Bay area from the World scenery.


{{caution|'''Do not mix scenery''' types in the '''same directory'''.  It may cause problems like custom scenery being overwritten by the TerraSync or TerraMaster utilities, TerraMaster getting locked etc.}}
{{caution|'''Do not mix scenery''' types in the '''same directory'''.  It may cause problems like custom scenery being overwritten by the TerraSync or TerraMaster utilities, TerraMaster getting locked etc.}}
Line 65: Line 67:


== Installing World and custom scenery ==
== Installing World and custom scenery ==
Install scenery outside the <code>[[$FG_ROOT]]</code> directory.  See [[#Technical details]] below for an explanation.
=== Installing via a graphical interface ===
=== Installing via a graphical interface ===
# Open the [[FlightGear Admin Wizard]].
# Open the [[FlightGear Admin Wizard]].
# Click on '''Select Scenery Source...''' to select the directory containing the scenery .tgz files.
# Click on ''Select Scenery Source...'' to select the directory containing the scenery .tgz files.
# Click on '''Select Install Destination...''' to select the directory where you want to install the scenery.
# Click on ''Select Install Destination...'' to select the directory where you want to install the scenery.
#* On GNU/Linux, it should be a directory outside <tt>[[$FG_ROOT]]</tt> (see [[#Technical]] for an explanation).
#* On Windows, it should be a directory you can read from/write to. If you use FlightGear 3.2 and above, the default path (<code>C:\Users\''your user name''\Documents\FlightGear\Custom Scenery</code>) is perfectly fine.
#* On Windows, it should be a directory you can read from/write to. If you use FlightGear 3.2 and above, the default path ('''C:\Users\''your user name''\Documents\FlightGear\Custom Scenery''') is perfectly fine.
#* On Macintosh systems, the path should be <code>/Applications/FlightGear.app/Contents/Resources/data/Scenery</code>.
#* On Macintosh systems, the path should be '''/Applications/FlightGear.app/Contents/Resources/data/Scenery'''.
# In the left pane, check the scenery tiles you want to install and click on ''Install Selected Files'' to install the scenery.
# In the left pane, check the scenery tiles you want to install and click on '''Install Selected Files''' to install the scenery.


=== Alternate installation, GNU/Linux ===
=== Alternate installation, GNU/Linux ===
Line 84: Line 87:
  tar -xvzf 'input_file.tgz' -C SceneryDirectory
  tar -xvzf 'input_file.tgz' -C SceneryDirectory


In the above two examples, it is supposed that <tt>SceneryDirectory</tt> is set to a directory, outside <tt>[[$FG_ROOT]]</tt> (see [[#Technical]] for the reasoning behind this). Additionally, <tt>input_file.tgz</tt> should be substituted with the filename of the archive to be extracted (the filename should be completed with the full pathname or any other valid method so that the shell could find the correct archive).
<code>input_file.tgz</code> should be substituted with the filename of the archive to be extracted (the filename should be completed with the full pathname or any other valid method so that the shell could find the correct archive).


=== Alternate installation, Windows ===
=== Alternate installation, Windows ===
Simply unpack the downloaded scenery into a directory of choice, outside the <tt>[[$FG_ROOT]]</tt> directory (see [[#Technical]] for the reasoning behind this), using software like [http://www.winzip.com/ Winzip] or [http://www.7-zip.org 7-zip]. Once done, append this directory to [[$FG_SCENERY]]. When using the [[FlightGear Wizard]], you can do so on the first page (previous from aircraft selection). Do not forget to press the "Refresh" button on the airport selection page, when using the wizard.
Simply unpack the downloaded scenery into a directory of choice, using software like [http://www.winzip.com/ Winzip] or [http://www.7-zip.org 7-zip]. Once done, append this directory to <code>[[$FG_SCENERY]]</code>. When using the [[FlightGear Wizard]], you can do so on the first page (previous from aircraft selection). Do not forget to press the "Refresh" button on the airport selection page, when using the wizard.


{{note|More recent Windows versions (e.g. XP, Vista, Win7) tinkering a lot with user rights on access level. Therefore it is a bad idea to install and run FlightGear (scenery) to and from <tt>C:\Program Files</tt>. Find another drive/folder where you, as logged in user, have all neccesary right to read, write and execute the files you installed. Additionally there's a space / blank in folder's name which could cause weird behaviour. Using <tt>C:\FlightGear</tt> is a nice option.}}
{{note|More recent Windows versions (e.g. XP, Vista, Win7) tinkering a lot with user rights on access level. Therefore it is a bad idea to install and run FlightGear (scenery) to and from <code>C:\Program Files</code>. Find another drive/folder where you, as logged in user, have all neccesary right to read, write and execute the files you installed. Additionally there's a space / blank in folder's name which could cause weird behaviour. Using <code>C:\FlightGear</code> is a nice option.}}


=== Alternate installation, Macintosh ===
=== Alternate installation, Macintosh ===
Unpack the tgz file either by double-clicking it and moving the resulting wXXXnXXX folder to the Scenery folder described in the next line, or on the command line:
Unpack the .tgz file either by double-clicking it and moving the resulting <code>wXXXnXXX</code> folder to the Scenery folder described in the next line, or on the command line:
 
  tar -xvzf 'input_file.tgz' -C /Applications/FlightGear.app/Contents/Resources/data/Scenery
  tar -xvzf 'input_file.tgz' -C /Applications/FlightGear.app/Contents/Resources/data/Scenery


== Technical details ==
== Technical details ==
Scenery for FlightGear is determined by looking at the environment variable [[$FG SCENERY]]. Should the paths in $FG_SCENERY not be valid, FlightGear falls back to <tt>[[$FG ROOT]]/Scenery</tt>.
=== Scenery lookup and $FG_SCENERY ===
FlightGear determines what scenery to use by looking at the environment variable <code>[[$FG SCENERY]]</code>.  There can be more than one scenery path in the variable, for example one path to to TerraSync scenery and one path to custom scenery.  Scenery can be overlapping and a tile will be loaded from the first path in <code>$FG SCENERY</code> from which it is available.
 
Should the paths in <code>$FG_SCENERY</code> not be valid, FlightGear falls back to <code>[[$FG ROOT]]/Scenery</code>.


Mixing scenery types is almost universally a bad idea, and is unsupported. In this connection you should note that the scenery packaged with the base package/windows installer may not be the latest scenery.
=== Directories and configuring $FG_SCENERY ===
Mixing scenery types is almost universally a bad idea, and is unsupported. You should also note that the scenery packaged with the base package/windows installer may not be the latest scenery.


For this reason it's probably better to extract scenery files you've downloaded into a new folder, which we'll call, for the sake of this exercise, <tt>$FOOBAR/Scenery</tt>.
For this reason it is probably better to extract scenery files you have downloaded into a new folder, which we for the sake of this exercise will call <code>$FOOBAR/Scenery</code>.
In this directory, create two subdirectories: /Objects and /Terrain. You should untar individual files into the /Terrain folder.
In this directory, create two subdirectories: <code>/Objects</code> and <code>/Terrain</code>. You should untar individual files into the <code>/Terrain</code> folder.


Then you should set up $FG_SCENERY to use the new path:
Then you should set up $FG_SCENERY to use the new path:
* On POSIX Clients
* On POSIX Clients
*: <tt>set FG_SCENERY="$FOOBAR/Scenery" + FG_SCENERY</tt>
*: <code>set FG_SCENERY="$FOOBAR/Scenery" + FG_SCENERY</code>
* On Windows (FGRun)
* On Windows ([[FGRun]])
*: Go back to the first page of fgrun, and add the <tt>$FOOBAR/Scenery</tt> folder to the list.
*: Go back to the first page of fgrun, and add the <code>$FOOBAR/Scenery</code> folder to the list.
* Via a commandline option
* Via a command line option
*: <tt>--fg-scenery="$FOOBAR/Scenery"</tt>
*: <code>--fg-scenery="$FOOBAR/Scenery"</code>


=== Terrain ===
=== Directory structure ===
==== Terrain ====
The Scenery directory will show the following (scenery is shown for completeness and for easy reference to above):
The Scenery directory will show the following (scenery is shown for completeness and for easy reference to above):


<tt>
<code>
* Scenery/
* Scenery/
** Terrain/
** Terrain/
Line 120: Line 129:
** Objects/
** Objects/
*** w130n30/
*** w130n30/
</tt>
</code>


If you download a scenery module called w90n40.tgz from [http://flightgear.org/Downloads/scenery-1.0.1.html flightgear.org] and extract it in Scenery, the result will resemble something like the following:
If you download a scenery module called <code>w90n40.tgz</code> from [http://flightgear.org/Downloads/scenery-1.0.1.html flightgear.org] and extract it in <code>Scenery</code>, the result will resemble something like the following:


<tt>
<code>
* Scenery/
* Scenery/
** Terrain/
** Terrain/
Line 132: Line 141:
*** w09n40/
*** w09n40/
*** w130n30/
*** w130n30/
</tt>
</code>


Note that the directory structure is already present in the tar archive, starting from the Scenery directory. Note that you have to extract the tar archive in the Scenery directory, not in the FG_ROOT directory, because the Scenery directory is not present in the archive.
Note that the directory structure is already present in the tar archive, starting from the Scenery directory. Note that you have to extract the tar archive in the Scenery directory, not in the <code>$FG_ROOT</code> directory, because the Scenery directory is not present in the archive.


=== Objects ===
==== Objects ====
Objects and models can be found at the [http://scenemodels.flightgear.org/ FlightGear Scenery Objects Database].
Objects and models can be found at the [[FlightGear Scenery Object Database]].


These objects are included in each scenery release, but as the object database is more frequently updated than the terrain, one may want to occasionally update the Object subdirectory from the FlightGear Scenery Objects Database between scenery releases.
These objects are included in each scenery release, but as the object database is more frequently updated than the terrain, one may want to occasionally update the <code>Object</code> subdirectory from the scenery objects database between scenery releases.
Another option is to download or update the scenery on-demand by using the terrasync program described below.


Objects are really part of the scenery and can be found in the Scenery directory under [[$FG ROOT]].
Another option is to download or update the scenery on-demand by using the built in TerraSync utility described above.


<tt>
Objects are really part of the scenery and can be found in the <code>Scenery</code> directory under <code>$FG ROOT</code>.
 
<code>
* Scenery/
* Scenery/
** Objects/
** Objects/
*** w130n30/
*** w130n30/
</tt>
</code>


Any objects should be installed under the <tt>Scenery/Objects</tt> directory.
Any objects should be installed under the <code>Scenery/Objects</code> directory.


=== Models ===
==== Models ====
Replaces the former <tt>[[$FG_ROOT]]/Models</tt>; stores all the shared objects.
Replaces the former <code>$FG_ROOT/Models</code>; stores all the shared objects.


<tt>
<code>
* Scenery/
* Scenery/
** Models/
** Models/
*** Airport/
*** Airport/
</tt>
</code>


=== Airports ===
==== Airports ====
{{Main article|About Scenery/Airports}}
{{Main article|About Scenery/Airports}}
As of FlightGear 2.4.0, this directory is used to extract airport data (like runway usage and parking spots) from.
As of FlightGear 2.4.0, this directory is used to extract airport data (like runway usage and parking spots) from.


The directory tree might look somewhat overwhelming, but it simply follows the <tt>Airports/[I]/[C]/[A]/</tt> code (see [[ICAO-code]]).
The directory tree might look somewhat overwhelming, but it simply follows the <code>Airports/[I]/[C]/[A]/</code> code (see [[ICAO-code]]).
<tt>
<code>
* Scenery/
* Scenery/
** Airports/
** Airports/
Line 172: Line 182:
**** S/
**** S/
***** F/
***** F/
</tt>
</code>


== Related content ==
== Related content ==
* [[Scenery FAQ]]
* [[Scenery FAQ]]
[[Category:Scenery]]


[[de:Howto:Install_scenery]]
[[de:Howto:Install_scenery]]
Line 183: Line 195:
[[PL:Instalowanie scenerii]]
[[PL:Instalowanie scenerii]]
[[pt:Instalando Cenário]]
[[pt:Instalando Cenário]]
[[Category:Scenery]]

Navigation menu