FlightGear wiki - User contributions [en]

Howto:Translate FlightGear

2021-02-09T14:21:07Z

Slawekmikula: added qt liguist image to the description

FlightGear supports localization, that is, showing the user interface in the user's native language rather than in English.

This page will help you translate FlightGear to a new language or improve the existing translations.

== What can be translated ==
The following parts of the simulator can be translated:
* the menus, splash screens, startup tips and the text shown when the <code>--help</code> command-line option is used (FlightGear 2.7.0 and later)
* the shortcut file on Linux systems (FlightGear 2017.1 and later)
* the man pages (FlightGear 2017.3 and later)
* the built-in launcher (FlightGear 2018.3 and later)

== How to translate ==
# Determine the two letter ISO 639-1 language code for the language you want to translate FlightGear to. A list can be found on the [https://www.loc.gov/standards/iso639-2/php/code_list.php Library of Congress Web site].
# Check whether your language already has a subdirectory below [{{fgdata url|path=Translations}} the Translations directory]. If it does not, ask on the development mailing for the empty translation files to be created for you. (It's better to do this than copying an existing translation, because of data that will be accidentally included otherwise)
# Open the .XLF files in the subdirectory of your language and translate the English strings in them. You can edit the .XLF files in a text editor (such as Notepad++ or GEdit) but you can also use translation tools such as Qt Linguist or any XLIFF editor. Using a structured tool is recommended because it can track the translation state (flagging untranslated strings) and most tools include helpers to partially automate the translation process.
# Start FlightGear to test your translation. By default, the simulator will select the locale of your operating system as the language to use; you can explicitly select a language using the command-line option <code>--language=language code</code>.
# Submit your updated .XLF files for inclusion via the development mailing list or a SourceForge merge request

There are two XLF files in each language subdirectory : one for the core simulator strings (startup messages, command line arg help, hints) and one for the launcher.

Note that the user interface might have not full Unicode support (some special/accented characters might not be shown): should you encounter such a location, please write to the flightgear-devel mailing list at {{Mailing list e-mail address|flightgear-devel}}.

== How to translate the shortcut file ==
Open [{{flightgear url|path=package/org.flightgear.FlightGear.desktop}} the FlightGear <code>.desktop</code> file] and translate the ''GenericName'', ''Comment'' and ''Keywords'' keys (add the ''GenericName[xx]'', ''Comment[xx]'' and ''Keywords[xx]'' keys, where ''xx'' is the two letter ISO 639-1 code of the language).

== How to translate the man pages ==
# Determine the two letter ISO 639-1 language code for the language you want to translate the man pages to.
# Check whether your language already has a subdirectory below [{{flightgear url|path=man}} the man pages directory]. If it does not, create an empty directory in it named after the language code, then copy <code>man1</code> and <code>man5</code> from the man pages directory to the directory of your language.
# Edit [{{flightgear url|path=man/CMakeLists.txt}} man/CMakeLists.txt] and add the instruction <code>add_subdirectory(xx)</code> in the <code>if(NOT WIN32)</code> block (where ''xx'' is the language code).
# Edit <code>man/xx/man1/CMakeLists.txt</code> and <code>man/xx/man5/CMakeLists.txt</code>: on the last row, set the installation directory (<code>DESTINATION</code>), respectively, to <code>${CMAKE_INSTALL_MANDIR}/xx/man1</code> and <code>${CMAKE_INSTALL_MANDIR}/xx/man5</code>.
# Open the man pages in the subdirectory of your language and translate them.

== Using QtLinguist to translate XLF Files ==

One can use QtLinguist (application from the QT package) to translate XLIFF files. Install QT package from the Qt home page (https://www.qt.io/download). Opening QtLinguist will show default translation environment. Open XLF file and start translating. The interface is divided into four main sections:

* Context - this is a grouping of the strings to translate. Defined by the developer. Icon beside the group show translation status. Everything should be in the end with the green check sign.
* Strings - strings in the selected group. Select string to translate it
* Sources and Forms - additional information about location of the translated string in the source code (not always visible and with correct information)
* Source text - the main place where translation occurs. Translate here selected strings.

One have to translate the original strings into the target language. Icon beside the original text in the 'Strings' section will show status. Green check mark when everything is correct. Yellow question mark, when the translation is in place but it it not marked as "verified". Untranslated strings are marked with the grey question mark. Sometimes QtLinguist displays exclamation mark - this shows that the translated text does not conform to the original text e.g. original text ends with the punctuation but the translated text not. Buttons (and keyboard shortcuts) on the main toolbar area helps with the strings matching. When the text is translated and you're comfortable with the style/meaning etc. you select green check mark button. It marks the translation as translated-verified. So this is the expected end state for this.

[[File:Qt Linquist.png|700px|frameless]]

Reference:
* [https://doc.qt.io/qt-5/qtlinguist-index.html Qt Linguist manual]
* [https://doc.qt.io/qt-5/linguist-translators.html Qt Linguist for translators guide]

== Related content ==
* [[Howto: Translate FlightGear Launch Control‎‎]]
* [[Translation requests]]

[[Category:Howto|Translate FlightGear]]

File:Qt Linquist.png

2021-02-09T14:16:32Z

Slawekmikula: Uploaded own work with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=QT Linguist main window - translating FlightGear}}
|date=2021-02-09
|source={{own}}
|author=[[User:Slawekmikula|Slawekmikula]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Software]]

Howto:Translate FlightGear

2021-02-09T14:14:59Z

Slawekmikula: added information about Qt Linguist for translation

FlightGear supports localization, that is, showing the user interface in the user's native language rather than in English.

This page will help you translate FlightGear to a new language or improve the existing translations.

== What can be translated ==
The following parts of the simulator can be translated:
* the menus, splash screens, startup tips and the text shown when the <code>--help</code> command-line option is used (FlightGear 2.7.0 and later)
* the shortcut file on Linux systems (FlightGear 2017.1 and later)
* the man pages (FlightGear 2017.3 and later)
* the built-in launcher (FlightGear 2018.3 and later)

== How to translate ==
# Determine the two letter ISO 639-1 language code for the language you want to translate FlightGear to. A list can be found on the [https://www.loc.gov/standards/iso639-2/php/code_list.php Library of Congress Web site].
# Check whether your language already has a subdirectory below [{{fgdata url|path=Translations}} the Translations directory]. If it does not, ask on the development mailing for the empty translation files to be created for you. (It's better to do this than copying an existing translation, because of data that will be accidentally included otherwise)
# Open the .XLF files in the subdirectory of your language and translate the English strings in them. You can edit the .XLF files in a text editor (such as Notepad++ or GEdit) but you can also use translation tools such as Qt Linguist or any XLIFF editor. Using a structured tool is recommended because it can track the translation state (flagging untranslated strings) and most tools include helpers to partially automate the translation process.
# Start FlightGear to test your translation. By default, the simulator will select the locale of your operating system as the language to use; you can explicitly select a language using the command-line option <code>--language=language code</code>.
# Submit your updated .XLF files for inclusion via the development mailing list or a SourceForge merge request

There are two XLF files in each language subdirectory : one for the core simulator strings (startup messages, command line arg help, hints) and one for the launcher.

Note that the user interface might have not full Unicode support (some special/accented characters might not be shown): should you encounter such a location, please write to the flightgear-devel mailing list at {{Mailing list e-mail address|flightgear-devel}}.

== How to translate the shortcut file ==
Open [{{flightgear url|path=package/org.flightgear.FlightGear.desktop}} the FlightGear <code>.desktop</code> file] and translate the ''GenericName'', ''Comment'' and ''Keywords'' keys (add the ''GenericName[xx]'', ''Comment[xx]'' and ''Keywords[xx]'' keys, where ''xx'' is the two letter ISO 639-1 code of the language).

== How to translate the man pages ==
# Determine the two letter ISO 639-1 language code for the language you want to translate the man pages to.
# Check whether your language already has a subdirectory below [{{flightgear url|path=man}} the man pages directory]. If it does not, create an empty directory in it named after the language code, then copy <code>man1</code> and <code>man5</code> from the man pages directory to the directory of your language.
# Edit [{{flightgear url|path=man/CMakeLists.txt}} man/CMakeLists.txt] and add the instruction <code>add_subdirectory(xx)</code> in the <code>if(NOT WIN32)</code> block (where ''xx'' is the language code).
# Edit <code>man/xx/man1/CMakeLists.txt</code> and <code>man/xx/man5/CMakeLists.txt</code>: on the last row, set the installation directory (<code>DESTINATION</code>), respectively, to <code>${CMAKE_INSTALL_MANDIR}/xx/man1</code> and <code>${CMAKE_INSTALL_MANDIR}/xx/man5</code>.
# Open the man pages in the subdirectory of your language and translate them.

== Using QtLinguist to translate XLF Files ==

One can use QtLinguist (application from the QT package) to translate XLIFF files. Install QT package from the Qt home page (https://www.qt.io/download). Opening QtLinguist will show default translation environment. Open XLF file and start translating. The interface is divided into four main sections:

* Context - this is a grouping of the strings to translate. Defined by the developer. Icon beside the group show translation status. Everything should be in the end with the green check sign.
* Strings - strings in the selected group. Select string to translate it
* Sources and Forms - additional information about location of the translated string in the source code (not always visible and with correct information)
* Source text - the main place where translation occurs. Translate here selected strings.

One have to translate the original strings into the target language. Icon beside the original text in the 'Strings' section will show status. Green check mark when everything is correct. Yellow question mark, when the translation is in place but it it not marked as "verified". Untranslated strings are marked with the grey question mark. Sometimes QtLinguist displays exclamation mark - this shows that the translated text does not conform to the original text e.g. original text ends with the punctuation but the translated text not. Buttons (and keyboard shortcuts) on the main toolbar area helps with the strings matching. When the text is translated and you're comfortable with the style/meaning etc. you select green check mark button. It marks the translation as translated-verified. So this is the expected end state for this.

Reference:
* [https://doc.qt.io/qt-5/qtlinguist-index.html Qt Linguist manual]
* [https://doc.qt.io/qt-5/linguist-translators.html Qt Linguist for translators guide]

== Related content ==
* [[Howto: Translate FlightGear Launch Control‎‎]]
* [[Translation requests]]

[[Category:Howto|Translate FlightGear]]

FlightGear as Bluetooth NMEA GPS provider

2021-01-02T22:26:07Z

Slawekmikula: added screens & explanation

== FlightGear as GPS position provider to other devices via Bluetooth ==

FlightGear can act as a GPS current aircraft location provider for other software/devices via GPS/NMEA protocol. In order to do this one have to configure FlightGear to send this information and to configure host computer as a Bluetooth NMEA provider via virtual COM (rfcomm). This recipe is provided for Linux boxes.

== Linux on the PC, Android on the mobile device ==

This guide uses Debian Linux. Other distributions such as Ubuntu should be similar.

Note: at the end of the guide, your Android device will believe that your PC is an external GPS unit. Hence, you can use any map application of your choice. You can also try Android software such as [https://play.google.com/store/apps/details?id=net.osmand OSMAnd], [https://play.google.com/store/apps/details?id=com.orux.oruxmaps OruxMaps] or Google Maps/Earth. Screens comes from the Avia Maps Android software [https://play.google.com/store/apps/details?id=com.mytowntonight.aviamap].

=== Preparations (only once) ===

* Install Air Navigation on the mobile device. This guide will use Air Navigation Pro (the paid version of Air Navigation)
* Install bluez on your PC, and a suitable GUI for your window manager (bluedevil for KDE, gnome-bluetooth for Gnome)

<pre>sudo apt-get install bluez-tools bluedevil</pre>

* Switch on Bluetooth communications on your mobile device and your PC
* Pair your mobile and your PC, if they are not paired yet. In Android: Configuration->Wireless->Bluetooth settings->Make device discoverable. In your PC, use a GUI such as BlueDevil (KDE) or gnome-bluetooth (Gnome) to locate and pair your device. You probably have to enter a PIN number on both devices.
* Install a Bluetooth GPS on your mobile device, such as [https://play.google.com/store/apps/details?id=googoo.android.btgps Bluetooth GPS] or [https://play.google.com/store/apps/details?id=com.turboirc.bgp.v1 Bluetooth GPS Provider]. Screens comes from Bluetooth GPS software.
* Allow mock locations in your phone: Settings->Applications->Development->Allow mock locations. Note: for security reasons, you probably want to switch mock locations off while not using FlighGear.

=== Setup (every time) ===

* Switch on Bluetooth communications on your mobile device and your PC. In the Android device, switch mock locations on if they are not active (Settings->Applications->Development->Allow mock locations)
* Register the PC as a GPS provider and listen to incoming communications. From the command line (the port number can be any port not in use. In this example port 23 is used, and this is usually a safe value):

<pre>sdptool add --channel 23 SP
sudo rfcomm listen rfcomm0 23</pre>

* Establish a connection from your mobile device to your PC: open the Bluetooth GPS application in your mobile device and connect to your PC. In the console, a "connection established" message must appear. If the mobile fails with a message similar to "Service Discovery failed", try to reboot your mobile device. If the PC fails with a message similar to "not authorized", check that you are running rfcomm as root (using sudo) Check if your Bluetooh GPS application sends mock locations to the system.
* If the connection is established, check permissions in /dev/rfcomm0 Usually, members of the group dialup are allowed to write /dev/rfcomm0. If the user running FlighGear is not in the dialup group, either add the user to the group or change the permissions of /dev/rfcomm0

<pre>sudo chmod 766 /dev/rfcomm0</pre>

Note: if necessary, the group of /dev/rfcomm0 can be set using udev rules: https://bugs.launchpad.net/ubuntu/+source/udev/+bug/374782

* Run FlightGear using this option. If you run FlightGear from the [[FlightGear Launch Control|launcher FGRun]], you can set this option in the Advanced tabs, section "Input/Output" (Protocol: nmea, Medium: file, Direction: out, Hz: 5, File: /dev/rfcomm0)

<pre>--nmea=file,out,5,/dev/rfcomm0</pre>

* Open Android navigation software or any other map application supporting mock locations and enjoy.

Avia Maps

[[File:Avia maps with location simulation.jpg|250px|Avia maps screen]]

Bluetooth GPS main screen

[[File:Bluetooth gps - main screen.jpg|250px|Bluetooth GPS main screen]]

Bluetooth GPS configuration

[[File:Bluetooth gps configuration (channel).jpg|250px|Bluetooth GPS configuration]]

Bluetooth GPS channel config

[[File:Bluetooth gps channel config.jpg|250px|Bluetooth GPS channel config]]

[[Category:FIXME]]

File:Bluetooth gps - main screen.jpg

2021-01-02T22:23:09Z

Slawekmikula: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=Bluetooth GPS main screen}}
|date=2021-01-02 23:11:16
|source={{own}}
|author=[[User:Slawekmikula|Slawekmikula]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Software]]

File:Bluetooth gps configuration (channel).jpg

2021-01-02T22:23:09Z

Slawekmikula: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=Bluetooth GPS configuration}}
|date=2021-01-02 23:12:39
|source={{own}}
|author=[[User:Slawekmikula|Slawekmikula]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Software]]

File:Bluetooth gps channel config.jpg

2021-01-02T22:23:08Z

Slawekmikula: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=Bluetooth GPS channel config}}
|date=2021-01-02 23:12:43
|source={{own}}
|author=[[User:Slawekmikula|Slawekmikula]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Software]]

File:Avia maps with location simulation.jpg

2021-01-02T22:23:08Z

Slawekmikula: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=Avia maps screen}}
|date=2021-01-02 23:12:01
|source={{own}}
|author=[[User:Slawekmikula|Slawekmikula]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Software]]

Air Navigation (Software)

2021-01-02T22:15:11Z

