FGCom-mumble: Difference between revisions

Jump to navigation Jump to search
Tags: Mobile edit Mobile web edit
Tags: Mobile edit Mobile web edit
Line 1: Line 1:
'''FGCom-mumble''' simulates radio communication based on the VoIP software [https://www.mumble.info/ Mumble]. It 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''' simulates radio communication based on the VoIP software [https://www.mumble.info/ Mumble]. It 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 and [https://forum.flightgear.org/viewtopic.php?t=30691 FGExtend].


FGCom-mumble leverages the plugin mechanism introduced by Mumble 1.4.0 and just needs a precompiled plugin loaded by a stock Mumble client.
FGCom-mumble leverages the plugin mechanism introduced by Mumble 1.4.0 and just needs a precompiled plugin loaded by a stock Mumble client.
Line 26: Line 26:
}}
}}


== Servers ==
==Servers ==
<!-- Maybe we can switch to mumble://radio-mumble.flightgear.fr/fgcom-mumble some time... -->
<!-- Maybe we can switch to mumble://radio-mumble.flightgear.fr/fgcom-mumble some time... -->
* The main FGCom-mumble test server is <code>mumble://fgcom.hallinger.org/fgcom-mumble</code>
*The main FGCom-mumble test server is <code>mumble://fgcom.hallinger.org/fgcom-mumble</code>
* The status page for that service showing all connected clients is at: http://fgcom.hallinger.org/
*The status page for that service showing all connected clients is at: http://fgcom.hallinger.org/


== Project main goals ==
==Project 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
* Arbitrary frequency support
*Arbitrary frequency support
* ATIS recording and playback
*ATIS recording and playback
* Radio station broadcast support
*Radio station broadcast support
* Landline/Intercom support
*Landline/Intercom support
* 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 FlightGear)
*Standalone nature (no dependency on FlightGear)
* Capability to be integrated into FlightGear, with the option to support third party applications (ATC, but also other flight simulators)
* 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 setup ==
== Installation and setup==
The latest release can be fetched from [https://github.com/hbeni/fgcom-mumble/releases GitHub] ([https://github.com/hbeni/fgcom-mumble/actions nightly build] also has debug versions).
The latest release can be fetched from [https://github.com/hbeni/fgcom-mumble/releases GitHub] ([https://github.com/hbeni/fgcom-mumble/actions nightly build] also has debug versions).


Line 52: Line 52:


In short:
In short:
* Have a stock Mumble client >= 1.4.0 running, and load the plugin (mumble settings/plugins page)
*Have a stock Mumble client >= 1.4.0 running, and load the plugin (mumble settings/plugins page)
* Join a channel named `fgcom-mumble`
*Join a channel named `fgcom-mumble`
* Add the `fgfs-addon` folder of the client release as FlightGear Addon in your launcher
*Add the `fgfs-addon` folder of the client release as FlightGear Addon in your launcher
* Start FlightGear and use your plane's radio stack (it uses default FGCom buttons, see below)
* Start FlightGear and use your plane's radio stack (it uses default FGCom buttons, see below)


== Usage ==
==Usage==
FlightGear's FGCom-mumble protocol uses the default FGCom buttons:
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).
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).
Line 65: Line 65:
If you want to try it out without FlightGear, you can also start the supplied RadioGUI.
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 people. Either disable the plugin, or be sure you are outside any radio channel (starting with `fgcom-mumble`).
First, make sure Mumble is working reliably by talking to other people. Either disable the plugin, or be sure you are outside any radio channel (starting with `fgcom-mumble`).


