Difference between revisions of "FGCom-mumble"

From FlightGear wiki
Jump to: navigation, search
m (Hbeni moved page User:Hbeni/FGCom-mumble to FGCom-mumble: First draft ready for takeoff)
m
Line 2: Line 2:
  
 
{{caution| The plugin relies on '''Mumble 1.4.0''' which is not yet released.<br>To test FGCom-mumble, you thus need to self compile mumble and murmur. }}
 
{{caution| The plugin relies on '''Mumble 1.4.0''' which is not yet released.<br>To test FGCom-mumble, you thus need to self compile mumble and murmur. }}
{{caution| 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! }}
  
 
{{Infobox Software
 
{{Infobox Software

Revision as of 06:36, 5 October 2020

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.
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!
FGCom-mumble
FGCom-mumble logo
Developed by Benedikt Hallinger
Initial release 2020
Latest release 0.6.0 (October, 2020)
Written in C++, Java, Lua, PHP
OS Windows, GNU/Linux
Development status Active
License GNU General Public License v3
Website

Servers

Currently there is no centralized infrastructure yet. If you want to donate one, please let me know!


What is FGCom-mumble ?

FGCom-mumble is a voice communication feature that is based on the VoIP software 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 faciliates 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.


The projects main goals are:

  • 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 flightsims)
  • Modularity, so individual component implementations can be switched and its easy to add features
  • Good and complete documentation

Installation and Setup

The provided Readme has detailed instructions on the needed prerequisites and installation procedures.

In short:

  • Have mumble >= 1.4.0 running, and load the plugin
  • join a channel named `fgcom-mumble`
  • Install the fgfs protocol file
  • start flightgear with the new protocol file active (add to launcher: `--generic=socket,out,10,localhost,16661,udp,fgcom-mumble`)
  • start using your planes radio stack (it uses default FGCom buttons, see below)


Usage

Flightgears FGCom-mumble protocol uses the default FGCom buttons: When you want to talk on COM1 you have to press Space. While transmtting you can't hear other pilots trough the used radio (they are half-duplex). You can also talk on COM2 by pressing 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 (ie. 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 Readme as it has furter 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 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 (ticket pending). To use COM2 and more, you need to either start several mumble instances, or use FGCom-mumbles RadioGUI.

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 >= 1.4.0 server 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 statuspage showing client details is available as a PHP website, that gets its data feeded from the fgcom-status-bot.

Detailed installation and operation documentation is shipped with the releases, but also online.


Related content

Forum topic

FlightGear Newsletter

Screenshots