Slawekmikula: Slawekmikula moved page Air Navigation (Software) to FlightGear as Bluetooth NMEA GPS provider: Navigation software does not exists but the recipe for connecting FG as GPS provider is OK. Will extend it later with screens.

#REDIRECT [[FlightGear as Bluetooth NMEA GPS provider]]

FlightGear as Bluetooth NMEA GPS provider

2021-01-02T22:15:11Z

'''[http://www.dixdouze.com/xample/index.php/airnavigation Air Navigation]''' is a real-time [[aircraft]] moving map navigation application for iPhone, iPad and Android by Xample. It contains free maps of the entire world as well as official IFR and VFR charts for many countries for an extra fee. It includes thousands of airports and waypoints, elevation information and features route planning and DIRECT-TO orders.

Air Navigation was developed to be used as a support instrument for general aviation in the real world. Nevertheless, it can be linked to flight simulators. As the authors say, "this is a great feature for training at home when bad weather prevents real flying! Also, simulator enthusiasts can add a full moving map system to their Sim setup."

Xample provides plug-ins to connect X-Plane and Microsoft Flight Simulator to Air Navigation. This article explains how connect [[FlightGear]] to Air Navigation Pro using Bluetooth.

== Linux on the PC, Android on the mobile device ==

This guide uses Debian Linux. Other distributions such as Ubuntu should be similar.

Note: at the end of the guide, your Android device will believe that your PC is an external GPS unit. Hence, you can use any map application of your choice. Air Navigation is especially focused on aircrafts during real trips so it is exactly the real thing, but you can also try cheaper alternatives such as [https://play.google.com/store/apps/details?id=net.osmand OSMAnd], [https://play.google.com/store/apps/details?id=com.orux.oruxmaps OruxMaps] or Google Maps/Earth.

=== Preparations (only once) ===

* Install Air Navigation on the mobile device. This guide will use Air Navigation Pro (the paid version of Air Navigation)
* Install bluez on your PC, and a suitable GUI for your window manager (bluedevil for KDE, gnome-bluetooth for Gnome)

<pre>sudo apt-get install bluez-tools bluedevil</pre>

* Switch on Bluetooth communications on your mobile device and your PC
* Pair your mobile and your PC, if they are not paired yet. In Android: Configuration->Wireless->Bluetooth settings->Make device discoverable. In your PC, use a GUI such as BlueDevil (KDE) or gnome-bluetooth (Gnome) to locate and pair your device. You probably have to enter a PIN number on both devices.
* Install a Bluetooth GPS on your mobile device, such as [https://play.google.com/store/apps/details?id=googoo.android.btgps Bluetooth GPS] or [https://play.google.com/store/apps/details?id=com.turboirc.bgp.v1 Bluetooth GPS Provider]
* Allow mock locations in your phone: Settings->Applications->Development->Allow mock locations. Note: for security reasons, you probably want to switch mock locations off while not using FlighGear.

=== Setup (every time) ===

* Switch on Bluetooth communications on your mobile device and your PC. In the Android device, switch mock locations on if they are not active (Settings->Applications->Development->Allow mock locations)
* Register the PC as a GPS provider and listen to incoming communications. From the command line (the port number can be any port not in use. In this example port 23 is used, and this is usally a safe value):

<pre>sdptool add --channel 23 SP
sudo rfcomm listen rfcomm0 23</pre>

* Establish a connection from your mobile device to your PC: open the Bluetooth GPS application in your mobile device and connect to your PC. In the console, a "connection established" message must appear. If the mobile fails with a message similar to "Service Discovery failed", try to reboot your mobile device. If the PC fails with a message similar to "not authorized", check that you are running rfcomm as root (using sudo) Check if your Bluetooh GPS application sends mock locations to the system.
* If the connection is established, check permissions in /dev/rfcomm0 Usually, members of the group dialup are allowed to write /dev/rfcomm0. If the user running FlighGear is not in the dialup group, either add the user to the group or change the permissions of /dev/rfcomm0

<pre>sudo chmod 766 /dev/rfcomm0</pre>

Note: if necessary, the group of /dev/rfcomm0 can be set using udev rules: https://bugs.launchpad.net/ubuntu/+source/udev/+bug/374782

* Run FlightGear using this option. If you run FlightGear from the [[FlightGear Launch Control|launcher FGRun]], you can set this option in the Advanced tabs, section "Input/Output" (Protocol: nmea, Medium: file, Direction: out, Hz: 5, File: /dev/rfcomm0)

<pre>--nmea=file,out,5,/dev/rfcomm0</pre>

* Open Air Navigation or any other map application supporting mock locations and enjoy.

[[Category:Software]]

Addon

2021-01-02T15:53:38Z

Slawekmikula: LittleNavMap addon from experimental to working one

[[File:Fgaddonslogo202x89.png|right]]
To make it easier to create '''addons''' there is since FlightGear 2017.3 a new way to create addons. In essence FlightGear will load an overlay XML into the property tree and start a well known Nasal function.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314620#p314620
|title = <nowiki> Re: New Feature: Addon - "API" </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

We now have a simple way to add addons to FlightGear without the need to mess around with <code>FGData/Nasal</code> or <code>FGHome/Nasal</code> directories.<ref name="Forum_announcement">{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314563#p314563
|title = <nowiki> New Feature: Addon - "API" </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 18th, 2017
}}</ref>

{{TOC limit|3}}

== Installing and using an addon ==
Download and copy the addon to a directory on your computer.

Use the command line switch <code>--addon=/path/to/some/addon</code>.<ref name="Forum_announcement"/>

== Creating an addon ==
There is a very simple Skeleton addon available in FGAddon to be used as a template.<ref name="Forum_announcement"/> See {{fgaddon source|path=Addons/Skeleton}}.

A leading slash (<code>/</code>) in this section indicates the base directory of the directory structure of the addon.

=== Minimum configuration ===
An addon may be installed in a directory anywhere on your hard disk and need at least two files:

* <code>/addon-config.xml</code> - A standard [[PropertyList XML files|PropertyList XML file]] to be used to populate or modify the [[property tree]]. (Same as to be used in <code>--config=foo.xml</code>)
* <code>/addon-main.nas</code> - The Nasal hook for the logic. This file needs a function called <code>main()</code> which will be called from the global addon initializer (<code>addons.nas</code>)

=== Additional common files ===
* <code>/addon-metadata.xml</code> - A PropertyList XML file with metadata about the addon it.
* <code>/addon-menubar-items.xml</code> - A PropertyList XML file describing menus to be added to the FlightGear menu bar.
* <code>/gui/dialogs/<my-foobar-dialog>.xml</code> - PropertyList XML files to create custom dialogs.

=== Good to know ===
The new addon mechanism lets you add a <code>addon-config.xml</code> to override the settings in <code>defaults.xml</code> and other files.

That will allow an addon to
* Override key bindings (as in the spoken ATC addon)
* Add or override autopilots and property rules
* Introduce XML state machines

Unless your really want to add/change/remove those at runtime, this should cater for most use cases.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314902#p314902
|title = <nowiki> Re: Spoken </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 23rd, 2017
|added = Jul 23rd, 2017
|script_version = 0.40
}}</ref>

We have some instructions how to use SVN [[FGAddon|in our wiki]]. It covers mostly aircraft development but the workflow is pretty much the same for addons.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314647#p314647
|title = <nowiki> Re: Spoken ATC </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

== Addon initialization ==
On initialization fgfs takes care of:
* Through {{flightgear source|path=src/Main/options.cxx|text=<code>options.cxx</code>}}:<ref name="Forum_announcement"/>
** Creating a property under <code>/addons/addon[n]/path=/path/to/some/addon</code>
** Loading <code>/path/to/some/addon/addon-config.xml</code> into the property tree (same as <code>--config=/path/to/some/addon/addon-config.xml</code>)
** Adding <code>/path/to/some/addon</code> to the list of allowed directories (same as <code>--fg-aircraft=/path/to/some/addon</code>)
* Through {{fgdata source|path=Nasal/addons.nas|text=<code>addons.nas</code>}}:
** Loading <code>/foo/bar/baz/addon-main.nas</code> into namespace <code>__addon[ADDON_ID]__</code>
** Calling <code>main(addonGhost)</code> from <code>/foo/bar/baz/addon-main.nas</code>.

== APIs ==
{{hatnote|For more details about these APIs, see the readme file, {{readme file|add-ons}}.}}
=== C++ API ===
There is a C++ API on FlightGear's side that handle some on the addon related tasks manly through the <code>AddonManager()</code>, <code>Addon()</code> and <code>AddonVersion()</code> classes.

=== Nasal API ===
The Nasal add-on API lives in the 'addons' namespace and can for example do queries to <code>AddonManager()</code> and read data from <code>addons.Addon</code> objects. It can for example compare addon versions if there is dependencies.

== Background ==
{{See also|Howto:Creating a simple modding framework}}

ATC chatter was removed in 2015, see fgdata commit: [https://sourceforge.net/p/flightgear/fgdata/ci/81607f734e13add9be02816ddaec305d05bc4e47/ 81607f734e13add9be02816ddaec305d05bc4e47]

And the devel list messages referenced in the commit log.
the other relevant commit is this: b60736ba7add2a7cd39af3d8a974d5be3ea46e8b
It would not be very difficult to restore this functionality, or even generalize/improve it significantly (which was the scope of the original discussion on the devel list)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=288388#p288388
|title = <nowiki> Re: Whatever happened to radom radio </nowiki>
|author = <nowiki> Hooray </nowiki>
|date = Jun 11th, 2016
|added = Jun 11th, 2016
|script_version = 0.40
}}</ref>

The restored functionality could be distributed as a tarball that is extracted into $FG_ROOT - alternatively, into $FG_HOME, because Nasal files there are treated as overlays, which basically means that you can install user-specific extensions there without having to tamper with $FG_ROOT, it would only take very minor changes to turn the chatter feature into a corresponding "addon" - not unlike fgcamera ...<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=288392#p288392
|title = <nowiki> Re: Whatever happened to radom radio </nowiki>
|author = <nowiki> Hooray </nowiki>
|date = Jun 11th, 2016
|added = Jun 11th, 2016
|script_version = 0.40
}}</ref>

We should absolutely stop telling anyone to edit preferences.xml in FG_ROOT; any documentation or advice which says to should be changes ASAP. <ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=192632#p192632
|title = <nowiki> Re: NavCache:init failed:Sqlite error:Sqlite API abuse </nowiki>
|author = <nowiki> zakalawe </nowiki>
|date = Oct 26th, 2013
|added = Oct 26th, 2013
|script_version = 0.40
}}</ref>

As of 12/2017, the addon API is in the process of being significantly updated <ref>https://sourceforge.net/p/flightgear/mailman/message/36146017/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36150159/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36150444/</ref>

== List of Addons ==
You can find the official repository at {{fgaddon source|path=Addons}}

