329
edits
Red Leader (talk | contribs) (More ref expansion) |
(Partial dequote, style fixes) |
||
Line 9: | Line 9: | ||
| maintainers = {{usr|Zakalawe|James Turner}} | | maintainers = {{usr|Zakalawe|James Turner}} | ||
| developers = James Turner | | developers = James Turner | ||
| status = Under active development as of | | status = Under active development as of 05/2016. | ||
| folders = {{flightgear source|path=src/GUI}} | | folders = {{flightgear source|path=src/GUI}} | ||
| changelog = {{flightgear source|path=src/GUI|view=log}} | | changelog = {{flightgear source|path=src/GUI|view=log}} | ||
Line 18: | Line 18: | ||
{{Package Management}} | {{Package Management}} | ||
== History == | == History and status == | ||
In October 2014, Apple released OS X 10.10 Yosemite. Unfortunately, one of the frameworks the [[FlightGear Mac OS X Launcher|old FlightGear Mac launcher]] relied upon, called {{wikipedia|RubyCocoa}}, was removed, making | In October 2014, Apple released OS X 10.10 Yosemite. Unfortunately, one of the frameworks the [[FlightGear Mac OS X Launcher|old FlightGear Mac launcher]] relied upon, called {{wikipedia|RubyCocoa}}, was removed, making it incompatible with OS X Yosemite. James Turner started work on a solution for the then-upcoming 3.4 release. He added a simple launcher using Qt, run before the main window would be created. It was released with FlightGear 3.4 as a Mac-only feature. | ||
After FlightGear 3.4, it was decided to that this temporary Mac-only launcher would be developed into a replacement for [[FGRun]] and that it would become part of the plan for updating FlightGear | After FlightGear 3.4, it was decided to that this temporary Mac-only launcher would be developed into a replacement for [[FGRun]] and that it would become part of the plan for updating the FlightGear user interface. In FlightGear 3.6, it became available for all platforms, and has continued to be developed, enhanced, and refined. | ||
As of May 2016, the Qt launcher is under active development. This includes the adding of new features, fixing bugs, and refining existing features. | |||
== Usage == | == Usage == | ||
To run the launcher: | |||
* Microsoft Windows users can double-click the '''FlightGear <version>''' icon on the Desktop or click on '''Start''' -> '''All Programs''' -> '''FlightGear <version>''' -> '''FlightGear Launcher'''; | |||
* OS X and Linux users must open a terminal and run <tt>fgfs</tt> with the option <code>--launcher</code>: | |||
<syntaxhighlight lang="shell"> | <syntaxhighlight lang="shell"> | ||
$ fgfs --launcher | $ fgfs --launcher | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{note|The launcher is an optional feature for the reasons explained below in the [[#Dependencies|Dependencies]] section. As a result, if you are on Linux and have installed the version of FlightGear provided by your distribution, it might not be available because the packagers might have not enabled it. In that case, ask your distribution to enable the feature.}} | |||
<gallery mode="packed"> | <gallery mode="packed"> | ||
Line 34: | Line 40: | ||
Qt launcher for FlightGear 3.5 on Windows 7 addons.jpg|Addons page of Qt launcher in FG 3.5 on Windows 7 | Qt launcher for FlightGear 3.5 on Windows 7 addons.jpg|Addons page of Qt launcher in FG 3.5 on Windows 7 | ||
</gallery> | </gallery> | ||
=== Multiplayer connections === | |||
As the launcher is still under development, only some basic options are present; notably, no multiplayer option is shown. To connect to the multiplayer servers, either: | |||
* start FlightGear from the launcher and then choose '''Multiplayer''' -> '''Multiplayer Settings''' inside the simulator; | |||
* or open the '''Settings''' tab in the launcher and specify the following parameters: | |||
<syntaxhighlight lang="shell"> | |||
--console --multiplay=out,10,mpserver01.flightgear.org, --multiplay=in,10,, --callsign=mycallsign | |||
</syntaxhighlight> | |||
replacing ''mpserver01.flightgear.org'' with the multiplayer server to be used and ''mycallsign'' with the desired callsign. | |||
=== Enabling console display on Windows systems === | |||
To enable console display on Windows systems, right-click on the FlightGear shortcut on the Desktop and click '''Properties'''. In the '''Target''' box, add <tt>--launcher</tt> at the end and click '''OK'''. | |||
=== Aircraft/TerraSync download directory === | |||
As of FlightGear 2016.2, the location used by the launcher to store downloaded aircraft and TerraSync scenery can be specified in the '''Add-ons''' tab. Specifying the TerraSync download directory manually has, thus, become unnecessary.<ref name="LauncherChanges">{{cite web | |||
| url = http://sourceforge.net/p/flightgear/mailman/message/35001457/ | |||
| title = <nowiki>[Flightgear-devel] Launcher add-on handling changes</nowiki> | |||
| author = <nowiki>James Turner</nowiki> | |||
| date = Apr 8th, 2016 | |||
| added = Apr 8th, 2016 | |||
| script_version = 0.25 | |||
}}</ref> | |||
== Background == | == Background == | ||
In accordance with the [[FlightGear 4.xx Roadmap]], FlightGear's current | In accordance with the [[FlightGear 4.xx Roadmap]], FlightGear's current graphical interface (based on the [[PUI]] library of [[PLIB]]) will be replaced by one based on Qt. [[FGRun]] will also be removed in future to be replaced by this launcher. In addition, a browser-based UI (called [[Phi]]) will continue to be developed in parallel.<ref>{{cite web | ||
|url=https://forum.flightgear.org/viewtopic.php?f=18&t=25115#p229445 | |url=https://forum.flightgear.org/viewtopic.php?f=18&t=25115#p229445 | ||
|title=Re: New Canvas GUI | |title=Re: New Canvas GUI | ||
Line 46: | Line 74: | ||
* External browser-based UI (Phi) | * External browser-based UI (Phi) | ||
However, it should be made clear | However, it should be made clear that Qt will always remain an optional dependency.<ref name="GUIquestions">{{cite web | ||
|url = https://sourceforge.net/p/flightgear/mailman/message/34532040/ | |url = https://sourceforge.net/p/flightgear/mailman/message/34532040/ | ||
|title = <nowiki>[Flightgear-devel] GUI questions (again)</nowiki> | |title = <nowiki>[Flightgear-devel] GUI questions (again)</nowiki> | ||
Line 53: | Line 81: | ||
}}</ref> | }}</ref> | ||
== | == Preferences == | ||
In FlightGear 2016.2 and later, the preferences are stored in $FG_HOME/flightgear.org/FlightGear.ini.<ref name="LauncherChanges" /> Older versions make use of the default location used by Qt: | |||
* the Registry on Microsoft Windows; | |||
* ''~/Library/Preferences'' on OS X; | |||
* the default preferences location on Linux (usually ''~/.config/FlightGear/FlightGear.conf''). | |||
Preferences can be reset to their default values by holding down the {{key press|Alt}} key while starting the launcher.<ref name="LauncherPreferences">{{cite web | |||
| url = http://sourceforge.net/p/flightgear/mailman/message/34642397/ | |||
| title = <nowiki>Re: [Flightgear-devel] Qt launcher and phi-utility FGFS 3.6.0 RC | |||
to 3.7.0</nowiki> | to 3.7.0</nowiki> | ||
| author = <nowiki>James Turner</nowiki> | |||
| date = Nov 23rd, 2015 | |||
| added = Nov 23rd, 2015 | |||
| script_version = 0.23 | |||
}}</ref> | |||
}} | |||
== Repercussions == | == Repercussions == | ||
=== Dependencies === | === Dependencies === | ||
When the launcher was introduced, there were significant divergences of opinion regarding whether it was appropriate to require the dependency on Qt; the core developers concluded that it was undesirable, unless it had a specific benefit.<ref>{{cite web |url=http://sourceforge.net/p/flightgear/mailman/message/34196458/ | |||
|title=<nowiki>Re: [Flightgear-devel] Policy Document and V4.X Roadmap</nowiki> | |||
|author=<nowiki>Durk Talsma</nowiki> | |||
|date=<nowiki>2015-06-11</nowiki> | |||
}}</ref> Since, for the time being, Qt is only needed for the launcher, it has been made an optional dependency, and people can continue using other frontends should they wish so. | |||
If CMake is not able to find Qt 5.1 (the minimum required version) or later, the launcher is not compiled,<ref>{{cite web | |||
|url = http://sourceforge.net/p/flightgear/mailman/message/33498614/ | |url = http://sourceforge.net/p/flightgear/mailman/message/33498614/ | ||
|title = <nowiki>Re: [Flightgear-devel] FGData splitting / assembling the base | |title = <nowiki>Re: [Flightgear-devel] FGData splitting / assembling the base | ||
Line 86: | Line 111: | ||
|author = Rebecca N. Palmer | |author = Rebecca N. Palmer | ||
|date = Feb 26th, 2015 | |date = Feb 26th, 2015 | ||
}}</ref> | }}</ref><ref>{{cite web | ||
|url = http://sourceforge.net/p/flightgear/mailman/message/33498869/ | |url = http://sourceforge.net/p/flightgear/mailman/message/33498869/ | ||
|title = <nowiki>Re: [Flightgear-devel] Qt launcher requirement bump in Flightgear | |title = <nowiki>Re: [Flightgear-devel] Qt launcher requirement bump in Flightgear | ||
Line 93: | Line 117: | ||
|author = Bertrand Coconnier | |author = Bertrand Coconnier | ||
|date = Feb 26th, 2015 | |date = Feb 26th, 2015 | ||
}}</ref> | }}</ref> and the following message will be printed: | ||
<syntaxhighlight lang="text"> | <syntaxhighlight lang="text"> | ||
-- Qt launcher enabled, checking for Qt 5.1 / qmake | -- Qt launcher enabled, checking for Qt 5.1 / qmake | ||
Line 115: | Line 136: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
As of May 2015, the Qt launcher is the default on Microsoft Windows and OS X: in the case of Linux, it's up to the distribution packagers whether to include it or not. | |||
If, how and when the internal GUI can leverage Qt is under investigation and in such an early state that those responsible preferred to not announce anything yet. If this ever happens, this will be discussed on the mailing list<ref name="GUIhell">{{cite web | If, how and when the internal GUI can leverage Qt is under investigation and in such an early state that those responsible preferred to not announce anything yet. If this ever happens, this will be discussed on the mailing list.<ref name="GUIhell">{{cite web | ||
|url = http://forum.flightgear.org/viewtopic.php?p=229563#p229563 | |url = http://forum.flightgear.org/viewtopic.php?p=229563#p229563 | ||
|title = <nowiki>Re: FlightGear GUI hell: PUI, Canvas GUI, Mongoose, Qt5 ??</nowiki> | |title = <nowiki>Re: FlightGear GUI hell: PUI, Canvas GUI, Mongoose, Qt5 ??</nowiki> | ||
Line 124: | Line 145: | ||
}}</ref> | }}</ref> | ||
=== | === Segmentation faults and race conditions === | ||
{{Note|Also see {{Issue|1819}}}} | {{Note|Also see {{Issue|1819}}}} | ||
{{FGCquote|1= Should installing an aircraft to the proper aircraft folder be allowed to crash the launcher if that plane has an error the launcher can detect or should maybe the launcher load and report an error somewhere visible in the launchers gui?|2= {{cite web | url = http://sourceforge.net/p/flightgear/mailman/message/34430800/ | title = <nowiki>Re: [Flightgear-devel] fgaddon c310 typos??</nowiki> | author = <nowiki>Ray St. Marie</nowiki> | date = Sep 3rd, 2015 }}}} | {{FGCquote|1= Should installing an aircraft to the proper aircraft folder be allowed to crash the launcher if that plane has an error the launcher can detect or should maybe the launcher load and report an error somewhere visible in the launchers gui?|2= {{cite web | url = http://sourceforge.net/p/flightgear/mailman/message/34430800/ | title = <nowiki>Re: [Flightgear-devel] fgaddon c310 typos??</nowiki> | author = <nowiki>Ray St. Marie</nowiki> | date = Sep 3rd, 2015 }}}} | ||
Line 158: | Line 179: | ||
}} | }} | ||
James isn't expecting many issues integrating Canvas layers with a Qt GUI, so there is no wasted development effort there ( | James isn't expecting many issues integrating Canvas layers with a Qt GUI, so there is no wasted development effort there (there is the possibility to make a [[Canvas]] backend based upon QPainter, which might be a great way to use spare CPU cycles to unload the GPU, however, as Canvas rendering becomes more intensive).<ref name="GUItech">{{cite web | ||
|url = http://sourceforge.net/p/flightgear/mailman/message/33245028/ | |url = http://sourceforge.net/p/flightgear/mailman/message/33245028/ | ||
|title = <nowiki>[Flightgear-devel] Gui technologies</nowiki> | |title = <nowiki>[Flightgear-devel] Gui technologies</nowiki> | ||
|author = James Turner | |author = James Turner | ||
|date = Jan 20th, 2015 | |date = Jan 20th, 2015 | ||
}}</ref> | }}</ref> However, at least for the time being, the Qt5 GUI is not even available at run-time, but will be shut down after handing over control to the main FlightGear initialization routines. | ||
Originally, one of the main motivations for adopting Canvas and using it for UI purposes was to help getting rid of PUI (our legacy GUI engine), while coming up with a GUI that would be compatible with other important use-cases (think modern MFDs showing GUI dialogs and vice versa). | Originally, one of the main motivations for adopting Canvas and using it for UI purposes was to help getting rid of PUI (our legacy GUI engine), while coming up with a GUI that would be compatible with other important use-cases (think modern MFDs showing GUI dialogs and vice versa). | ||
The latter is an increasingly important use-case in real life avionics (on jets/airliners) - as can be seen by [[ARINC 661]]. Such use-cases aren't easily supported by a distributed approach involving for example a browser, HTML5 and ECMAScript/JavaScript | The latter is an increasingly important use-case in real life avionics (on jets/airliners) - as can be seen by [[ARINC 661]]. Such use-cases aren't easily supported by a distributed approach involving for example a browser, HTML5 and ECMAScript/JavaScript. | ||
In addition, the idea is to keep modernizing and [[Unifying_the_2D_rendering_backend_via_canvas|unifying the 2D rendering back-end]] in FlightGear by getting rid of legacy GL code to hopefully use modern OSG code in more and more places | In addition, the idea is to keep modernizing and [[Unifying_the_2D_rendering_backend_via_canvas|unifying the 2D rendering back-end]] in FlightGear by getting rid of legacy GL code to hopefully use modern OSG code in more and more places.<ref>{{cite web | ||
|url = http://forum.flightgear.org/viewtopic.php?p=229311#p229311 | |url = http://forum.flightgear.org/viewtopic.php?p=229311#p229311 | ||
|title = <nowiki>Re: New Canvas GUI</nowiki> | |title = <nowiki>Re: New Canvas GUI</nowiki> | ||
|author = Hooray | |author = Hooray | ||
|date = Jan 8th, 2015 | |date = Jan 8th, 2015 | ||
}}</ref> | }}</ref> At least for now, it isn't even clear if/how and when Canvas-based MFDs may support HTML5/Qt5-based UI components or vice versa (e.g. a Qt5 based dialog showing Canvas-based features, such as a [[MapStructure]] layer or MFD instances like the [[NavDisplay]]). Unlike Canvas-based efforts like the [[Aircraft Center]], the Qt5 effort is also adding a rather significant build-time dependency for those wanting to use the new built-in launcher. | ||
=== Duplicating existing functionality === | === Duplicating existing functionality === | ||
Line 212: | Line 233: | ||
=== PLIB/PUI (legacy GUI) === | === PLIB/PUI (legacy GUI) === | ||
{{Main article|Howto:Processing legacy PUI dialogs using Canvas}} | {{Main article|Howto:Processing legacy PUI dialogs using Canvas}} | ||
Up to now - only a simple replacement for the Mac Launcher has been introduced (and enabled by default only on OSX). This is not related to the internal user interface of FlightGear (which is mainly based on [[PUI]] and increasingly Canvas these days), at least for now<ref name="GUIhell"/> | Up to now - only a simple replacement for the Mac Launcher has been introduced (and enabled by default only on OSX). This is not related to the internal user interface of FlightGear (which is mainly based on [[PUI]] and increasingly Canvas these days), at least for now.<ref name="GUIhell"/> | ||
However, the goal is to make an '''optional''' Qt dependency to replace PLIB PUI<ref>{{cite web | However, the goal is to make an '''optional''' Qt dependency to replace PLIB PUI.<ref>{{cite web | ||
|url = http://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ | |url = http://sourceforge.net/blog/november-2015-community-choice-project-of-the-month-flightgear/ | ||
|title = November 2015, "Community Choice" Project of the Month – FlightGear | |title = November 2015, "Community Choice" Project of the Month – FlightGear | ||
|author = SourceForge Community Team | |author = SourceForge Community Team | ||
|date = Nov 1st, 2015 | |date = Nov 1st, 2015 | ||
}}</ref> | }}</ref> | ||
Except of course PUI will have to remain for some awkward use cases in the short term (aircraft dialogs, potentially). When compiled without Qt support, you’ll get a fully functional FG (i.e., '''Qt will never be a requirement to build FG'''), but without the GUI functions – which is indeed what some people want anyway (e.g., in some home cockpit setups). | Except of course PUI will have to remain for some awkward use cases in the short term (aircraft dialogs, potentially). When compiled without Qt support, you’ll get a fully functional FG (i.e., '''Qt will never be a requirement to build FG'''), but without the GUI functions – which is indeed what some people want anyway (e.g., in some home cockpit setups). | ||
Any in-sim GUI using Qt will exist in parallel to the PLIB/PUI one for at least one major release, although this may mean maintaining two sets of dialogs, unless the XML-translation-tool is good enough that we can use it at run-time for aircraft dialogs<ref name="GUIquestions"/> | Any in-sim GUI using Qt will exist in parallel to the PLIB/PUI one for at least one major release, although this may mean maintaining two sets of dialogs, unless the XML-translation-tool is good enough that we can use it at run-time for aircraft dialogs.<ref name="GUIquestions"/> | ||
Expect to see a test branch in Git in the next month or so, and hopefully something usable for 3.6. The PLIB code will remain so hopefully it can be a gradual transition<ref name="GUItech"/> | Expect to see a test branch in Git in the next month or so, and hopefully something usable for 3.6. The PLIB code will remain so hopefully it can be a gradual transition.<ref name="GUItech"/> | ||
{{FGCquote | {{FGCquote | ||
Line 265: | Line 286: | ||
=== FGRun === | === FGRun === | ||
One of the goals of the Qt launcher is to deprecate older frontends, like [[FGRun]].<ref>{{cite web | |||
|url = http://sourceforge.net/p/flightgear/codetickets/1591/#4cb7 | |url = http://sourceforge.net/p/flightgear/codetickets/1591/#4cb7 | ||
|title = Re: #1591 Restore defaults sets invalid paths | |title = Re: #1591 Restore defaults sets invalid paths | ||
|author = Gijs de Rooy | |author = Gijs de Rooy | ||
|date = Mar 8th, 2015 | |date = Mar 8th, 2015 | ||
}}</ref> | }}</ref><ref>{{cite web |url=http://forum.flightgear.org/viewtopic.php?p=235634#p235634 | ||
|title=<nowiki>Re: FGRUN I think it's useful add it in a standard way</nowiki> | |||
|author=<nowiki>Hooray</nowiki> | |||
|date=<nowiki>Tue Mar 17</nowiki> | |||
}}</ref> At the time of writing (May 2016), however, it is still kept provisionally, and the user can choose whether to use the old or the new launcher. This is done for a variety of reasons: | |||
* FGRun has more functionality than the Qt launcher;<ref>{{cite web |url=http://forum.flightgear.org/viewtopic.php?p=235167#p235167 | |||
|title=<nowiki>Re: FGRUN I think it's useful add it in a standard way</nowiki> | |||
|author=<nowiki>wkitty42</nowiki> | |||
|date=<nowiki>Sat Mar 14</nowiki> | |||
}}</ref> | |||
* it is still being debated whether Qt will also be used for the internal FlightGear UI, and to what extent (especially because there is partial overlapping with the Canvas framework);<ref>{{cite web |url=http://forum.flightgear.org/viewtopic.php?p=235635#p235635 | |||
|title=<nowiki>Re: FGRUN I think it's useful add it in a standard way</nowiki> | |||
|author=<nowiki>hamzaalloush</nowiki> | |||
|date=<nowiki>Tue Mar 17</nowiki> | |||
}}</ref> | |||
* UI integration will take some time, due to the need for legacy code to be refactored;<ref>{{cite web |url=http://forum.flightgear.org/viewtopic.php?p=235646#p235646 | |||
|title=<nowiki>Re: FGRUN I think it's useful add it in a standard way</nowiki> | |||
|author=<nowiki>Hooray</nowiki> | |||
|date=<nowiki>Tue Mar 17</nowiki> | |||
}}</ref> | |||
* some building scripts still need to be updated.{{cite web |url=http://forum.flightgear.org/viewtopic.php?p=235217#p235217 | |||
|title=<nowiki>Re: FGRUN I think it's useful add it in a standard way</nowiki> | |||
|author=<nowiki>wkitty42</nowiki> | |||
|date=<nowiki>Sun Mar 15</nowiki> | |||
}}</ref> | |||
}} | |||
}} | |||
}} | |||
=== Python in FlightGear === | === Python in FlightGear === | ||
Line 434: | Line 358: | ||
}} | }} | ||
== | == Cross compiling using MingW64 == | ||
{{Main article|Building FlightGear - Cross Compiling}} | |||
<ref>{{cite web | As of May 2014, the dependency on Qt 5.1 makes it impossible to cross-compile the launcher using Mingw64, as the MXE project does not have makefiles for that version of QT.<ref>{{cite web |url=http://forum.flightgear.org/viewtopic.php?p=242914#p242914 | ||
|url | |title=<nowiki>Re: [SOLVED] Install osgEarth feature on Win7 64b with FG gi</nowiki> | ||
|title | |author=<nowiki>hamzaalloush</nowiki> | ||
|author = | |date=<nowiki>Thu May 14</nowiki> | ||
|date | |||
}}</ref> | }}</ref> | ||
== Community Feedback == | == Community Feedback == | ||
Line 491: | Line 381: | ||
| script_version = 0.23 | | script_version = 0.23 | ||
}} | }} | ||
}} | }} | ||
edits