Talk:FGCom-mumble

2020-11-23T16:47:45Z

Newo:

== Capitalize Mumble ==
Shouldn't Mumble be capitalized?
--[[User:Newo|Newo]] ([[User talk:Newo|talk]]) 11:47, 23 November 2020 (EST)

Talk:FGCom-mumble

2020-11-23T16:47:07Z

Newo:

Shouldn't Mumble be capitalized?
--[[User:Newo|Newo]] ([[User talk:Newo|talk]]) 11:47, 23 November 2020 (EST)

Talk:FGCom-mumble

2020-11-23T16:46:49Z

Newo: Created page with "Shouldn't Mumble be capitalized?"

Shouldn't Mumble be capitalized?

FGCom-mumble

2020-11-23T16:45:46Z

Newo: No space before "?"

'''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 leverages the plugin mechanism introduced by Mumble 1.4.0 and just needs a precompiled plugin loaded by a stock Mumble client.
You can download the latest release from https://github.com/hbeni/fgcom-mumble/releases.

{{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. I wrote a small guide on how to do that on debian/bullseye: https://github.com/hbeni/fgcom-mumble/wiki#compiling-mumble-140-plugin-branch-from-krzmbrzl-on-a-debian-testing-bullseye-system}}
{{note| This is currently in development and has no stable release for productive use yet. Expect lots of bugs! }}

{{Infobox Software
|title = FGCom-mumble
|logo = FGCom-mumble_logo.png|128px
|developedby = Benedikt Hallinger
|developmentstatus = Active
|type = Radio/Communication
|latestrelease = [https://github.com/hbeni/fgcom-mumble/releases see release page]
|initialrelease = 0.1.0-alpha (08.06.2020)
|writtenin = C++/Lua/Java/PHP
|os = Windows, GNU/Linux
|license = [[GNU General Public License]] v3
|website = https://github.com/hbeni/fgcom-mumble
}}

== Servers ==

* The main FGCom-mumble '''testserver''' is <code>mumble://fgcom.hallinger.org/fgcom-mumble</code>
* The status-page for that service showing all connected clients is: http://fgcom.hallinger.org/

== Project main goals ==
* Provide communication with geographic and channel separation
* Provide a realistic radio simulation
* Ease of use for the end user/pilot
* Arbitary frequency support
* ATIS recording and playback
* Radio station broadcast support
* Landline/Intercom support
* RDF detection for clients
* Ease of server side installation and operation
* 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)
* Modularity, so individual component implementations can be switched and its easy to add features
* Good and complete documentation

== Installation and setup ==
The latest release can be fetched from [https://github.com/hbeni/fgcom-mumble/releases GitHub].

The provided [https://github.com/hbeni/fgcom-mumble/blob/master/README.md Readme] has detailed instructions on the needed prerequisites and installation procedures.

In short:
* Have stock mumble client >= 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]
* 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? ===
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.

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 ===
For troubleshooting, refer to the projects [https://github.com/hbeni/fgcom-mumble/blob/master/README.md#troubleshooting Readme] as it has further suggestions.

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

* 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.
* [[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.
: There is a patched version of OpenRadar with FGCom-mumble and 8.33 channel tuning support available here: https://github.com/hbeni/openradar/releases/

== RadioGUI ==
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.

== 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):
* ATIS recording and broadcasting
* Status page data collection

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].

== Related content ==
=== Forum topic ===
* 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

=== FlightGear Newsletter ===
* [[FlightGear_Newsletter_June_2020]]: First prototype announced
* [[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_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_November_2020]]: Test server announced

== Screenshots ==
<gallery>
Fgcom-mumble_statuspage-0.6.0.png|Statuspage 0.6.0
FGCom-mumble_radioGUI-0.6.0.png|RadiGUI 0.6.0
</gallery>

[[Category:FGCom]]