* ATC Chatter (ported by Torsten) {{progressbar|100}}
* [[Cargo Towing Addon]] <ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?t=36824
|title = <nowiki> Re: Cargo Towing Addon </nowiki>
|author = <nowiki> Wayne Bragg (wlbragg) </nowiki>
|date =
|added =
|script_version = 0.40
}}</ref>
* cockpit-view (work in progress by wkitty42)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=316498#p316498
|title = <nowiki> Re: </nowiki>
|author = <nowiki> wkitty42 </nowiki>
|date = Aug 13th, 2017
|added = Aug 13th, 2017
|script_version = 0.40
}}</ref>
* [[Earthview#Customization]] - High resolution customization
* [[FaceTrackNoIR]] (ported by HHS)<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/36454826/
|title = <nowiki> Re: </nowiki>
|author = <nowiki> Unknown, HHS</nowiki>
|date = Nov 1th, 2018
}}</ref> - An addon to interface this [[Head tracking|head tracker]] with FlightGear
* [https://github.com/slawekmikula/flightgear-addon-fgcamera FGCamera] - ([https://github.com/slawekmikula/flightgear-addon-fgcamera/blob/master/Docs/manual.md manual]) - [[FGCamera | Wiki Page]]
* [[FGPlot]]
* [[Ground Services]] (ported by ThomasS)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=316400#p316400
|title = <nowiki> Re: </nowiki>
|author = <nowiki> ThomasS </nowiki>
|date = Aug 12th, 2017
|added = Aug 12th, 2017
|script_version = 0.40
}}</ref>
* [[Landing Rate addon]] [https://forum.flightgear.org/viewtopic.php?f=6&t=33101&p=327787#p327787]
* [https://gitlab.com/mdanil/flightgear-hax mdanilov hax!]: landing evaluation and aircraft development tools, TerraSync toggler
* [[Model Cockpit View]]
* [[Oscilloscope addon]] - Allows displaying a property of Nasal function over time
* [[PAR instrument]] - Precision Approach Radar and Ground Controlled Approach
* [[Red Griffin ATC]] - Speaking Air Traffic Controller<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?f=6&t=36755
|title = <nowiki> Re: </nowiki>
|author = <nowiki> RedGriffin </nowiki>
|date = Jan 6th, 2020
|added = Jan 6th, 2020
|script_version = 1.0.0 RC2
}}</ref>
* [[Spoken ATC]] (ported by Torsten)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314095#p314095
|title = <nowiki> Re: </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 10th, 2017
|added = Jul 10th, 2017
|script_version = 0.40
}}</ref>
* [[Spoken GCA]] - An offline ground controlled approach (GCA) addon
* [[YASim Development Tools]] (by jsb)
* [https://github.com/slawekmikula/flightgear-addon-vfrflight VFRFlight integration] - ([https://github.com/slawekmikula/flightgear-addon-vfrflight/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-protocolkml KML Exporter (Google Earth)] - ([https://github.com/slawekmikula/flightgear-addon-protocolkml/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-vfrnavigator VFR Flying Helper] - ([https://github.com/slawekmikula/flightgear-addon-vfrnavigator/blob/master/doc/usage.md manual])
* [https://github.com/slawekmikula/flightgear-addon-linuxtrack LinuxTrack Head Tracker integration] - ([https://github.com/slawekmikula/flightgear-addon-linuxtrack/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-hudheli Additional Heli HUD's] - ([https://github.com/slawekmikula/flightgear-addon-hudheli/blob/master/doc/manual.md manual]) - encapsulation of HeliHUD package as an addon
* [https://gitlab.com/mdanil/flightgear-mickey Tiny HUD for mouse flying in FlightGear] - Visual feedback for mouse flying, to make up for mouse's lack of self-centering
* [https://github.com/slawekmikula/flightgear-addon-littlenavmap LittleNavMap integration] - ([https://github.com/slawekmikula/flightgear-addon-littlenavmap/blob/master/doc/manual.md manual])

== Experimental Addons ==

Addons which are in the development stage/unfinished but can be used as a quick view of addon functionality
* [https://github.com/slawekmikula/flightgear-addon-missions FlightGear Missions addon] - Add-on for missions/adventures code

== Ideas ==
=== Hooking into features using legacy OpenGL code ===
{{See also|Unifying the 2D rendering backend via canvas}}
In 09/2018, James suggested that legacy features using raw OpenGL calls (e.g. HUD/2D panels) could be easily replaced via scripted Canvas/Nasal solutions at the mere cost of providing a mechanism to hook into the legacy code implementing these features (namely, the HUD/instrumentation subsystems) <ref>https://sourceforge.net/p/flightgear/mailman/message/36399261/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36399261/</ref>

=== Catalog & Package Manager support ===
if this works with more complex, pre-existing addons such as [[Bombable]], where the file layout is a replica of the old FGData layout, these types of mature addons might be better as SourceForge FlightGear sub-projects rather than being copied into FGAddon. Maybe the config file and nasal script could be used to automate the installation process ?<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35953179/
|title = <nowiki> Re: [Flightgear-devel] Simple API for creating FlightGear
addons/plugins </nowiki>
|author = <nowiki> Edward d'Auvergne </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>
The [[Bombable]] addon is one of the most popular addons out there, and a large number of aircraft in FGAddon have bombable support, so it is worth not forgetting about. Especially if the addon system one day becomes automated through a [[Catalog metadata|catalog.xml type system]]<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35953650/
|title = <nowiki> Re: [Flightgear-devel] Simple API for creating FlightGear
addons/plugins </nowiki>
|author = <nowiki> Edward d'Auvergne </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

== References ==
{{Appendix}}

== Related content ==
=== Wiki articles ===
* [[FlightGear configuration via XML]]
* [[FlightGear configuration via XML#preferences.xml]]
* [[Nasal]]
* [[Property tree]]
* [[Properties persistent between sessions]]
* [[PropertyList XML File]]

=== Forum topics ===
* {{forum link|t=32561|title=New Feature: Addon - "API"}}

=== Readme files ===
* {{readme file|add-ons}}
* {{readme file|gui}} - Details on how to add menus and custom dialogs.

=== Source code ===
==== FGAddon ====
* {{fgaddon source|path=Addons/Skeleton}} - Skeleton addon to be used as a template.

==== FGData ====
* {{fgdata source|path=Nasal/addons.nas}}

==== FlightGear ====
* {{flightgear source|path=src/Main/options.cxx}}
* {{flightgear source|path=src/Add-ons/}}

[[Category:FlightGear addons| ]]

Addon

2020-12-29T18:15:51Z

Slawekmikula: /* List of Addons */ added flightgear-mickey addon to the list

[[File:Fgaddonslogo202x89.png|right]]
To make it easier to create '''addons''' there is since FlightGear 2017.3 a new way to create addons. In essence FlightGear will load an overlay XML into the property tree and start a well known Nasal function.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314620#p314620
|title = <nowiki> Re: New Feature: Addon - "API" </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

We now have a simple way to add addons to FlightGear without the need to mess around with <code>FGData/Nasal</code> or <code>FGHome/Nasal</code> directories.<ref name="Forum_announcement">{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314563#p314563
|title = <nowiki> New Feature: Addon - "API" </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 18th, 2017
}}</ref>

{{TOC limit|3}}

== Installing and using an addon ==
Download and copy the addon to a directory on your computer.

Use the command line switch <code>--addon=/path/to/some/addon</code>.<ref name="Forum_announcement"/>

== Creating an addon ==
There is a very simple Skeleton addon available in FGAddon to be used as a template.<ref name="Forum_announcement"/> See {{fgaddon source|path=Addons/Skeleton}}.

A leading slash (<code>/</code>) in this section indicates the base directory of the directory structure of the addon.

=== Minimum configuration ===
An addon may be installed in a directory anywhere on your hard disk and need at least two files:

* <code>/addon-config.xml</code> - A standard [[PropertyList XML files|PropertyList XML file]] to be used to populate or modify the [[property tree]]. (Same as to be used in <code>--config=foo.xml</code>)
* <code>/addon-main.nas</code> - The Nasal hook for the logic. This file needs a function called <code>main()</code> which will be called from the global addon initializer (<code>addons.nas</code>)

=== Additional common files ===
* <code>/addon-metadata.xml</code> - A PropertyList XML file with metadata about the addon it.
* <code>/addon-menubar-items.xml</code> - A PropertyList XML file describing menus to be added to the FlightGear menu bar.
* <code>/gui/dialogs/<my-foobar-dialog>.xml</code> - PropertyList XML files to create custom dialogs.

=== Good to know ===
The new addon mechanism lets you add a <code>addon-config.xml</code> to override the settings in <code>defaults.xml</code> and other files.

That will allow an addon to
* Override key bindings (as in the spoken ATC addon)
* Add or override autopilots and property rules
* Introduce XML state machines

Unless your really want to add/change/remove those at runtime, this should cater for most use cases.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314902#p314902
|title = <nowiki> Re: Spoken </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 23rd, 2017
|added = Jul 23rd, 2017
|script_version = 0.40
}}</ref>

We have some instructions how to use SVN [[FGAddon|in our wiki]]. It covers mostly aircraft development but the workflow is pretty much the same for addons.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314647#p314647
|title = <nowiki> Re: Spoken ATC </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

== Addon initialization ==
On initialization fgfs takes care of:
* Through {{flightgear source|path=src/Main/options.cxx|text=<code>options.cxx</code>}}:<ref name="Forum_announcement"/>
** Creating a property under <code>/addons/addon[n]/path=/path/to/some/addon</code>
** Loading <code>/path/to/some/addon/addon-config.xml</code> into the property tree (same as <code>--config=/path/to/some/addon/addon-config.xml</code>)
** Adding <code>/path/to/some/addon</code> to the list of allowed directories (same as <code>--fg-aircraft=/path/to/some/addon</code>)
* Through {{fgdata source|path=Nasal/addons.nas|text=<code>addons.nas</code>}}:
** Loading <code>/foo/bar/baz/addon-main.nas</code> into namespace <code>__addon[ADDON_ID]__</code>
** Calling <code>main(addonGhost)</code> from <code>/foo/bar/baz/addon-main.nas</code>.

== APIs ==
{{hatnote|For more details about these APIs, see the readme file, {{readme file|add-ons}}.}}
=== C++ API ===
There is a C++ API on FlightGear's side that handle some on the addon related tasks manly through the <code>AddonManager()</code>, <code>Addon()</code> and <code>AddonVersion()</code> classes.

=== Nasal API ===
The Nasal add-on API lives in the 'addons' namespace and can for example do queries to <code>AddonManager()</code> and read data from <code>addons.Addon</code> objects. It can for example compare addon versions if there is dependencies.

== Background ==
{{See also|Howto:Creating a simple modding framework}}

ATC chatter was removed in 2015, see fgdata commit: [https://sourceforge.net/p/flightgear/fgdata/ci/81607f734e13add9be02816ddaec305d05bc4e47/ 81607f734e13add9be02816ddaec305d05bc4e47]

And the devel list messages referenced in the commit log.
the other relevant commit is this: b60736ba7add2a7cd39af3d8a974d5be3ea46e8b
It would not be very difficult to restore this functionality, or even generalize/improve it significantly (which was the scope of the original discussion on the devel list)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=288388#p288388
|title = <nowiki> Re: Whatever happened to radom radio </nowiki>
|author = <nowiki> Hooray </nowiki>
|date = Jun 11th, 2016
|added = Jun 11th, 2016
|script_version = 0.40
}}</ref>

The restored functionality could be distributed as a tarball that is extracted into $FG_ROOT - alternatively, into $FG_HOME, because Nasal files there are treated as overlays, which basically means that you can install user-specific extensions there without having to tamper with $FG_ROOT, it would only take very minor changes to turn the chatter feature into a corresponding "addon" - not unlike fgcamera ...<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=288392#p288392
|title = <nowiki> Re: Whatever happened to radom radio </nowiki>
|author = <nowiki> Hooray </nowiki>
|date = Jun 11th, 2016
|added = Jun 11th, 2016
|script_version = 0.40
}}</ref>

We should absolutely stop telling anyone to edit preferences.xml in FG_ROOT; any documentation or advice which says to should be changes ASAP. <ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=192632#p192632
|title = <nowiki> Re: NavCache:init failed:Sqlite error:Sqlite API abuse </nowiki>
|author = <nowiki> zakalawe </nowiki>
|date = Oct 26th, 2013
|added = Oct 26th, 2013
|script_version = 0.40
}}</ref>

As of 12/2017, the addon API is in the process of being significantly updated <ref>https://sourceforge.net/p/flightgear/mailman/message/36146017/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36150159/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36150444/</ref>

== List of Addons ==
You can find the official repository at {{fgaddon source|path=Addons}}

* ATC Chatter (ported by Torsten) {{progressbar|100}}
* [[Cargo Towing Addon]] <ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?t=36824
|title = <nowiki> Re: Cargo Towing Addon </nowiki>
|author = <nowiki> Wayne Bragg (wlbragg) </nowiki>
|date =
|added =
|script_version = 0.40
}}</ref>
* cockpit-view (work in progress by wkitty42)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=316498#p316498
|title = <nowiki> Re: </nowiki>
|author = <nowiki> wkitty42 </nowiki>
|date = Aug 13th, 2017
|added = Aug 13th, 2017
|script_version = 0.40
}}</ref>
* [[Earthview#Customization]] - High resolution customization
* [[FaceTrackNoIR]] (ported by HHS)<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/36454826/
|title = <nowiki> Re: </nowiki>
|author = <nowiki> Unknown, HHS</nowiki>
|date = Nov 1th, 2018
}}</ref> - An addon to interface this [[Head tracking|head tracker]] with FlightGear
* [https://github.com/slawekmikula/flightgear-addon-fgcamera FGCamera] - ([https://github.com/slawekmikula/flightgear-addon-fgcamera/blob/master/Docs/manual.md manual]) - [[FGCamera | Wiki Page]]
* [[FGPlot]]
* [[Ground Services]] (ported by ThomasS)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=316400#p316400
|title = <nowiki> Re: </nowiki>
|author = <nowiki> ThomasS </nowiki>
|date = Aug 12th, 2017
|added = Aug 12th, 2017
|script_version = 0.40
}}</ref>
* [[Landing Rate addon]] [https://forum.flightgear.org/viewtopic.php?f=6&t=33101&p=327787#p327787]
* [https://gitlab.com/mdanil/flightgear-hax mdanilov hax!]: landing evaluation and aircraft development tools, TerraSync toggler
* [[Model Cockpit View]]
* [[Oscilloscope addon]] - Allows displaying a property of Nasal function over time
* [[PAR instrument]] - Precision Approach Radar and Ground Controlled Approach
* [[Red Griffin ATC]] - Speaking Air Traffic Controller<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?f=6&t=36755
|title = <nowiki> Re: </nowiki>
|author = <nowiki> RedGriffin </nowiki>
|date = Jan 6th, 2020
|added = Jan 6th, 2020
|script_version = 1.0.0 RC2
}}</ref>
* [[Spoken ATC]] (ported by Torsten)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314095#p314095
|title = <nowiki> Re: </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 10th, 2017
|added = Jul 10th, 2017
|script_version = 0.40
}}</ref>
* [[Spoken GCA]] - An offline ground controlled approach (GCA) addon
* [[YASim Development Tools]] (by jsb)
* [https://github.com/slawekmikula/flightgear-addon-vfrflight VFRFlight integration] - ([https://github.com/slawekmikula/flightgear-addon-vfrflight/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-protocolkml KML Exporter (Google Earth)] - ([https://github.com/slawekmikula/flightgear-addon-protocolkml/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-vfrnavigator VFR Flying Helper] - ([https://github.com/slawekmikula/flightgear-addon-vfrnavigator/blob/master/doc/usage.md manual])
* [https://github.com/slawekmikula/flightgear-addon-linuxtrack LinuxTrack Head Tracker integration] - ([https://github.com/slawekmikula/flightgear-addon-linuxtrack/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-hudheli Additional Heli HUD's] - ([https://github.com/slawekmikula/flightgear-addon-hudheli/blob/master/doc/manual.md manual]) - encapsulation of HeliHUD package as an addon
* [https://gitlab.com/mdanil/flightgear-mickey Tiny HUD for mouse flying in FlightGear] - Visual feedback for mouse flying, to make up for mouse's lack of self-centering

== Experimental Addons ==

Addons which are in the development stage/unfinished but can be used as a quick view of addon functionality

* [https://github.com/slawekmikula/flightgear-addon-littlenavmap LittleNavMap integration] - ([https://github.com/slawekmikula/flightgear-addon-littlenavmap/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-missions FlightGear Missions addon] - Add-on for missions/adventures code

== Ideas ==
=== Hooking into features using legacy OpenGL code ===
{{See also|Unifying the 2D rendering backend via canvas}}
In 09/2018, James suggested that legacy features using raw OpenGL calls (e.g. HUD/2D panels) could be easily replaced via scripted Canvas/Nasal solutions at the mere cost of providing a mechanism to hook into the legacy code implementing these features (namely, the HUD/instrumentation subsystems) <ref>https://sourceforge.net/p/flightgear/mailman/message/36399261/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36399261/</ref>

=== Catalog & Package Manager support ===
if this works with more complex, pre-existing addons such as [[Bombable]], where the file layout is a replica of the old FGData layout, these types of mature addons might be better as SourceForge FlightGear sub-projects rather than being copied into FGAddon. Maybe the config file and nasal script could be used to automate the installation process ?<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35953179/
|title = <nowiki> Re: [Flightgear-devel] Simple API for creating FlightGear
addons/plugins </nowiki>
|author = <nowiki> Edward d'Auvergne </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>
The [[Bombable]] addon is one of the most popular addons out there, and a large number of aircraft in FGAddon have bombable support, so it is worth not forgetting about. Especially if the addon system one day becomes automated through a [[Catalog metadata|catalog.xml type system]]<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35953650/
|title = <nowiki> Re: [Flightgear-devel] Simple API for creating FlightGear
addons/plugins </nowiki>
|author = <nowiki> Edward d'Auvergne </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

== References ==
{{Appendix}}

== Related content ==
=== Wiki articles ===
* [[FlightGear configuration via XML]]
* [[FlightGear configuration via XML#preferences.xml]]
* [[Nasal]]
* [[Property tree]]
* [[Properties persistent between sessions]]
* [[PropertyList XML File]]

=== Forum topics ===
* {{forum link|t=32561|title=New Feature: Addon - "API"}}

=== Readme files ===
* {{readme file|add-ons}}
* {{readme file|gui}} - Details on how to add menus and custom dialogs.

=== Source code ===
==== FGAddon ====
* {{fgaddon source|path=Addons/Skeleton}} - Skeleton addon to be used as a template.

==== FGData ====
* {{fgdata source|path=Nasal/addons.nas}}

==== FlightGear ====
* {{flightgear source|path=src/Main/options.cxx}}
* {{flightgear source|path=src/Add-ons/}}

[[Category:FlightGear addons| ]]

Addon

2020-12-28T00:07:41Z

Slawekmikula: /* List of Addons */ updated information about FGCamera addon (current link, manual link and preserve FGCamera Wiki page)

[[File:Fgaddonslogo202x89.png|right]]
To make it easier to create '''addons''' there is since FlightGear 2017.3 a new way to create addons. In essence FlightGear will load an overlay XML into the property tree and start a well known Nasal function.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314620#p314620
|title = <nowiki> Re: New Feature: Addon - "API" </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

We now have a simple way to add addons to FlightGear without the need to mess around with <code>FGData/Nasal</code> or <code>FGHome/Nasal</code> directories.<ref name="Forum_announcement">{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314563#p314563
|title = <nowiki> New Feature: Addon - "API" </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 18th, 2017
}}</ref>

{{TOC limit|3}}

== Installing and using an addon ==
Download and copy the addon to a directory on your computer.

Use the command line switch <code>--addon=/path/to/some/addon</code>.<ref name="Forum_announcement"/>

== Creating an addon ==
There is a very simple Skeleton addon available in FGAddon to be used as a template.<ref name="Forum_announcement"/> See {{fgaddon source|path=Addons/Skeleton}}.

A leading slash (<code>/</code>) in this section indicates the base directory of the directory structure of the addon.

=== Minimum configuration ===
An addon may be installed in a directory anywhere on your hard disk and need at least two files:

* <code>/addon-config.xml</code> - A standard [[PropertyList XML files|PropertyList XML file]] to be used to populate or modify the [[property tree]]. (Same as to be used in <code>--config=foo.xml</code>)
* <code>/addon-main.nas</code> - The Nasal hook for the logic. This file needs a function called <code>main()</code> which will be called from the global addon initializer (<code>addons.nas</code>)

=== Additional common files ===
* <code>/addon-metadata.xml</code> - A PropertyList XML file with metadata about the addon it.
* <code>/addon-menubar-items.xml</code> - A PropertyList XML file describing menus to be added to the FlightGear menu bar.
* <code>/gui/dialogs/<my-foobar-dialog>.xml</code> - PropertyList XML files to create custom dialogs.

=== Good to know ===
The new addon mechanism lets you add a <code>addon-config.xml</code> to override the settings in <code>defaults.xml</code> and other files.

That will allow an addon to
* Override key bindings (as in the spoken ATC addon)
* Add or override autopilots and property rules
* Introduce XML state machines

Unless your really want to add/change/remove those at runtime, this should cater for most use cases.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314902#p314902
|title = <nowiki> Re: Spoken </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 23rd, 2017
|added = Jul 23rd, 2017
|script_version = 0.40
}}</ref>

We have some instructions how to use SVN [[FGAddon|in our wiki]]. It covers mostly aircraft development but the workflow is pretty much the same for addons.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314647#p314647
|title = <nowiki> Re: Spoken ATC </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

== Addon initialization ==
On initialization fgfs takes care of:
* Through {{flightgear source|path=src/Main/options.cxx|text=<code>options.cxx</code>}}:<ref name="Forum_announcement"/>
** Creating a property under <code>/addons/addon[n]/path=/path/to/some/addon</code>
** Loading <code>/path/to/some/addon/addon-config.xml</code> into the property tree (same as <code>--config=/path/to/some/addon/addon-config.xml</code>)
** Adding <code>/path/to/some/addon</code> to the list of allowed directories (same as <code>--fg-aircraft=/path/to/some/addon</code>)
* Through {{fgdata source|path=Nasal/addons.nas|text=<code>addons.nas</code>}}:
** Loading <code>/foo/bar/baz/addon-main.nas</code> into namespace <code>__addon[ADDON_ID]__</code>
** Calling <code>main(addonGhost)</code> from <code>/foo/bar/baz/addon-main.nas</code>.

== APIs ==
{{hatnote|For more details about these APIs, see the readme file, {{readme file|add-ons}}.}}
=== C++ API ===
There is a C++ API on FlightGear's side that handle some on the addon related tasks manly through the <code>AddonManager()</code>, <code>Addon()</code> and <code>AddonVersion()</code> classes.

=== Nasal API ===
The Nasal add-on API lives in the 'addons' namespace and can for example do queries to <code>AddonManager()</code> and read data from <code>addons.Addon</code> objects. It can for example compare addon versions if there is dependencies.

== Background ==
{{See also|Howto:Creating a simple modding framework}}

ATC chatter was removed in 2015, see fgdata commit: [https://sourceforge.net/p/flightgear/fgdata/ci/81607f734e13add9be02816ddaec305d05bc4e47/ 81607f734e13add9be02816ddaec305d05bc4e47]

And the devel list messages referenced in the commit log.
the other relevant commit is this: b60736ba7add2a7cd39af3d8a974d5be3ea46e8b
It would not be very difficult to restore this functionality, or even generalize/improve it significantly (which was the scope of the original discussion on the devel list)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=288388#p288388
|title = <nowiki> Re: Whatever happened to radom radio </nowiki>
|author = <nowiki> Hooray </nowiki>
|date = Jun 11th, 2016
|added = Jun 11th, 2016
|script_version = 0.40
}}</ref>

The restored functionality could be distributed as a tarball that is extracted into $FG_ROOT - alternatively, into $FG_HOME, because Nasal files there are treated as overlays, which basically means that you can install user-specific extensions there without having to tamper with $FG_ROOT, it would only take very minor changes to turn the chatter feature into a corresponding "addon" - not unlike fgcamera ...<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=288392#p288392
|title = <nowiki> Re: Whatever happened to radom radio </nowiki>
|author = <nowiki> Hooray </nowiki>
|date = Jun 11th, 2016
|added = Jun 11th, 2016
|script_version = 0.40
}}</ref>

