13,208
edits
mNo edit summary |
(Copy editing) |
||
Line 1: | Line 1: | ||
''FGCom-mumble'' is a radio communication simulation for pilots and ATC, similar to FGCom but based on | '''FGCom-mumble''' is a radio communication simulation for pilots and ATC, similar to [[FGCom]] but based on Mumble. It can enhance your online flight experience with realistic voice communications. | ||
{{caution| The plugin relies on '''Mumble 1.4.0''' which is not yet released. | {{caution|The plugin relies on '''Mumble 1.4.0''' which is not yet released. | ||
To test FGCom-mumble, you thus need to self compile mumble and murmur.}} | |||
{{note| This is currently in development and has no stable release for productive use yet. Expect lots of bugs! }} | {{note| This is currently in development and has no stable release for productive use yet. Expect lots of bugs! }} | ||
Line 12: | Line 14: | ||
|initialrelease = 2020 | |initialrelease = 2020 | ||
|latestrelease = 0.6.0 (October, 2020) | |latestrelease = 0.6.0 (October, 2020) | ||
|writtenin = C++ | |writtenin = C++/Lua/Java/PHP | ||
|os = Windows, GNU/Linux | |os = Windows, GNU/Linux | ||
|license = [[GNU General Public License]] v3 | |license = [[GNU General Public License]] v3 | ||
Line 18: | Line 20: | ||
}} | }} | ||
= Servers = | == Servers == | ||
Currently there is no centralized infrastructure yet. If you want to donate one, please let me know! | Currently there is no centralized infrastructure yet. If you want to donate one, please let me know! | ||
<!-- | <!-- | ||
<TODO> Once we have infrastructure, list it here. | <TODO> Once we have infrastructure, list it here. | ||
Line 27: | Line 28: | ||
--> | --> | ||
= What is FGCom-mumble ? = | == What is FGCom-mumble? == | ||
FGCom-mumble is a voice communication feature that is based on the VoIP software | FGCom-mumble is a voice communication feature that is based on the VoIP software [https://www.mumble.info/ Mumble]. It simulates radio communication and integrates fully with the radio stack of your FlightGear plane, allowing you to communicate with other pilots and airspace controllers during your flight. It simulates a global, continuous radio frequency spectrum. | ||
FGCom-mumble is an alternative to the already known [[FGCom]] client. | FGCom-mumble is an alternative to the already known [[FGCom]] client. | ||
FGCom-mumble | FGCom-mumble facilitates the plugin mechanism introduced by Mumble 1.4.0 and just needs a precompiled plugin loaded. | ||
You can download the latest release from https://github.com/hbeni/fgcom-mumble/releases. | You can download the latest release from https://github.com/hbeni/fgcom-mumble/releases. | ||
=== Main goals === | |||
* Provide communication with geographic and channel separation | * Provide communication with geographic and channel separation | ||
* Provide a realistic radio simulation | * Provide a realistic radio simulation | ||
* Ease of use for the end user / pilot | * Ease of use for the end user/pilot | ||
* Arbitary frequency support | * Arbitary frequency support | ||
* ATIS recording and playback | * ATIS recording and playback | ||
Line 46: | Line 46: | ||
* RDF detection for clients | * RDF detection for clients | ||
* Ease of server side installation and operation | * Ease of server side installation and operation | ||
* Standalone nature (no dependency on | * Standalone nature (no dependency on FlightGear) | ||
* Capability to be integrated into | * Capability to be integrated into FlightGear, with the option to support third party applications (ATC, but also other flight simulators) | ||
* Modularity, so individual component implementations can be switched and its easy to add features | * Modularity, so individual component implementations can be switched and its easy to add features | ||
* Good and complete documentation | * Good and complete documentation | ||
= Installation and | == Installation and setup == | ||
The latest release can be fetched from [https://github.com/hbeni/fgcom-mumble/releases GitHub]. | The latest release can be fetched from [https://github.com/hbeni/fgcom-mumble/releases GitHub]. | ||
Line 58: | Line 58: | ||
In short: | In short: | ||
* Have mumble >= 1.4.0 running, and load the plugin | * Have mumble >= 1.4.0 running, and load the plugin | ||
* | * Join a channel named `fgcom-mumble` | ||
* Install the [https://github.com/hbeni/fgcom-mumble/blob/master/client/fgfs/Protocol/fgcom-mumble.xml fgfs protocol file] | * Install the [https://github.com/hbeni/fgcom-mumble/blob/master/client/fgfs/Protocol/fgcom-mumble.xml fgfs protocol file] | ||
* | * Start FlightGear with the new protocol file active (add to launcher: <code>--generic=socket,out,10,localhost,16661,udp,fgcom-mumble</code>) | ||
* | * Start using your planes radio stack (it uses default FGCom buttons, see below) | ||
== Usage == | |||
FlightGear's FGCom-mumble protocol uses the default FGCom buttons: | |||
When you want to talk on COM1 you have to press {{Key press|Space}}. While transmitting you can not hear other pilots trough the used radio (they are half-duplex). | |||
You can also talk on COM2 by pressing {{Key press|Shift|Space}}. | |||
If you want to try it out without FlightGear, you can also start the supplied RadioGUI. | |||
== How to test your setup ? == | === How to test your setup ? === | ||
First make sure, mumble is working reliably by talking to other persons. Either disable the plugin for that, or be sure you are outside any radio-activated channel (the ones starting with "fgcom-mumble"). | First make sure, mumble is working reliably by talking to other persons. Either disable the plugin for that, or be sure you are outside any radio-activated channel (the ones starting with "fgcom-mumble"). | ||
The plugin alters mumbles audio stream, it adds static noise depending on the radio signal quality, which even ma cancel out all voice when not in range. | The plugin alters mumbles audio stream, it adds static noise depending on the radio signal quality, which even ma cancel out all voice when not in range. | ||
If the server supports it ( | If the server supports it (in essence there is a bot-manager running and a fgcom-radio-bot listening) you may do a traditional echo test by tuning `910.00` and start to talk. The radio bot will record that and spawn an echo bot at your position, replaying your message. | ||
== Troubleshooting == | === Troubleshooting === | ||
For troubleshooting, refer to the projects [https://github.com/hbeni/fgcom-mumble/blob/master/README.md#troubleshooting Readme] as it has | For troubleshooting, refer to the projects [https://github.com/hbeni/fgcom-mumble/blob/master/README.md#troubleshooting Readme] as it has further suggestions. | ||
== Compatibility == | === Compatibility === | ||
FGCom-mumble supports the legacy FGCom UDP protocol and thus should be compatible to clients supporting that. However, it also features some new UDP fields. | FGCom-mumble supports the legacy FGCom UDP protocol and thus should be compatible to clients supporting that. However, it also features some new UDP fields. | ||
* | * FlightGear is supported trough a new [https://github.com/hbeni/fgcom-mumble/blob/master/client/fgfs/Protocol/fgcom-mumble.xml XML-Protocol file]. This assumes the default radio implementation and works at least with the c172p and the c182s. | ||
* [[ATC-pie]] has built in support already. | * [[ATC-pie]] has built in support already. | ||
* [[OpenRadar]] currently supports just COM1 ([https://sourceforge.net/p/openradar/tickets/5/ ticket pending]). To use COM2 and more, you need to either start several mumble instances, or use FGCom-mumbles RadioGUI. | * [[OpenRadar]] currently supports just COM1 ([https://sourceforge.net/p/openradar/tickets/5/ ticket pending]). To use COM2 and more, you need to either start several mumble instances, or use FGCom-mumbles RadioGUI. | ||
= RadioGUI = | == RadioGUI == | ||
The FGCom-RadioGUI is a small Java-11 application that can send the FGCom-mumble UDP messages to the mumble plugin. | The FGCom-RadioGUI is a small Java-11 application that can send the FGCom-mumble UDP messages to the mumble plugin. | ||
Inside the GUI, you can pick your location from a map and then setup your radio stack. | Inside the GUI, you can pick your location from a map and then setup your radio stack. | ||
== Server side == | |||
By design, all that is needed is a standard Murmur server (version 1.4.0 or later) and a specially named channel (it has to start with "fgcom-mumble"). This is enough to let the plugin do its work. The entire channel is treated as a single, world wide continuous radio frequency spectrum. | |||
Additional features are implemented using server side Lua bots (which may run somewhere else): | |||
Additional features are implemented using server side | |||
* ATIS recording and broadcasting | * ATIS recording and broadcasting | ||
* Status page data collection | * Status page data collection | ||
A | A status page showing client details is available as a PHP website, that gets its data fed from the fgcom-status-bot. | ||
Detailed installation and operation documentation is shipped with the releases, but also [https://github.com/hbeni/fgcom-mumble/blob/master/server/Readme.server.md online]. | Detailed installation and operation documentation is shipped with the releases, but also [https://github.com/hbeni/fgcom-mumble/blob/master/server/Readme.server.md online]. | ||
== Related content == | |||
=== Forum topic === | |||
= Related content = | |||
== Forum topic == | |||
* The {{forum link|t=37644|title=FGCom-mumble}} has development discussions and release announcements | * The {{forum link|t=37644|title=FGCom-mumble}} has development discussions and release announcements | ||
== FlightGear Newsletter == | === FlightGear Newsletter === | ||
* [[FlightGear_Newsletter_June_2020]]: First prototype announced | * [[FlightGear_Newsletter_June_2020]]: First prototype announced | ||
* [[FlightGear_Newsletter_July_2020]]: Load tests successful, RDF implemented, Live-Status page added | * [[FlightGear_Newsletter_July_2020]]: Load tests successful, RDF implemented, Live-Status page added | ||
Line 118: | Line 114: | ||
* [[FlightGear_Newsletter_October_2020]]: More API changes, proper 8.33kHz/25kHz overlap, RadiGUI added | * [[FlightGear_Newsletter_October_2020]]: More API changes, proper 8.33kHz/25kHz overlap, RadiGUI added | ||
= Screenshots = | == Screenshots == | ||
<gallery> | <gallery> | ||
Fgcom-mumble_statuspage-0.6.0.png|Statuspage 0.6.0 | Fgcom-mumble_statuspage-0.6.0.png|Statuspage 0.6.0 | ||
FGCom-mumble_radioGUI-0.6.0.png|RadiGUI 0.6.0 | FGCom-mumble_radioGUI-0.6.0.png|RadiGUI 0.6.0 | ||
</gallery> | </gallery> | ||
[[Category:FGCom]] | [[Category:FGCom]] | ||