Line 72: Line 72:
If the server supports it (in essence there is a bot-manager running and a `fgcom-recorder-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.
If the server supports it (in essence there is a bot-manager running and a `fgcom-recorder-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 further suggestions.
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 through an [https://github.com/hbeni/fgcom-mumble/tree/master/client/fgfs-addon FlightGear addon]. This assumes the default radio implementation and works with at least the C172P and the C182S.
*FlightGear is supported through an [https://github.com/hbeni/fgcom-mumble/tree/master/client/fgfs-addon FlightGear addon]. This assumes the default radio implementation and works with at least the C172P and the C182S.
* [[ATC-pie]] has built in support already (be sure to activate "FGCom-mumble" instead of just "FGCom" in the settings).
*[[ATC-pie]] has built in support already (be sure to activate "FGCom-mumble" instead of just "FGCom" in the settings).
* [[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-mumble's 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-mumble's RadioGUI.
: There is a patched version of OpenRadar with FGCom-mumble and  8.33 channel tuning support available here: http://fgcom.hallinger.org/OpenRadar_fgcom-mumble.jar
:There is a patched version of OpenRadar with FGCom-mumble and  8.33 channel tuning support available here: http://fgcom.hallinger.org/OpenRadar_fgcom-mumble.jar


==== Known incompatibilities ====
====Known incompatibilities====
* The UFO aircraft rebinds {{Key press|Space}} so you can't transmit on the radio.
* The UFO aircraft rebinds {{Key press|Space}} so you can't transmit on the radio.


== RadioGUI ==
==RadioGUI==
The FGCom-mumble RadioGUI is a small Java 8 application that can send the FGCom-mumble UDP messages to the Mumble plugin.
The FGCom-mumble RadioGUI is a small Java 8 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 and use your radio stack.
Inside the GUI, you can pick your location from a map and then setup and use your radio stack.


== Server side ==
==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, worldwide continuous radio frequency spectrum.
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, worldwide 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 Lua bots (which may run somewhere else):
* ATIS recording and broadcasting
*ATIS recording and broadcasting
* Status page data collection
* Status page data collection


Line 102: Line 102:
Detailed installation and operation documentation is shipped with the releases, but is 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 is also [https://github.com/hbeni/fgcom-mumble/blob/master/server/Readme.server.md online].


== Related content ==
==Related content==
* [https://github.com/hbeni/fgcom-mumble/wiki FGCom-mumble GitHub wiki] with hints etc
*[https://github.com/hbeni/fgcom-mumble/wiki FGCom-mumble GitHub wiki] with hints etc


=== Forum topic ===
===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
* {{forum link|p=374950|title=Re: EDDF-Triangle}} and  {{forum link|p=374970|title=Re: EDDF-Triangle}} - Compatibility and differences between FGCom, FGCom-mumble and Mumble
*{{forum link|p=374950|title=Re: EDDF-Triangle}} and  {{forum link|p=374970|title=Re: EDDF-Triangle}} - Compatibility and differences between FGCom, FGCom-mumble and Mumble


=== 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
* [[FlightGear_Newsletter_August_2020]]: More testing, new HF/VHF/UHF models, auto-updater
*[[FlightGear_Newsletter_August_2020]]: More testing, new HF/VHF/UHF models, auto-updater
* [[FlightGear_Newsletter_September_2020]]: Mumble API changes, distributed deployment, configuration trough INI, statistics
*[[FlightGear_Newsletter_September_2020]]: Mumble API changes, distributed deployment, configuration trough INI, statistics
* [[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
* [[FlightGear_Newsletter_November_2020]]: Test server announced
*[[FlightGear_Newsletter_November_2020]]: Test server announced
* [[FlightGear_Newsletter_December_2020]]: Release 0.8.0 bringing networking capability
*[[FlightGear_Newsletter_December_2020]]: Release 0.8.0 bringing networking capability
* [[FlightGear_Newsletter_April_2021]]: RDF reworked, 0.12.0 announced, MacOS support
*[[FlightGear_Newsletter_April_2021]]: RDF reworked, 0.12.0 announced, MacOS support
* [[FlightGear_Newsletter_May_2021]]: Better airliner support, announced 0.13.0 and 0.14.0, restructured release package structure
*[[FlightGear_Newsletter_May_2021]]: Better airliner support, announced 0.13.0 and 0.14.0, restructured release package structure
* [[FlightGear_Newsletter_June_2021]]: 0.14.1 announced, updater bugfixes
*[[FlightGear_Newsletter_June_2021]]: 0.14.1 announced, updater bugfixes


== 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
601

edits

Navigation menu