We should absolutely stop telling anyone to edit preferences.xml in FG_ROOT; any documentation or advice which says to should be changes ASAP. <ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=192632#p192632
|title = <nowiki> Re: NavCache:init failed:Sqlite error:Sqlite API abuse </nowiki>
|author = <nowiki> zakalawe </nowiki>
|date = Oct 26th, 2013
|added = Oct 26th, 2013
|script_version = 0.40
}}</ref>

As of 12/2017, the addon API is in the process of being significantly updated <ref>https://sourceforge.net/p/flightgear/mailman/message/36146017/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36150159/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36150444/</ref>

== List of Addons ==
You can find the official repository at {{fgaddon source|path=Addons}}

* ATC Chatter (ported by Torsten) {{progressbar|100}}
* [[Cargo Towing Addon]] <ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?t=36824
|title = <nowiki> Re: Cargo Towing Addon </nowiki>
|author = <nowiki> Wayne Bragg (wlbragg) </nowiki>
|date =
|added =
|script_version = 0.40
}}</ref>
* cockpit-view (work in progress by wkitty42)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=316498#p316498
|title = <nowiki> Re: </nowiki>
|author = <nowiki> wkitty42 </nowiki>
|date = Aug 13th, 2017
|added = Aug 13th, 2017
|script_version = 0.40
}}</ref>
* [[Earthview#Customization]] - High resolution customization
* [[FaceTrackNoIR]] (ported by HHS)<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/36454826/
|title = <nowiki> Re: </nowiki>
|author = <nowiki> Unknown, HHS</nowiki>
|date = Nov 1th, 2018
}}</ref> - An addon to interface this [[Head tracking|head tracker]] with FlightGear
* [https://github.com/slawekmikula/flightgear-addon-fgcamera FGCamera] - ([https://github.com/slawekmikula/flightgear-addon-fgcamera/blob/master/Docs/manual.md manual]) - [[FGCamera | Wiki Page]]
* [[FGPlot]]
* [[Ground Services]] (ported by ThomasS)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=316400#p316400
|title = <nowiki> Re: </nowiki>
|author = <nowiki> ThomasS </nowiki>
|date = Aug 12th, 2017
|added = Aug 12th, 2017
|script_version = 0.40
}}</ref>
* [[Landing Rate addon]] [https://forum.flightgear.org/viewtopic.php?f=6&t=33101&p=327787#p327787]
* [https://gitlab.com/mdanil/flightgear-hax mdanilov hax!]: landing evaluation and aircraft development tools, TerraSync toggler
* [[Model Cockpit View]]
* [[Oscilloscope addon]] - Allows displaying a property of Nasal function over time
* [[PAR instrument]] - Precision Approach Radar and Ground Controlled Approach
* [[Red Griffin ATC]] - Speaking Air Traffic Controller<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?f=6&t=36755
|title = <nowiki> Re: </nowiki>
|author = <nowiki> RedGriffin </nowiki>
|date = Jan 6th, 2020
|added = Jan 6th, 2020
|script_version = 1.0.0 RC2
}}</ref>
* [[Spoken ATC]] (ported by Torsten)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314095#p314095
|title = <nowiki> Re: </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 10th, 2017
|added = Jul 10th, 2017
|script_version = 0.40
}}</ref>
* [[Spoken GCA]] - An offline ground controlled approach (GCA) addon
* [[YASim Development Tools]] (by jsb)
* [https://github.com/slawekmikula/flightgear-addon-vfrflight VFRFlight integration] - ([https://github.com/slawekmikula/flightgear-addon-vfrflight/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-protocolkml KML Exporter (Google Earth)] - ([https://github.com/slawekmikula/flightgear-addon-protocolkml/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-vfrnavigator VFR Flying Helper] - ([https://github.com/slawekmikula/flightgear-addon-vfrnavigator/blob/master/doc/usage.md manual])
* [https://github.com/slawekmikula/flightgear-addon-linuxtrack LinuxTrack Head Tracker integration] - ([https://github.com/slawekmikula/flightgear-addon-linuxtrack/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-hudheli Additional Heli HUD's] - ([https://github.com/slawekmikula/flightgear-addon-hudheli/blob/master/doc/manual.md manual])

== Experimental Addons ==

Addons which are in the development stage/unfinished but can be used as a quick view of addon functionality

* [https://github.com/slawekmikula/flightgear-addon-littlenavmap LittleNavMap integration] - ([https://github.com/slawekmikula/flightgear-addon-littlenavmap/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-missions FlightGear Missions addon] - Add-on for missions/adventures code

== Ideas ==
=== Hooking into features using legacy OpenGL code ===
{{See also|Unifying the 2D rendering backend via canvas}}
In 09/2018, James suggested that legacy features using raw OpenGL calls (e.g. HUD/2D panels) could be easily replaced via scripted Canvas/Nasal solutions at the mere cost of providing a mechanism to hook into the legacy code implementing these features (namely, the HUD/instrumentation subsystems) <ref>https://sourceforge.net/p/flightgear/mailman/message/36399261/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36399261/</ref>

=== Catalog & Package Manager support ===
if this works with more complex, pre-existing addons such as [[Bombable]], where the file layout is a replica of the old FGData layout, these types of mature addons might be better as SourceForge FlightGear sub-projects rather than being copied into FGAddon. Maybe the config file and nasal script could be used to automate the installation process ?<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35953179/
|title = <nowiki> Re: [Flightgear-devel] Simple API for creating FlightGear
addons/plugins </nowiki>
|author = <nowiki> Edward d'Auvergne </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>
The [[Bombable]] addon is one of the most popular addons out there, and a large number of aircraft in FGAddon have bombable support, so it is worth not forgetting about. Especially if the addon system one day becomes automated through a [[Catalog metadata|catalog.xml type system]]<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35953650/
|title = <nowiki> Re: [Flightgear-devel] Simple API for creating FlightGear
addons/plugins </nowiki>
|author = <nowiki> Edward d'Auvergne </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

== References ==
{{Appendix}}

== Related content ==
=== Wiki articles ===
* [[FlightGear configuration via XML]]
* [[FlightGear configuration via XML#preferences.xml]]
* [[Nasal]]
* [[Property tree]]
* [[Properties persistent between sessions]]
* [[PropertyList XML File]]

=== Forum topics ===
* {{forum link|t=32561|title=New Feature: Addon - "API"}}

=== Readme files ===
* {{readme file|add-ons}}
* {{readme file|gui}} - Details on how to add menus and custom dialogs.

=== Source code ===
==== FGAddon ====
* {{fgaddon source|path=Addons/Skeleton}} - Skeleton addon to be used as a template.

==== FGData ====
* {{fgdata source|path=Nasal/addons.nas}}

==== FlightGear ====
* {{flightgear source|path=src/Main/options.cxx}}
* {{flightgear source|path=src/Add-ons/}}

[[Category:FlightGear addons| ]]

Building FlightGear

2020-12-27T22:55:48Z

Slawekmikula: explicit info about IDE integration

The [[FlightGear]] developers generally release a stable packaged version of FlightGear, with an easy install wizard, about once or twice a year. For convenience, most FlightGear users download and install these packages.

However, the source files used to '''build the whole FlightGear package''' are continuously being developed by dozens of contributors, who collaborate using the source code management system [[Git]] to create a new "unstable" version every few days. If you want to use one of these unstable versions, or tinker with the source files to create your own custom version, the pages below describe how to compile the FlightGear package from the Git source files (repository at [http://sourceforge.net/projects/flightgear http://sourceforge.net]).

If you'd like to use an integrated development environment, illustrated instructions for building FlightGear and its dependencies can be found in [[Howto:Build FlightGear with NetBeans using CMake]], this should work on both, Windows and Linux systems (NetBeans being a cross-platform IDE).

Another option to run the latest code without having to compile everything yourself, is using a precompiled binary provided by the [[FlightGear Build Server]] which is based on Jenkins.

'''Building FlightGear''' may refer to:
* [[Superbuild|Using CMake Superbuilds]]
* [[Superbuild on Windows|Using CMake Superbuild - Windows]]
* [[Building using CMake]]
* [[Building using CMake - Windows]]
* [[Building FlightGear - Linux]]
* [[Scripted Compilation on Linux Debian/Ubuntu|Building on Linux using the download_and_compile.sh bash script]]

'''IDE Integration''' may refer to:
* [[Howto:Build FlightGear with NetBeans using CMake | Build FlightGear with NetBeans using CMake and Run/Debug inside IDE]]

'''Old pages''' :
* [http://macflightgear.sourceforge.net/home/documents/how-to-build-flightgear-cvs-on-mac-os-x/ Building FlightGear - Mac OS X]
* [[Updating FlightGear on Windows]] - get a recently updated version without compiling

{{Building}}

Howto:Build FlightGear with NetBeans using CMake

2020-12-27T22:53:36Z

Slawekmikula: Finishing modification of IDE debug/run example using NetBeans

== Important ==

The latest CMake-specific build instructions can be found in $FG_SRC/README.cmake: {{Flightgear file|README.cmake}}. If you encounter any CMake-related bugs while trying to build SimGear and/or FlightGear, please consider filing a bug report here: {{Tickets}}. If you think the instructions are lacking some details, you are invited to add them as required. Also, if you think that some more specific screen shots would help, please do feel free to upload new screen shots here: [[Special:UploadWizard]]. Don't worry if you don't know how to embed these images, you can simply leave a comment on the article's talk page, so that we can update the article accordingly. Thanks!

== Download and install NetBeans ==

NetBeans is a multi-platform IDE (integrated development environment) that supports a number of programming languages, C and C++ among them. NetBeans is a highly modular and very powerful IDE with a huge range of features. Go to https://netbeans.apache.org/ in order to download the latest version of NetBeans for your OS/platform. After downloading NetBeans, you'll need to install it.

{{Note| According to the latest release notes [https://netbeans.apache.org/download/nb120/index.html#_c_c release notes 12.0] the C++ plugin is not ported to the new Apache infrastructure. You have to enable Netbeans 8.2 plugin center and install C/C++ plugin from it. It will be available in the future releases in the NetBeans core.}}

== Linux: getting & compiling ==

Please take a look at generic page: [[Building_FlightGear]] or [[Scripted Compilation on Linux Debian/Ubuntu|Building on Linux using the download_and_compile.sh bash script]]

== Windows: getting & compiling ==

Please take a look at the generic page regarding Windows compilation: [[Building using CMake - Windows]]

== Folder Structure ==

You need separate folders in which the project build outputs will be created. If you download and create folders according to the build environment in Windows/Linux OS there is nothing new.

== Netbeans project import ==

After checking out the repository, you'll want to use the NetBeans project wizard to CREATE A NEW PROJECT FROM EXISTING SOURCES for each dependency:

[[File:NetBeans New Project.png]]

Next, pick "...from existing sources":

[[File:NetBeans New Project Existing.png]]

Specify the folder where the checked out sources can be found:

[[File:NetBeans New Project Automatic.png]]

Click Finish. NetBeans will attempt to build the project, which will fail, as no dependencies have been set. Ignore it, the project will still be set-up. Repeat above steps for the simgear code. Finally, you should see all projects neatly structured in NetBeans:

[[File:Netbeans-projects.png|NetBeans project listing]]

== Disable code indexing ==

By default, NetBeans will keep on trying and index all your sources, this may slow down the IDE considerably, so it's a good idea to disable this feature if you don't need it (CONTEXT MENU/RIGHT CLICK on project, go to CODE ASSISTANCE and then uncheck the marked entry):

[[File:NetBeans Code Assistance.png]]

== Debugging using Gdb/Netbeans as a IDE ==

Examplary configuration for easy debugging FlightGear source code inside IDE using GDB as a backend can be configured in various ways. This screens shows how to configure two projects 'simgear' and 'flightgear' to compile with the debug flags inside the IDE and be able to execute it or debug directly inside IDE. This is a great way to extend FlightGear and help fixing bugs for people not very experienced with the GDB commandline interface. It has all features of the debug inside IDE as graphical watches, breakpoints etc.

{{Note| Following settings are set according to one user directory structure and his compile/debug options. Please refer to the latest compile/debug options in SimGear/FlightGear in order to set them correctly. }}

In order to configure it, this settings has to be set in one user environment in order to successfully compile it and debug.

* Simgear

SimGear source configuration

[[File:Netbeans-simgear src.png|NetBeans config - simgear source configuration]]

Simgear prebuild (CMAKE) options

[[File:Netbeans-simgear prebuild.png|NetBeans config - simgear prebuild (CMAKE) options]]

Simgear build options

[[File:Netbeans-simgear build.png|NetBeans config - simgear build options]]

Simgear compile options

[[File:Netbeans-simgear compile.png|NetBeans config - simgear compile options]]

Simgear make options

[[File:Netbeans-simgear make.png|NetBeans config - simgear make options]]

* FlightGear

FlightGear source configuration

[[File:Netbeans-fg config src.png|NetBeans config - flightgear source configuration]]

FlightGear prebuild (CMAKE) options

[[File:Netbeans-fg config prebuild.png|NetBeans config - flightgear prebuild (CMAKE) options]]

FlightGear build options

[[File:Netbeans-fg config build.png|NetBeans config - flightgear build options ]]

FlightGear make options

[[File:Netbeans-fg config make.png|NetBeans config - flightgear make options]]

FlightGear compile options

[[File:Netbeans-fg config compile.png|NetBeans config - flightgear compile options ]]

And setting regarding debug and run sessions:

FlightGear debug options

[[File:Netbeans-fg config debug.png|NetBeans config - flightgear debug options]]

FlightGear run options

[[File:Netbeans-fg config run.png|NetBeans config - flightgear run options]]

After this settings one can run/debug FlightGear source code inside the IDE :)

[[Category:Howto|Build FlightGear with NetBeans using CMake]]
[[Category:Development|Build FlightGear with NetBeans using CMake]]

File:Netbeans-simgear src.png

2020-12-27T22:38:44Z

Slawekmikula: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=NetBeans config screen}}
|date=2020-12-27
|source={{own}}
|author=[[User:Slawekmikula|Slawekmikula]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:IDE]]

File:Netbeans-simgear prebuild.png

2020-12-27T22:38:44Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-simgear make.png

2020-12-27T22:38:44Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-simgear compile.png

2020-12-27T22:38:44Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-simgear build.png

2020-12-27T22:38:44Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-projects.png

2020-12-27T22:38:44Z

Slawekmikula: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=NetBeans project listing}}
|date=2020-12-27
|source={{own}}
|author=[[User:Slawekmikula|Slawekmikula]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:IDE]]

File:Netbeans-fg config src.png

2020-12-27T22:38:44Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-fg config run.png

2020-12-27T22:38:43Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-fg config prebuild.png

2020-12-27T22:38:43Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-fg config debug.png

2020-12-27T22:38:43Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-fg config make.png

2020-12-27T22:38:43Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-fg config compile.png

2020-12-27T22:38:43Z

Slawekmikula: User created page with UploadWizard

File:Netbeans-fg config build.png

2020-12-27T22:38:42Z

Slawekmikula: User created page with UploadWizard

Howto:Build FlightGear with NetBeans using CMake

2020-12-27T22:35:53Z

Slawekmikula: start changing NetBeans building/editing page

Head tracking

2020-12-27T16:29:37Z

Slawekmikula: /* Wiki articles */ added linuxtrack addon reference

'''Head tracking''' allows a user to use the movement of their head to control the direction of their view in a hands-free manner within FlightGear. Instead of directly implementing support for head tracking protocols and devices, FlightGear instead exposes an [[Interfacing FlightGear|interface]] to recieve input data from an arbitrary source, which head tracking software can then utilize.

== Degrees of freedom ==
Degrees of freedom (DoF) are very common measure of the capability of a head tracking solution. It is the number of axis the view can be rotated or translated around or along.

For example would simple horizontal panning be 1 DoF (in essence rotation around the Z axis), while all translations and rotations would be 6 DoF (rotation around x, y and z + translation along x, y and z).

== Screen view vs. VR view panning ==
While you obviously would like a VR goggle view to precisely follow your head movements, you can not do that if you want to have the view on a screen in front of you. To be able to still see the screen when you are panning the view to directly behind, the translations usually are scaled down when head tracking is used for panning the view on a screen.

While one or two DoF may be satisfactory when you are using head tracking to pan a screen view, three or sometimes six DoF is usually wanted when using VR goggles. Having six DoF with goggles usually requires requires external head tracking to capture the head movements as accelerometers are too noisy and will drift.

== Head tracking solutions ==
There are many ways to do head tracking. The solutions cheapest to implement will use your web camera and will follow your face or some markers to figure out where your head is and how it is rotated.

The more expensive ones use IR cameras, either using a group of LED light markers or IR lights at the camera and reflective markers. The last method is used by some of the more popular commercial products. Often there is three or four markers grouped together with fixed relative positions that is attached to headwear or headphones.

== Using head tracking in FlightGear ==
As FlightGear is very flexible there are many ways head tracking can be implemented. Often some external head tracking software will [[Interfacing FlightGear|interface with FlightGear]] for example using a [[generic protocol]] such that the rotations and translations is read into [[Property tree|properties]] that in turn are used for panning and moving the view.

== Related content ==
=== Wiki articles ===
* [[FaceTrackNoIR]]
* [[Input device]]
* [[Interfacing FlightGear]]
* [[opentrack]]
* [[Howto:Wii Remote Head Tracking]]
* [[Addon#List_of_Addons]] - LinuxTrack addon for head tracking

=== Forum topics ===
* {{forum link|t=37904|title=Opentrack}} (August 2020)
* {{forum link|t=29560|title=Setting up my flight gear?}} (May 2016)
* {{forum link|t=28718|title=How-to: motion tracking controller using vJoy and FreePIE}} (February 2016)
* {{forum link|t=31757|title=TrackIR, EDTracker, vJoy, FreePIE, OpenTrack - headtracking}} (February 2017-August 2020)
* {{forum link|t=10664|title=Headtrack}} (January 2011–January 2017)
* {{forum link|t=19848|title=FaceTracking: which views are movable ?}} (May–June 2013)
* {{forum link|t=16052|title=Offset problem with infra-red headtracker}} (April 2012)
* {{forum link|t=12412|title=Something for your sim pit? (Eye-following projector)}} (June 2011)
* {{forum link|t=11345|title=linux-track and FlightGear}} (March 2011–March 2014)
* {{forum link|t=11296|title=Typhoon+Grand Canyon+FaceTrackNoIR=AwEsOmE}} (March 2011)
* {{forum link|t=8499|title=First update FaceTrackNoIR}} (June 2010–March 2011)
* {{forum link|t=4763|title=Anything new related to FreeTrack/TrackIR?}} (April 2009–July 2010)
* {{forum link|t=212|title=Integration with OpenCV}} (February 2007)

=== Developer mailing list threads ===
* [https://sourceforge.net/p/flightgear/mailman/message/34768232/ <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> SteamVR ] (January 2016)
* [https://sourceforge.net/p/flightgear/mailman/message/30602798/ <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> Kinect for pc for head tracking?] (March 2013)
* [https://sourceforge.net/p/flightgear/mailman/message/27944122/ <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> FG Input though socket or anyway? ] (August 2011)
* [https://sourceforge.net/p/flightgear/mailman/message/25067844/ <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> Enable headtracking in FlightGear?] (April 2010)
* [https://sourceforge.net/p/flightgear/mailman/flightgear-devel/thread/20080131170535.58250%40gmx.net/#msg18464396 <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> Depth percepted cockpit] (January–February 2008)
* [https://sourceforge.net/p/flightgear/mailman/message/15602328/ <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> Extending generic protocol for binary input streams.] (September 2007–March 2009)
* [https://sourceforge.net/p/flightgear/mailman/flightgear-devel/thread/76d708440605102214i67cc8305sf6abbb28b8418223%40mail.gmail.com/#msg13176413 <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> Formation Flying] (May 2006)

=== Source code ===
* {{fgdata source|Nasal/view.nas}} – ''[[Nasal]] module that handles the view panning and translation, and related properties.''

[[Category:Head tracking| ]]

Addon

2020-12-27T16:27:21Z

Slawekmikula: /* List of Addons */ added new addons to the list, add new section Experimental Addon (unfinished, but can be taken as a source for addon development)

[[File:Fgaddonslogo202x89.png|right]]
To make it easier to create '''addons''' there is since FlightGear 2017.3 a new way to create addons. In essence FlightGear will load an overlay XML into the property tree and start a well known Nasal function.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314620#p314620
|title = <nowiki> Re: New Feature: Addon - "API" </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

We now have a simple way to add addons to FlightGear without the need to mess around with <code>FGData/Nasal</code> or <code>FGHome/Nasal</code> directories.<ref name="Forum_announcement">{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314563#p314563
|title = <nowiki> New Feature: Addon - "API" </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 18th, 2017
}}</ref>

{{TOC limit|3}}

== Installing and using an addon ==
Download and copy the addon to a directory on your computer.

Use the command line switch <code>--addon=/path/to/some/addon</code>.<ref name="Forum_announcement"/>

== Creating an addon ==
There is a very simple Skeleton addon available in FGAddon to be used as a template.<ref name="Forum_announcement"/> See {{fgaddon source|path=Addons/Skeleton}}.

A leading slash (<code>/</code>) in this section indicates the base directory of the directory structure of the addon.

=== Minimum configuration ===
An addon may be installed in a directory anywhere on your hard disk and need at least two files:

* <code>/addon-config.xml</code> - A standard [[PropertyList XML files|PropertyList XML file]] to be used to populate or modify the [[property tree]]. (Same as to be used in <code>--config=foo.xml</code>)
* <code>/addon-main.nas</code> - The Nasal hook for the logic. This file needs a function called <code>main()</code> which will be called from the global addon initializer (<code>addons.nas</code>)

=== Additional common files ===
* <code>/addon-metadata.xml</code> - A PropertyList XML file with metadata about the addon it.
* <code>/addon-menubar-items.xml</code> - A PropertyList XML file describing menus to be added to the FlightGear menu bar.
* <code>/gui/dialogs/<my-foobar-dialog>.xml</code> - PropertyList XML files to create custom dialogs.

=== Good to know ===
The new addon mechanism lets you add a <code>addon-config.xml</code> to override the settings in <code>defaults.xml</code> and other files.

That will allow an addon to
* Override key bindings (as in the spoken ATC addon)
* Add or override autopilots and property rules
* Introduce XML state machines

Unless your really want to add/change/remove those at runtime, this should cater for most use cases.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314902#p314902
|title = <nowiki> Re: Spoken </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 23rd, 2017
|added = Jul 23rd, 2017
|script_version = 0.40
}}</ref>

We have some instructions how to use SVN [[FGAddon|in our wiki]]. It covers mostly aircraft development but the workflow is pretty much the same for addons.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314647#p314647
|title = <nowiki> Re: Spoken ATC </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

== Addon initialization ==
On initialization fgfs takes care of:
* Through {{flightgear source|path=src/Main/options.cxx|text=<code>options.cxx</code>}}:<ref name="Forum_announcement"/>
** Creating a property under <code>/addons/addon[n]/path=/path/to/some/addon</code>
** Loading <code>/path/to/some/addon/addon-config.xml</code> into the property tree (same as <code>--config=/path/to/some/addon/addon-config.xml</code>)
** Adding <code>/path/to/some/addon</code> to the list of allowed directories (same as <code>--fg-aircraft=/path/to/some/addon</code>)
* Through {{fgdata source|path=Nasal/addons.nas|text=<code>addons.nas</code>}}:
** Loading <code>/foo/bar/baz/addon-main.nas</code> into namespace <code>__addon[ADDON_ID]__</code>
** Calling <code>main(addonGhost)</code> from <code>/foo/bar/baz/addon-main.nas</code>.

== APIs ==
{{hatnote|For more details about these APIs, see the readme file, {{readme file|add-ons}}.}}
=== C++ API ===
There is a C++ API on FlightGear's side that handle some on the addon related tasks manly through the <code>AddonManager()</code>, <code>Addon()</code> and <code>AddonVersion()</code> classes.

=== Nasal API ===
The Nasal add-on API lives in the 'addons' namespace and can for example do queries to <code>AddonManager()</code> and read data from <code>addons.Addon</code> objects. It can for example compare addon versions if there is dependencies.

== Background ==
{{See also|Howto:Creating a simple modding framework}}

ATC chatter was removed in 2015, see fgdata commit: [https://sourceforge.net/p/flightgear/fgdata/ci/81607f734e13add9be02816ddaec305d05bc4e47/ 81607f734e13add9be02816ddaec305d05bc4e47]

And the devel list messages referenced in the commit log.
the other relevant commit is this: b60736ba7add2a7cd39af3d8a974d5be3ea46e8b
It would not be very difficult to restore this functionality, or even generalize/improve it significantly (which was the scope of the original discussion on the devel list)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=288388#p288388
|title = <nowiki> Re: Whatever happened to radom radio </nowiki>
|author = <nowiki> Hooray </nowiki>
|date = Jun 11th, 2016
|added = Jun 11th, 2016
|script_version = 0.40
}}</ref>

The restored functionality could be distributed as a tarball that is extracted into $FG_ROOT - alternatively, into $FG_HOME, because Nasal files there are treated as overlays, which basically means that you can install user-specific extensions there without having to tamper with $FG_ROOT, it would only take very minor changes to turn the chatter feature into a corresponding "addon" - not unlike fgcamera ...<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=288392#p288392
|title = <nowiki> Re: Whatever happened to radom radio </nowiki>
|author = <nowiki> Hooray </nowiki>
|date = Jun 11th, 2016
|added = Jun 11th, 2016
|script_version = 0.40
}}</ref>

We should absolutely stop telling anyone to edit preferences.xml in FG_ROOT; any documentation or advice which says to should be changes ASAP. <ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=192632#p192632
|title = <nowiki> Re: NavCache:init failed:Sqlite error:Sqlite API abuse </nowiki>
|author = <nowiki> zakalawe </nowiki>
|date = Oct 26th, 2013
|added = Oct 26th, 2013
|script_version = 0.40
}}</ref>

As of 12/2017, the addon API is in the process of being significantly updated <ref>https://sourceforge.net/p/flightgear/mailman/message/36146017/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36150159/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36150444/</ref>

== List of Addons ==
You can find the official repository at {{fgaddon source|path=Addons}}

* ATC Chatter (ported by Torsten) {{progressbar|100}}
* [[Cargo Towing Addon]] <ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?t=36824
|title = <nowiki> Re: Cargo Towing Addon </nowiki>
|author = <nowiki> Wayne Bragg (wlbragg) </nowiki>
|date =
|added =
|script_version = 0.40
}}</ref>
* cockpit-view (work in progress by wkitty42)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=316498#p316498
|title = <nowiki> Re: </nowiki>
|author = <nowiki> wkitty42 </nowiki>
|date = Aug 13th, 2017
|added = Aug 13th, 2017
|script_version = 0.40
}}</ref>
* [[Earthview#Customization]] - High resolution customization
* [[FaceTrackNoIR]] (ported by HHS)<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/36454826/
|title = <nowiki> Re: </nowiki>
|author = <nowiki> Unknown, HHS</nowiki>
|date = Nov 1th, 2018
}}</ref> - An addon to interface this [[Head tracking|head tracker]] with FlightGear
* [[FGCamera]] (work in progress by Torsten)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314650#p314650
|title = <nowiki> Re: Alternative camera control </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref><ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=319804#p319804
|title = <nowiki> Re: New Feature: Addon - "API" </nowiki>
|author = <nowiki> slawekmikula </nowiki>
|date = Oct 2nd, 2017
|added = Oct 2nd, 2017
|script_version = 0.40
}}</ref>
* [[FGPlot]]
* [[Ground Services]] (ported by ThomasS)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=316400#p316400
|title = <nowiki> Re: </nowiki>
|author = <nowiki> ThomasS </nowiki>
|date = Aug 12th, 2017
|added = Aug 12th, 2017
|script_version = 0.40
}}</ref>
* [[Landing Rate addon]] [https://forum.flightgear.org/viewtopic.php?f=6&t=33101&p=327787#p327787]
* [https://gitlab.com/mdanil/flightgear-hax mdanilov hax!]: landing evaluation and aircraft development tools, TerraSync toggler
* [[Model Cockpit View]]
* [[Oscilloscope addon]] - Allows displaying a property of Nasal function over time
* [[PAR instrument]] - Precision Approach Radar and Ground Controlled Approach
* [[Red Griffin ATC]] - Speaking Air Traffic Controller<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?f=6&t=36755
|title = <nowiki> Re: </nowiki>
|author = <nowiki> RedGriffin </nowiki>
|date = Jan 6th, 2020
|added = Jan 6th, 2020
|script_version = 1.0.0 RC2
}}</ref>
* [[Spoken ATC]] (ported by Torsten)<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=314095#p314095
|title = <nowiki> Re: </nowiki>
|author = <nowiki> Torsten </nowiki>
|date = Jul 10th, 2017
|added = Jul 10th, 2017
|script_version = 0.40
}}</ref>
* [[Spoken GCA]] - An offline ground controlled approach (GCA) addon
* [[YASim Development Tools]] (by jsb)
* [https://github.com/slawekmikula/flightgear-addon-vfrflight VFRFlight integration] - ([https://github.com/slawekmikula/flightgear-addon-vfrflight/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-protocolkml KML Exporter (Google Earth)] - ([https://github.com/slawekmikula/flightgear-addon-protocolkml/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-vfrnavigator VFR Flying Helper] - ([https://github.com/slawekmikula/flightgear-addon-vfrnavigator/blob/master/doc/usage.md manual])
* [https://github.com/slawekmikula/flightgear-addon-linuxtrack LinuxTrack Head Tracker integration] - ([https://github.com/slawekmikula/flightgear-addon-linuxtrack/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-hudheli Additional Heli HUD's] - ([https://github.com/slawekmikula/flightgear-addon-hudheli/blob/master/doc/manual.md manual])

== Experimental Addons ==

Addons which are in the development stage/unfinished but can be used as a quick view of addon functionality

* [https://github.com/slawekmikula/flightgear-addon-littlenavmap LittleNavMap integration] - ([https://github.com/slawekmikula/flightgear-addon-littlenavmap/blob/master/doc/manual.md manual])
* [https://github.com/slawekmikula/flightgear-addon-missions FlightGear Missions addon] - Add-on for missions/adventures code

== Ideas ==
=== Hooking into features using legacy OpenGL code ===
{{See also|Unifying the 2D rendering backend via canvas}}
In 09/2018, James suggested that legacy features using raw OpenGL calls (e.g. HUD/2D panels) could be easily replaced via scripted Canvas/Nasal solutions at the mere cost of providing a mechanism to hook into the legacy code implementing these features (namely, the HUD/instrumentation subsystems) <ref>https://sourceforge.net/p/flightgear/mailman/message/36399261/</ref> <ref>https://sourceforge.net/p/flightgear/mailman/message/36399261/</ref>

=== Catalog & Package Manager support ===
if this works with more complex, pre-existing addons such as [[Bombable]], where the file layout is a replica of the old FGData layout, these types of mature addons might be better as SourceForge FlightGear sub-projects rather than being copied into FGAddon. Maybe the config file and nasal script could be used to automate the installation process ?<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35953179/
|title = <nowiki> Re: [Flightgear-devel] Simple API for creating FlightGear
addons/plugins </nowiki>
|author = <nowiki> Edward d'Auvergne </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>
The [[Bombable]] addon is one of the most popular addons out there, and a large number of aircraft in FGAddon have bombable support, so it is worth not forgetting about. Especially if the addon system one day becomes automated through a [[Catalog metadata|catalog.xml type system]]<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35953650/
|title = <nowiki> Re: [Flightgear-devel] Simple API for creating FlightGear
addons/plugins </nowiki>
|author = <nowiki> Edward d'Auvergne </nowiki>
|date = Jul 19th, 2017
|added = Jul 19th, 2017
|script_version = 0.40
}}</ref>

== References ==
{{Appendix}}

== Related content ==
=== Wiki articles ===
* [[FlightGear configuration via XML]]
* [[FlightGear configuration via XML#preferences.xml]]
* [[Nasal]]
* [[Property tree]]
* [[Properties persistent between sessions]]
* [[PropertyList XML File]]

=== Forum topics ===
* {{forum link|t=32561|title=New Feature: Addon - "API"}}

=== Readme files ===
* {{readme file|add-ons}}
* {{readme file|gui}} - Details on how to add menus and custom dialogs.

=== Source code ===
==== FGAddon ====
* {{fgaddon source|path=Addons/Skeleton}} - Skeleton addon to be used as a template.

==== FGData ====
* {{fgdata source|path=Nasal/addons.nas}}

==== FlightGear ====
* {{flightgear source|path=src/Main/options.cxx}}
* {{flightgear source|path=src/Add-ons/}}

[[Category:FlightGear addons| ]]

User:Slawekmikula

2019-12-15T07:36:20Z

Slawekmikula: added welcome template

Compositor

2019-12-01T08:01:29Z

Slawekmikula: /* How to enable the Compositor */ added information how to enable shadows from the commandline

{{Template:Non-stable|version=2019.2|build_flags=-DENABLE_COMPOSITOR=ON|progress=100}}

{{forum|47|Effects & Shaders}}

{{infobox subsystem
|image = ALS Compositor pipeline.jpg
|name = Compositor Framework
|started = 01/2018 (Available since FlightGear 2019.2)
|description = Dynamic rendering pipeline configured via the property tree and XML
|status = Stable
|developers = Fernando García Liñán
|folders =
* {{flightgear file|src/Viewer}}
* {{simgear file|simgear/scene/viewer}}
* {{fgdata file|Compositor}}
}}

The '''Compositor''' aims to bring multi-pass rendering to FlightGear. It encapsulates a rendering pipeline and exposes its parameters to a [[Property Tree]] interface. At startup, FlightGear reads the pipeline definition file for each physical viewport defined on the [[Howto:Configure camera view windows|CameraGroup settings]]. If no Compositor file is specified for a physical camera, the one given by the <code>--compositor=</code> startup command will be used. If such startup option is not used either, FlightGear will look for a valid Compositor file in $FG_ROOT/Compositor/default.xml

The Compositor introduces a new dedicated fgdata directory for new/custom rendering pipelines: {{Fgdata file|Compositor}}.

== Background ==
{{See also|Supporting multiple renderers|Howto:Canvas View Camera Element}}

First discussed in 03/2012 during the early [[Rembrandt]] days, Zan (Lauri Peltonen) came up with a set of patches demonstrating how to create an XML-configurable rendering pipeline.

Back then, this work was considered to look pretty promising <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/28946515/
|title = <nowiki> Re: [Flightgear-devel] [Rembrandt] the plan </nowiki>
|author = <nowiki> Mathias Fröhlich </nowiki>
|date = Mar 7th, 2012
|added = Mar 7th, 2012
|script_version = 0.36
}}</ref> and at the time plans were discussed to unify this with the ongoing Rembrandt implementation (no longer maintained).

Adopting Zan's approach would have meant that efforts like [[Rembrandt]] (deferred rendering) could have been implemented without requiring C++ space modifications, i.e. purely in [[Base package]] space.

Rembrandt's developer (FredB) suggested to extend the format to avoid duplicating the stages when you have more than one viewport, i.e. specifying a pipeline as a template, with conditions like in effects, and have the current camera layout refer the pipeline that would be duplicated, resized and positioned for each declared viewport <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/28944773/
|title = <nowiki> Re: [Flightgear-devel] [Rembrandt] the plan </nowiki>
|author = <nowiki> Frederic Bouvier </nowiki>
|date = Mar 7th, 2012
|added = Mar 7th, 2012
|script_version = 0.36
}}</ref>

Zan's original patches can still be found in his newcameras branches which allow the user to define the rendering pipeline in preferences.xml: {{gitorious source|proj=fg|repo=zans-flightgear|branch=newcameras|text=FlightGear}}, {{gitorious source|proj=fg|repo=zans-simgear|branch=newcameras|text=SimGear}}.

At that point, it didn't have everything Rembrandt's pipeline needs, but most likely could be easily enhanced to support those things.

Basically, the original version added support for multiple camera passes, texture targets, texture formats, passing textures from one pass to another etc, while preserving the standard rendering line if user wants that. <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/28944733/
|title = <nowiki> [Flightgear-devel] [Rembrandt] the plan </nowiki>
|author = <nowiki> Lauri Peltonen </nowiki>
|date = Mar 7th, 2012
|added = Mar 7th, 2012
|script_version = 0.36
}}</ref>

Since the early days of Zan's groundwork, providing the (hooks) infrastructure to enable base package developers to prototype, test and develop distinct rendering pipelines without requiring C++ space modifications has been a long-standing idea, especially after the [[Canvas]] system became available in early 2012, which demonstrated how RTT-rendering buffers (FBOs) could be set up, created and manipulated procedurally (i.e. at run-time) using XML, the property tree and [[Nasal]] scripting. <ref>{{forum link|type=search|title=Zan's Rembrandt and Canvas work|keywords=zan+rembrandt+canvas}}</ref>

The new '''Compositor''' is an improved re-implementation of Zan's original work using not just XML, but also [[Property Tree|properties]] and a handful of [[Canvas]] concepts.

== Features ==

* Completely independent of other parts of the simulator, i.e. it's part of [[SimGear]] and can be used in a standalone fashion if needed, ala Canvas.
* Although independent, its aim is to be fully compatible with the current rendering framework in FG. This includes the [[Effects]] system, [[Howto:Configure camera view windows|CameraGroup]], [[Rembrandt]] and [[ALS]] (and obviously the [[Canvas]]).
* Its functionality overlaps Rembrandt: what can be done with Rembrandt can be done with the Compositor, but not vice versa.
* Fully configurable via an XML interface without compromising performance (ala Effects, using [[PropertyList XML File|PropertyList files]]).
* Flexible, expandable and compatible with modern graphics.
* It doesn't increase the hardware requirements, it expands the hardware range FG can run on. People with integrated GPUs (Intel HD etc) can run a Compositor with a single pass that renders directly to the screen like before, while people with more powerful cards can run a Compositor that implements deferred rendering, for example.
* Static branching support. Every pipeline element can be enabled/disabled at startup via a [[Conditions|<condition> block]].

== How to enable the Compositor ==

Currently the Compositor can only be enabled at compile time via the <code>-DENABLE_COMPOSITOR=ON</code> CMake flag in FlightGear. SimGear doesn't require any extra parameters. Once you have a binary with the Compositor enabled and you run it, you will be presented with the default rendering pipeline. At the time of writing, this is the low spec rendering pipeline. If you want to try the ALS pipeline, start FlightGear with the command line argument: <code>--compositor=Compositor/ALS/als</code>

If you want to enable shadows on all objects in the ALS pipeline use these options as a startup parameters (in QT GUI or in the commandline) <code>--prop:bool:/sim/rendering/als/shadows/enabled=true</code> and <code>--prop:int:/sim/rendering/als/shadows/sun-atlas-size=2048</code>

== Notes for aircraft developers ==

=== Lights ===

The Compositor introduces a new way of defining lights that is renderer agnostic, so every rendering pipeline will be able to access the lights that have been implemented like this. As of 2019/11, the only pipeline that supports dynamic lights is the ALS pipeline. The resulting light volumes can be visualized for debugging purposes by setting the property <tt>/sim/debug/show-light-volumes</tt> to true.

{|cellpadding=10|
|valign=top style="width: 20%;"|
<syntaxhighlight lang="xml">
<light>
<name>my-spotlight</name>
<type>spot</type>
<position>
<x-m>-7.7476</x-m>
<y-m>0</y-m>
<z-m>-1.7990</z-m>
</position>
<direction>
<x>-1.0</x>
<y>0</y>
<z>-0.013</z>
</direction>
<ambient>
<r>0.03</r>
<g>0.03</g>
0.03
<a>1</a>
</ambient>
<diffuse>
<r>0.95</r>
<g>0.9</g>
0.9
<a>1</a>
</diffuse>
<specular>
<r>0.95</r>
<g>0.9</g>
0.9
<a>1</a>
</specular>
<attenuation>
<c>1.0</c>
<l>0.09</l>
<q>0.032</q>
</attenuation>
<spot-exponent>5</spot-exponent>
<spot-cutoff>40</spot-cutoff>
<range-m>50</range-m>
</light>
</syntaxhighlight>
|valign=top style="width: 80%;"|
* <tt>'''name'''</tt>. An {{tag|animation}} will be able to reference the light by this name. Most animations will work as expected (rotate, translate, spin etc).
* <tt>'''type'''</tt>. <tt>spot</tt> or <tt>point</tt>.
* <tt>'''position'''</tt>. The position of the light source in model space and in meters.
* <tt>'''direction'''</tt>. Only available in <tt>spot</tt> lights. It indicates the direction of the spotlight. This parameter can be specified in three different ways:
{| class="wikitable" style="border: 1px solid darkgray;"
! scope="col" style="width:33%;" |Direction vector
! scope="col" style="width:33%;" |Look-at point
! scope="col" style="width:33%;" |Rotation angles
|-
| style="padding: 10px" | A vector in model space that specifies the direction. Doesn't have to be normalized.
<syntaxhighlight lang="xml">
<x>-1.0</x>
<y>0</y>
<z>-0.013</z>
</syntaxhighlight>
| style="padding: 10px" | The spotlight will calculate its direction by looking at this position from the light position. The point is in model space and in meters.
<syntaxhighlight lang="xml">
<lookat-x-m>-8.031</lookat-x-m>
<lookat-y-m>0</lookat-y-m>
<lookat-z-m>-2</lookat-z-m>
</syntaxhighlight>
| style="padding: 10px" | A three angle rotation in degrees that rotates the spotlight around the three axes. A 0 degree angle in all axes makes the spotlight point downwards (negative Z).
<syntaxhighlight lang="xml">
<pitch-deg>90</pitch-deg>
<roll-deg>0</roll-deg>
<heading-deg>0</heading-deg>
</syntaxhighlight>
|}
* <tt>'''ambient'''</tt>, <tt>'''diffuse'''</tt> and <tt>'''specular'''</tt>. Four-component vectors that specify the light color.
* <tt>'''attenuation'''</tt>. Three-component vector where <code><c></code> specifies the constant factor, <code><l></code> specifies the linear factor and <code><nowiki><q></nowiki></code> specifies the quadratic factor. These factors are plugged into the OpenGL light attenuation formula [[File:Spotlight_attenuation.png]] where d is the distance of the fragment to the light source. See this [http://wiki.ogre3d.org/tiki-index.php?page=-Point+Light+Attenuation table] for a list of attenuation values based on the range of the light.
* <tt>'''range-m'''</tt>. Maximum range from the light source position in meters. This value will be used by the renderers to determine if a fragment is illuminated by this source. Every fragment outside this range isn't guaranteed to be affected by the light, even if the attenuation factor isn't 0 in that particular fragment.
* <tt>'''cutoff'''</tt>. Only available in <tt>spot</tt> lights. It specifies the maximum spread angle of a light source. Only values in the range 0 90 are accepted. If the angle between the direction of the light and the direction from the light to the fragment being lighted is greater than the spot cutoff angle, it won't be lit.
* <tt>'''exponent'''</tt>. Only available in <tt>spot</tt> lights. Higher spot exponents result in a more focused light source, regardless of the spot cutoff angle.
* <tt>'''debug-color'''</tt> ('''Optional'''). Sets the color of the debug light volume. By default it's red.
|}

=== Shadows ===

The shadow mapping algorithm can be customized entirely by the rendering pipeline. This means that each one will have its own requirements when it comes to shadows. Here are some general recommendations:

* Use the <code><noshadow></code> animation to disable shadows on objects that don't need them. An example would be billboarded lights or really small cockpit elements that don't need shadows and would cause degraded performance.
* Try to mark as many cockpit objects as possible as <tt>interior</tt>.
<syntaxhighlight lang="xml">
<model>
<name>interior</name>
<usage>interior</usage>
<path>Aircraft/JA37/Models/ja37-interior.xml</path> 
</model>
</syntaxhighlight>
* Unlike in Rembrandt, polygons facing the Sun are the ones used to generate the shadow map, so single sided surfaces and non-closed objects should be rendered correctly.

== Pipelines ==

=== Low-Spec pipeline ===

A fixed function forward rendering pipeline mainly targeted to low spec systems. It imitates the classic forward pipeline used before multi-pass rendering was introduced by using two near/far cameras rendering directly to the screen.

[[File:Low-spec Compositor pipeline.png|thumb|Screenshot showing OSG stats of the Compositor-based low-spec rendering pipeline.]]

=== ALS ===

The ALS pipeline tries to bring multipass rendering to the current ALS framework, effectively combining the best from ALS and Project Rembrandt.

==== Cascaded shadow mapping ====

The main issue with shadow mapping in FlightGear is the complexity of the scene graph. Culling times can become huge if we don't carefully select which parts of the scene graph we want to render in the shadow maps. Some possible optimizations:
* Study the minimum shadow map distance we can get without noticeable light leaking. Select an appropiate amount of cascades (more cascades = more passes over all geometry, and in general we want to keep the amount of forward passes to a minimum). We should have at least three cascades: the first just for cockpit/internal shadows, the second for the whole aircraft and the third for the rest of the scenery geometry. A fourth can be added if the transition between the second and the third is too harsh.
* Improve the culling masks (simgear/scene/util/RenderConstants.hxx). The CASTSHADOW_BIT flag is present in almost every object in the scene graph. Turning this flag off for trees, random buildings and other geometry intensive objects improves framerates by a very considerable amount. Should the user be able to select which objects cast shadows?
* Should the terrain cast shadows? The terrain is rarely steep enough to cast shadows. Apart from that, the terrain in FlightGear messes with automatic near/far computations for the shadow passes since the geometry is not tessellated enough. Also, the terrain LOD is not good enough to have decent cull times at far cascades.
* Adding a "internal only" shadow flag for aircraft developers. This allows farther shadow cascades to cull complex objects that are only visible in the nearest cascades. (Very important optimization for aircrafts with complex cockpit geometry).
* Vegetation shadows will be done by the "legacy" method currently in use. Shadow mapping on vegetation is much more expensive in terms of performance and the current algorithm does the job well enough. <ref>https://forum.flightgear.org/viewtopic.php?f=47&p=357606</ref>

==== Post-processing ====

Gamma correction, night vision and other ALS filters should happen in a quad pass. The current filter_combined() should be left for post-processing that requires as much precision as possible - e.g. dithering to prevent banding). HDR is not a planned feature for now so ALS will be using rgba8 buffers for most of its features.

==== Real-time dynamic reflections ====

Rendering dynamically to a cubemap is possible. As with shadow mapping, minimizing the object count and number of forward passes is vital to get good performance in FlightGear. Rendering to six cubemap faces requires six forward passes, but we can render to a dual paraboloid map instead, reducing this number to two.

==== Transparency ====

When shadows (and multipass rendering in general) come into play, transparent objects have to be treated differently, even when we are dealing with a forward renderer. In OSG there are two ways to separate transparent surfaces:

* Using RenderBins. After a single scene cull traversal, surfaces which belong to a special RenderBin type (DepthSortedBin) are removed or moved to another camera. This is how Rembrandt does it and it is the most backwards compatible approach since RenderBins can be changed directly inside Effects.
* Using cull masks. Two separate traversals are done: one for opaque objects and another for translucent objects. This requires offering aircraft developers another way of tagging a surface as transparent. A trivial approach would be to add a new <animation> type called 'transparent', but that wouldn't be backwards compatible. Maybe we can add some kind of system where we can change cull masks inside Effects? Would that be too hacky or out of place?

== Creating a custom rendering pipeline ==

Since the Compositor is completely data-driven, new rendering pipelines can be created by writing a custom XML pipeline definition. This section tries to document most of the available parameters, but the best and most up-to-date resource is the Compositor parsing code in SimGear ({{simgear file|simgear/scene/viewer}}). See existing pipelines in {{fgdata file|Compositor}} for practical examples on how to use these parameters.

=== Buffers ===

A buffer represents a texture or, more generically, a region of GPU memory.

{| class="wikitable" style="text-align: center; font-size: 85%; width: auto; table-layout: fixed;
! scope="col" | Parameter Name
! scope="col" | Optional
! scope="col" | Value
! scope="col" | Default Value
! scope="col" | Description
|-
! scope="row"| <tt>name</tt>
| {{No}}
| string
|
| Passes will be able to address the buffer by this name
|-
! scope="row"| <tt>type</tt>
| {{No}}
| <tt>1d, 2d, 2d-array, 2d-multisample, 3d, rect, cubemap</tt>
|
| Any texture type allowed by OpenGL
|-
! scope="row"| <tt>width</tt>
| {{No}}
| Any unsigned integer or <tt>screen</tt> to use the physical viewport width. The <code><property></code> tag can also be used to use a property value
|
| Texture width
|-
! scope="row"| <tt>screen-width-scale</tt>
| {{Yes}}
| float
| <tt>1.0</tt>
| If <tt>screen</tt> was used, this controls the width scaling factor
|-
! scope="row"| <tt>height</tt>
| {{No}}
| Any unsigned integer or <tt>screen</tt> to use the physical viewport height. The <code><property></code> tag can also be used to use a property value
|
| Texture height
|-
! scope="row"| <tt>screen-height-scale</tt>
| {{Yes}}
| float
| <tt>1.0</tt>
| If <tt>screen</tt> was used, this controls the height scaling factor
|-
! scope="row"| <tt>depth</tt>
| {{No}}
| Any unsigned integer. The <code><property></code> tag can also be used to use a property value
|
| Texture depth
|-
! scope="row"| <tt>format</tt>
| {{Yes}}
| See {{simgear file|simgear/scene/viewer/CompositorBuffer.cxx}} for the latest available values
| <tt>rgba8</tt>
| Specifies the texture format. It corresponds to the ''internalformat'', ''format'' and ''type'' arguments of the OpenGL function ''glTexImage2D''
|-
! scope="row"| <tt>min-filter, mag-filter</tt>
| {{Yes}}
| <tt>linear, linear-mipmap-linear, linear-mipmap-nearest, nearest, nearest-mipmap-linear, nearest-mipmap-nearest</tt>
| <tt>linear</tt>
| Change the minification and magnification filtering respectively
|-
! scope="row"| <tt>wrap-s, wrap-t, wrap-r</tt>
| {{Yes}}
| <tt>clamp, clamp-to-edge, clamp-to-border, repeat, mirror</tt>
| <tt>clamp-to-border</tt>
| They change the wrap mode for each coordinate
|-
! scope="row"| <tt>anisotropy</tt>
| {{Yes}}
| float
| <tt>1.0</tt>
|
|-
! scope="row"| <tt>border-color</tt>
| {{Yes}}
| vec4
| <tt>(0.0f, 0.0f, 0.0f, 0.0f)</tt>
|
|-
! scope="row"| <tt>shadow-comparison</tt>
| {{Yes}}
| bool
| <tt>true</tt>
|
|-
! scope="row"| <tt>shadow-texture-mode</tt>
| {{Yes}}
| <tt>luminance, intensity, alpha</tt>
| <tt>luminance</tt>
|
|-
! scope="row"| <tt>shadow-compare-func</tt>
| {{Yes}}
| <tt>never, less, equal, lequal, greater, notequal, gequal, always</tt>
| <tt>lequal</tt>
|
|}

=== Passes ===

A pass wraps around an [http://public.vrac.iastate.edu/vancegroup/docs/OpenSceneGraphReferenceDocs-3.0/a00089.html osg::Camera]. Passes all have some common parameters:

{| class="wikitable" style="text-align: center; font-size: 85%; width: auto; table-layout: fixed;
! scope="col" | Parameter Name
! scope="col" | Optional
! scope="col" | Value
! scope="col" | Default Value
! scope="col" | Description
|-
! scope="row"| <tt>clear-color, clear-accum, clear-depth and clear-stencil</tt>
| {{Yes}}
| vec4
| black, black, <tt>1.0</tt>, <tt>0</tt> respectively
| Pass clear colors
|-
! scope="row"| <tt>clear-mask</tt>
| {{Yes}}
| <tt>color, stencil, depth, accum</tt>
| <tt>color depth</tt>
| Pass clear mask
|-
! scope="row"| <tt>effect-scheme</tt>
| {{Yes}}
| Valid effect scheme name
| None
| The pass will try to use the specified effect scheme to draw every object.
|}

Passes can render to a buffer (Render to Texture), to several buffers (Multiple Render Targets) or directly to the framebuffer. This is accomplished by the <code><attachment></code> tag. Possible parameters of an attachment are:

{| class="wikitable" style="text-align: center; font-size: 85%; width: auto; table-layout: fixed;
! scope="col" | Parameter Name
! scope="col" | Optional
! scope="col" | Value
! scope="col" | Default Value
! scope="col" | Description
|-
! scope="row"| <tt>buffer</tt>
| {{No}}
| Valid buffer name
|
| The name of the buffer to output to
|-
! scope="row"| <tt>component</tt>
| {{No}}
| <tt>color, color0</tt> to <tt>color15, depth, stencil, depth-stencil</tt>
|
| FBO attachment point
|-
! scope="row"| <tt>level</tt>
| {{Yes}}
| int
| <tt>0</tt>
| Mipmap level of the texture that is attached
|-
! scope="row"| <tt>face</tt>
| {{Yes}}
| int
| <tt>0</tt>
| Face of cube map texture or z-level of 3d texture
|-
! scope="row"| <tt>mipmap-generation</tt>
| {{Yes}}
| bool
| <tt>false</tt>
| Whether mipmap generation should be done for texture
|-
! scope="row"| <tt>multisample-samples</tt>
| {{Yes}}
| int
| <tt>0</tt>
| Multisample anti-aliasing (MSAA) samples
|-
! scope="row"| <tt>multisample-color-samples</tt>
| {{Yes}}
| int
| <tt>0</tt>
| Multisample anti-aliasing (MSAA) color samples
|}

Passes can also receive buffers as input and use them in their shaders. This is accomplished by the <code><binding></code> tag, which has the following parameters:

{| class="wikitable" style="text-align: center; font-size: 85%; width: auto; table-layout: fixed;
! scope="col" | Parameter Name
! scope="col" | Optional
! scope="col" | Value
! scope="col" | Default Value
! scope="col" | Description
|-
! scope="row"| <tt>buffer</tt>
| {{No}}
| Valid buffer name
|
| The name of the buffer to bind
|-
! scope="row"| <tt>unit</tt>
| {{No}}
| int
|
| The texture unit to place the texture on. Effects will be able to access the buffer on this texture unit
|}

There are specific pass types, each with their own set of custom parameters.

==== scene ====
Renders the scene from the point of view given by the CameraGroup.
{| class="wikitable" style="text-align: center; font-size: 85%; width: auto; table-layout: fixed;
! scope="col" | Parameter Name
! scope="col" | Optional
! scope="col" | Value
! scope="col" | Default Value
! scope="col" | Description
|-
! scope="row"| <tt>cull-mask</tt>
| {{Yes}}
| A 32 bit number. See {{simgear file|simgear/scene/util/RenderConstants.hxx}} to know which bits enable what
| <tt>0xffffffff</tt>
| Specifies the cull mask to be used in the underlying <tt>osg::Camera</tt>
|-
! scope="row"| <tt>z-near, z-far</tt>
| {{Yes}}
| int
| Default Z range in the CameraGroup
| They change the depth range to be used
|-
! scope="row"| <tt>cubemap-face</tt>
| {{Yes}}
| int
| <tt>-1</tt> (don't use cubemap)
| Ignores the given view and projection matrices and uses a custom one that renders the scene as if it was seen from inside a cubemap looking towards the specified face
|}

==== quad ====
Renders a fullscreen quad with an optional [[Effects|effect]] applied. Useful for screen space shaders (like SSAO, Screen Space Reflections or bloom) and deferred rendering.
{| class="wikitable" style="text-align: center; font-size: 85%; width: auto; table-layout: fixed;
! scope="col" | Parameter Name
! scope="col" | Optional
! scope="col" | Value
! scope="col" | Default Value
! scope="col" | Description
|-
! scope="row"| <tt>geometry</tt>
| {{Yes}}
| float values for <code><x>, <y>, <width>, <height></code>
| <tt>0.0, 0.0, 1.0, 1.0</tt> respectively
| Size of the fullscreen quad inside the viewport using normalized coordinates.
|-
! scope="row"| <tt>effect</tt>
| {{Yes}}
| Valid Effect file
| None
| This Effect will be applied to the quad geometry
|}

==== shadow-map ====
Renders the scene from a light's point of view.
{| class="wikitable" style="text-align: center; font-size: 85%; width: auto; table-layout: fixed;
! scope="col" | Parameter Name
! scope="col" | Optional
! scope="col" | Value
! scope="col" | Default Value
! scope="col" | Description
|-
! scope="row"| <tt>light-name</tt>
| {{No}}
| Valid light name that exists in the scene graph
|
| The name of the <tt>osg::LightSource</tt> to use for this shadow map
|-
! scope="row"| <tt>near-m, far-m</tt>
| {{No}}
| Valid Effect file
|
| They specify the depth range of the shadow map
|}

== TODO ==

* Bring back distortion correction.
* Some kind of versioning system to be able to make breaking changes in the future if/when the compositor is updated in any significant way, without people having to manually update their configs.
* Bring back [[Howto:Canvas View Camera Element|Canvas integration]] so aircraft devs have access to the rendering pipeline. This allows to render exterior views in cockpit displays etc.
* Automatically calculate light source attenuation based on radius and radius based on attenuation.
* Add 1-bit transparency to shadow mapping (maybe even full blown transparency with multiple depth buffers?).

== Known Issues ==

* Setting a buffer scale factor different from 1.0 and rendering to it might not scale the splash screen correctly.
* Clustered shading crashes FG if compiled under OSG 3.6. This is related to osg::TextureBuffer changing definition from OSG 3.4 to OSG 3.6 (Images vs BufferData).

== References ==
{{Appendix}}

== Related content ==
=== Wiki articles ===
* [[Uniform Buffer Objects]]
* [[CompositeViewer Support]]
* [[FlightGear CIGI Support (Common Image Generator Interface)]]

=== Forum topics ===
* {{forum link|t=36269|text=The Compositor}}
* {{forum link|t=35095|text=Clustered Forward Rendering}} (12/2018)
* {{forum link|t=33045|text=Getting started with RTT}}
* {{forum link|t=32846|text=Canvas::View Development}}
* {{forum link|t=23929|text=Gear View in Cockpit}}
* {{forum link|t=20057|text=Rear-View mirror}}
* {{forum link|t=18905|text=Progress on synthetic terrain}}
* {{forum link|t=17184|text=Instruments with heightmaps}}

[[Category:Core development projects]]

Compositor

2019-11-04T00:04:42Z

Slawekmikula: corrected compositor compile flag format. There was needed =ON for value definition

Ubuntu

2017-10-31T16:26:20Z

Slawekmikula: added troubleshooting info for ubuntu 14.04 with latest simgear source (C++11 strict)

{{stub}}

Following steps walk through downloading the FlightGear source code, compile and run on Ubuntu 13.04 (x86_64)

== Required Packages ==

Install the following packages and libraries to be able to compile FlightGear:
<pre>
sudo apt-get install git subversion build-essential cmake cmake-curses-gui libpng12-dev libfreetype6-dev
libjpeg-dev libgif-dev libtiff5-dev libxmu-dev libxi-dev freeglut3-dev libalut-dev libxft-dev libxinerama-dev
libboost-dev libplib-dev libopenscenegraph-dev libsvn-dev libudev-dev libfontconfig1-dev
</pre>

== Download source ==

Create a fgsrc directory and get the source code with git:
<pre>mkdir ~/fgsrc
cd ~/fgsrc
git clone git://git.code.sf.net/p/flightgear/simgear simgear
git clone git://git.code.sf.net/p/flightgear/flightgear
git clone git://git.code.sf.net/p/flightgear/fgdata
</pre>

== Compile ==

Create directory to install FlightGear in and create environment variable:
<pre>export prefix=$HOME/FG-install && mkdir $prefix</pre>

Create a build directory for each package and run cmake from there:

SimGear:
<pre>cd ~/fgsrc
mkdir build-sg
cd build-sg
cmake -D CMAKE_INSTALL_PREFIX:PATH="$prefix" ~/fgsrc/simgear
make -j2 install
</pre>

FlightGear:
<pre>cd ~/fgsrc
mkdir build-fg
cd build-fg
cmake -D CMAKE_INSTALL_PREFIX:PATH="$prefix" ~/fgsrc/flightgear
make -j2 install
</pre>

== Run ==

Link fgdata to the data directory in FG-install
<pre>cd $prefix
ln -s ~/fgsrc/fgdata data</pre>

Run executable:
<pre>$prefix/bin/fgfs --fg-root=$prefix/data</pre>

== Troubleshooting ==

; Link error undefined reference to symbol 'dlopen@@GLIBC_2.2.5
: Uninstall fltk 1.3 library <pre>sudo apt-get remove libfltk1.3-dev</pre> See the [http://forum.flightgear.org/viewtopic.php?f=45&t=20164 forum]

; Only-a-black-screen problem:
: If you are a nvidia user and only get a black screen at startup, you might suffer from Ubuntu bug [https://bugs.launchpad.net/ubuntu/+source/nvidia-graphics-drivers/+bug/982485 982485]. Have a look at comment [https://bugs.launchpad.net/ubuntu/+source/nvidia-graphics-drivers/+bug/982485/comments/24 #24] for a possible workaround.

; Ubuntu 14.04 LTS could not compile simgear (error with codecvt include)
: As of 2017-10-29 C++11 is enforced in simgear ([https://sourceforge.net/p/flightgear/simgear/ci/2642299d772a3b88264d5fb05086817d0742ced7/ commit log]). Ubuntu 14.04 shipped with GCC 4.8 could not handle full C++11 compatibility. In order to change GCC to newer version use ubuntu-toolchain PPA repository like:
: <pre>sudo add-apt-repository ppa:ubuntu-toolchain-r/test</pre>
: <pre>sudo apt-get update</pre>
: <pre>sudo apt-get install gcc-5 g++-5</pre>
: <pre>sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-5 60 --slave /usr/bin/g++ g++ /usr/bin/g++-5</pre>

Poland

2017-05-10T10:18:46Z

Slawekmikula: added link to OSM2CITY generated scenery with forum link

'''Poland''' (Polish: '''Polska'''), officially the '''Republic of Poland''' (Polish: '''Rzeczpospolita Polska'''), is a country in Central Europe, bordered by Germany to the west; the Czech Republic and Slovakia to the south; Ukraine, Belarus and Lithuania to the east; and the Baltic Sea and Kaliningrad Oblast, a Russian exclave, to the north. The total area of Poland is 312,679 square kilometres (120,726 sq mi), making it the 9th largest in Europe. Poland has a population of over 38 million people.

== FlightGear community ==
Polish FlightGear community has own Facebook site [http://www.facebook.com/pages/FlightGear-Polska/184032164996361]

Forums:

== List of developed airports in Poland ==
{| class="wikitable sortable" border="0" cellpadding="4" cellspacing="0"
|-
! style="background:#efefef" | ICAO-Code !! style="background:#efefef" | Name of Airfield/Town !! style="background:#efefef" | Status (published) !! style="background:#efefef" | Status (development) !! class="unsortable" style="background:#efefef" | Comment
|-
| EPWA || [[Warsaw Chopin Airport]], Warsaw || custom layout, 3d models, airport service || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery]
|-
| EPSC || [[Goleniow Airport]], Goleniów/Sczecin || custom layout, 3d models, airport service || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery]
|-
| EPDE || [[Deblin Airport]], Dęblin || custom layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Military/civil airport
|-
| EPZG || [[Zielona Góra Airport]], Zielona Góra || custom layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Civil airport
|-
| EPLL || [[Łodź Airport]], Lublinek || custom layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Civil airport
|-
| EPLB || [[Lublin Airport]], Lublin || v1000 layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Civil airport
|-
| EPLR || [[Aeroclub of Lublin]] Radawiec || v850 layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Grass
|-
| EPSW || [[Aeroclub of Swidnik]] Świdnik || v850 layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Grass
|-
| EPWK || [[Wloclawek-Kruszyn]] || v1000 layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Grass
|-
| EPPL || [[Plock-Kostrogaj]] || v1000 layout, 3d models, Rembrandt || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Grass
|-
| EP70 || [[Rzepin]] || v850 layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Grass, forest landing
|-
| EPGD || [[Gdansk Airport ]] || v850 layout, 3d models || stalled || Part of [http://code.google.com/p/sceneria-epzg-babimost/downloads/detail?name=EPGDver.1.0.rar&can=2&q= Poland Custom Scenery] Civil airport
|-
| EPBC || [[Warszawa Babice ]] || v850 layout, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Concrete, Warsaw Aeroclub airport
|-
| EPRZ || [[Rzeszów Jasionka ]] || layout ver.1000, OKL 3d models || in progress || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Civil airport, OKL Rzeszów, aeroclub
|-
| EP65 || [[Smolnik ]] || layout ver.1000, 3d models || in progress || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Grassy airstrip,
|-
| EPZA || [[Aeroklub Ziemi Zamojskiej]] || layout ver.1000, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Grassy airstrip,
|-
| EPST || [[Aeroklub Stalowowolski]] || layout ver.1000, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Grassy airstrip,
|-
| EPKA || [[Kielce Masłów]] || layout ver.1000, 3d models || stalled || Part of [https://github.com/marimigu/custom-scenery-polish/ Poland Custom Scenery] Civil airport, Aeroclub,
|-
|}

== Custom Scenery of Poland ==
[[File:Warsaw Skyline.png|thumb|Warsaw skycrapers.]]
[[File:Hel Peninsula.png|thumb|Hel Peninsula]]
[[File:Czorsztynskie Lake.png|thumb|Czorsztyńskie Lake]]
[[File:Warsaw area with OSMcity buildings.png|thumb|Area populated with OSM2CITY buildings, roads and pylons]]

=== Terrain ===
Custom Scenery of Poland includes whole Poland territory and border areas of surrounding countries. Terrain was generated using CORINE 2006 and OSM data for roads and railways.

=== Objects & airports ===
Currently we have objects on following airports:

International
* [[Warsaw Chopin Airport|EPWA Warsaw-Okęcie]]
* EPGD Gdańsk-Rębiechowo
* EPSC Szczecin-Goleniów
* [[Zielona Góra Airport|EPZG Zielona Góra-Babimost]]
* EPLL Łódź-Lublinek
* [[Lublin Airport|EPLB Lublin]]
* EPRZ Rzeszów Jasionka

Regional
* EPBC Warsaw-Babice
* [[Wloclawek-Kruszyn|EPWK Włocławek-Kruszyn]]
* [[Plock-Kostrogaj|EPPL Płock-Kostrogaj]]
* EP70 Rzepin
* [[Smolnik|EP65 Smolnik]]

Aeroclub
* [[Aeroklub Ziemi Zamojskiej|EPZA Zamość-Mokre]]
* [[Aeroclub of Lublin|EPLR Lublin-Radawiec]]
* [[Aeroklub Stalowowolski|EPST Stalowa-Wola-Turbia]]

Military
* EPDE Dęblin

Foreign
* EKRN Bornholm-Rønne
* LZTT Poprad-Tatry

See [http://wiki.flightgear.org/Category:Airports_in_Poland Category:Airports in Poland]

And some VFR landmarks including Warsaw skyline.

Most airports uses v.1000 layout. See full list here: [http://code.google.com/p/custom-scenery-polish/w/list]

=== Volunteer ===
Feel free to help us! This scenery still needs objects and v.1000 layouts. You can take some pictures of nearby airports or VFR landmarks and send them to us. We also appreciate new 3d models. If You'd like to contribute contact us by [https://www.facebook.com/pages/FlightGear-Polska/184032164996361 Facebook] or [https://plus.google.com/112579708746822167956/posts?hl=pl Google +].

=== Credits ===
* SP-DAM objects, layouts
* SP-MMA objects, layouts, terrain
* SP-MAKA objects
* SP-R22 objects
* Zbyszek objects, layouts

=== Download ===
You can download custom scenery from:
'''git''' https://github.com/marimigu/custom-scenery-polish

=== OSM Scenery (Buildings, Roads, Pylons) ===

* Detailed scenery for Poland area can be fetched from [[Areas populated with osm2city scenery]]
* More information can be reached on the FlightGear forum: https://forum.flightgear.org/viewtopic.php?f=5&t=32172

[[Category:Places]]
[[Category:Poland]]

File:Warsaw area with OSMcity buildings.png

2017-05-10T10:16:39Z

Slawekmikula: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=Area populated with OSM2CITY buildings, roads and pylons}}
|date=2017-05-10
|source={{own}}
|author=[[User:Slawekmikula|Slawekmikula]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:OSM2City]]

Areas populated with osm2city scenery

2017-05-10T10:10:46Z

Slawekmikula: added eastern/central europe areas

This is a list of '''areas populated with [[osm2city.py|osm2city]] scenery''' available for download.

== Available areas ==
{| class="wikitable"
! Download link !! Area !! Status !! Forum thread !! Remarks
|-
| [https://onedrive.live.com/redir?resid=7d366cbd5efb21e2!1642&authkey=!APsD2Zn-Jq3m5OA&ithint=folder%2czip The Netherlands]
| [[File:EHoutline.png|thumb|150px]] || {{done}} || ||
|-
| [https://onedrive.live.com/redir?resid=7d366cbd5efb21e2!1645&authkey=!AAx41T78jYrL4KI&ithint=file%2czip Southern UK]
| [[File:EGOutline.png|thumb|150px]] || {{done}} || ||
|-
| [https://onedrive.live.com/redir?resid=7d366cbd5efb21e2!1646&authkey=!AFAFUx-rFpUiRPk&ithint=file%2czip Ireland]
| [[File:EIOutline.png|thumb|150px]] || {{done}} || ||
|-
| [https://onedrive.live.com/redir?resid=7D366CBD5EFB21E2!1651&authkey=!APsD2Zn-Jq3m5OA&ithint=file%2czip Switzerland]
| [[File:LSOutline.png|thumb|150px]] || {{done}} || ||
|-
| [https://drive.google.com/open?id=0B2CN49kDuXHgZ3U0LUFnU2ZJREE Phuket]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=30113 ||
|-
| [https://dl.dropboxusercontent.com/u/24846517/fg/osm2city/LOWI_OSM_buildings_20140928.tgz LOWI]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=19625 ||
|-
|-
| [https://drive.google.com/file/d/0B5TeZxXfefn3Q2F5ejFfVHBRTlE/view?usp=sharing Europe/Spain]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=19625 ||
|-
|-
| [https://drive.google.com/open?id=0B5TeZxXfefn3NUp4NkM2b1hPVDQ African/Canary islands]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=19625 ||
|-
|-
| [https://drive.google.com/open?id=0B5TeZxXfefn3Vll5cGVEcndZMTg Europe/Portugal]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=19625 ||
|-
| [http://zorba-osm2city.s3-website.eu-central-1.amazonaws.com/ Europe/Poland]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=32172 || FG 2017.1 and up
|-
| [http://zorba-osm2city.s3-website.eu-central-1.amazonaws.com/ Europe/Slovakia]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=32172 || FG 2017.1 and up
|-
| [http://zorba-osm2city.s3-website.eu-central-1.amazonaws.com/ Europe/Lithuania]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=32172 || FG 2017.1 and up
|-
| [http://zorba-osm2city.s3-website.eu-central-1.amazonaws.com/ Europe/Latvia]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=32172 || FG 2017.1 and up
|-
| [http://zorba-osm2city.s3-website.eu-central-1.amazonaws.com/ Europe/Estonia]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=32172 || FG 2017.1 and up
|-
| [http://zorba-osm2city.s3-website.eu-central-1.amazonaws.com/ Europe/Bulgaria]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=32172 || FG 2017.1 and up
|-
| [http://zorba-osm2city.s3-website.eu-central-1.amazonaws.com/ Europe/Hungary]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=32172 || FG 2017.1 and up
|-
| [http://zorba-osm2city.s3-website.eu-central-1.amazonaws.com/ Europe/Romania]
| || {{done}} || https://forum.flightgear.org/viewtopic.php?f=5&t=32172 || FG 2017.1 and up
|}

== Related content ==
* [[osm2city.py]] – Script used to generate this scenery.

[[Category:Scenery]]
[[Category:Lists]]

Areas populated with osm2city scenery

2017-03-05T09:22:15Z

Slawekmikula: added compatiblity note for Poland area

Areas populated with osm2city scenery

2017-03-03T18:35:51Z

Slawekmikula: added europe/poland location

Template:OSM Navigation

2017-02-26T16:05:04Z

Slawekmikula: correct repository addresses

{{Infobox subsystem
|name = Autogen Scenery
|started = 11/2013
|description = Improved autogen support for FlightGear using OSM data
|status = Under active development as of 02/2016
|developers = radi, vanosten, Soitanen, portreekid
|topic-fg = https://gitlab.com/fg-radi/osm2city/
|topic-fgdata = https://gitlab.com/fg-radi/osm2city-data/
}}
{{sidebar
|name = OSM Navigation
|title = OpenStreetMap use in FlightGear
|contentstyle = text-align: left;

| content1 =
* [[OpenStreetMap]]
* [[Using OSM Vector Data in FlightGear]]
* [[Canvas Scenery Overlays]]
* [[Traffic Shader]]
* [[AutoGen Scenery for FlightGear]]
* [[OpenStreetMap buildings]]
* [[Osm2city.py]]
** [[Osm2city.py Textures]]
* [[Random Buildings]]
* [[OpenStreetMap import]]


}}{{main other|
[[Category:OpenStreetMap]]
[[Category:Core development projects]]}}
[[Category:OSM2City]]
[[Category:Python Software]]
<noinclude>{{Informative template|1=
== Goal ==
This template can be used at the top of articles related to using OpenStreetMap with FlightGear or the scenery tools.

== Usage ==
Put this at the top of the article:
{{obr}}'''OSM Navigation'''{{cbr}}

}}

[[Category:Navigation templates]]
[[Category:OpenStreetMap|OSM Navigation]]
</noinclude>