652
edits
m (1st part of restructuring due to now 3 Parts: FGCOM, FGCOM for WIndows, FGCOM_Testing) |
|||
Line 2: | Line 2: | ||
'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind it), FlightGear now has a realtime voice communication system which enriches the FlightGear capabilities, especially for Multiplayer events, like: | '''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind it), FlightGear now has a realtime voice communication system which enriches the FlightGear capabilities, especially for Multiplayer events, like: | ||
*flying in groups (see e.g. the '''Forum Multiplayer Events'''): | *flying in groups (see e.g. the '''Forum Multiplayer Events''' on http://www.flightgear.org/forums/): | ||
**invite friends to a guided sightseeing tour in your most beloved area or do “Fly In's” | **invite friends to a guided sightseeing tour in your most beloved area or do “Fly In's” | ||
**do military training like [[Howto: Air-Air Refueling|“Air-Air-Refuelling”]], “Dog fights”, “Escort flights”, etc. | **do military training like [[Howto: Air-Air Refueling|“Air-Air-Refuelling”]], “Dog fights”, “Escort flights”, etc. | ||
*offering additional services at an airport like [[Air traffic control|ATC]], [[Vehicle|Snowplows, Pushbacks]], [[FlightGear Race|Racing-Events]] etc. | *offering additional services at an airport like [[Air traffic control|ATC]], [[Vehicle|Snowplows, Pushbacks]], [[FlightGear Race|Racing-Events]] etc. | ||
*have a [[Dual control|real time flighttraing]] (e.g. pilot in Hongkong, teacher in Sydney) or do [[Soaring|Glider-towing]] or just ask for on-line support during flight or just ask somebody flying a plane of interest about specifics | *have a [[Dual control|real time flighttraing]] (e.g. pilot in Hongkong, teacher in Sydney) or do [[Soaring|Glider-towing]] or just ask for on-line support during flight or just ask somebody flying a plane of interest about specifics | ||
*or e.g. just sit in a cockpit | *or e.g. just sit in a cockpit in Germany while sightseeing San Francisco in a C172, voice-chatting with a Texan in a plane I dreamed of as a boy (Super Constellation), and both getting informations from a New Zealand guy (it shall be a wonderful island – but do real people live there? He said: Yes!!). | ||
*etc. | *etc. | ||
You can even use it in models without radios - just use the standard FlightGear menu --> Equipment --> Radio Settings.<br> | You can even use it in models without radios - just use the standard FlightGear menu --> Equipment --> Radio Settings.<br> | ||
Line 13: | Line 13: | ||
In the future FGCom surely will extend further and surely will get a “Speech to Text” capability in order to also integrate the Text-based automated ATC-routines inside FlightGear. | In the future FGCom surely will extend further and surely will get a “Speech to Text” capability in order to also integrate the Text-based automated ATC-routines inside FlightGear. | ||
<br><br> | |||
=='''The Client installation'''== | |||
===Prequisites=== | |||
=== | |||
====Hardware Requirements==== | ====Hardware Requirements==== | ||
If you are satisfied with the operation and responsetimes of your current FGFS installation, then you should see no significant difference after adding the FGCom. If your FGFS installation runs already a little marginal, then you might experience some delays when many new airplane-models etc. must be loaded. This may happen when starting up at a busy airport. You can monitor/verify such a "short-time overload" in the | If you are satisfied with the operation and responsetimes of your current FGFS installation, then you should see no significant difference after adding the FGCom. If your FGFS installation runs already a little marginal, then you might experience some delays when many new airplane-models etc. must be loaded. This may happen when starting up at a busy airport. You can monitor/verify such a "short-time overload" in the FGFS command-window. | ||
For details see the FGFS common hardware and driver requirements on http://www.flightgear.org/hardwarereq.html | For details see the FGFS common hardware and driver requirements on http://www.flightgear.org/hardwarereq.html | ||
Line 42: | Line 23: | ||
Of course you will also need a connection to the Internet for worldwide voice communication to work. | Of course you will also need a connection to the Internet for worldwide voice communication to work. | ||
==== | <br> | ||
====Software Requirements==== | |||
{| style="width:75%" border="1" | {| style="width:75%" border="1" | ||
|+ | |+ | ||
|- | |- | ||
|align="center" width="100" |'''FGFS''' ||The basic Flight-Gear-Flight-Simulation installation. This must be installed prior to installing the FGCom ''(except if installing the Linux "CVS complete" version which can install FGCom and FGFS concurrently)''. ref.: http://www.flightgear.org/ | |align="center" width="100" |'''FGFS''' ||The basic Flight-Gear-Flight-Simulation installation. This must be installed prior to installing the FGCom ''(except if installing the Linux "CVS complete" version which can install FGCom and FGFS concurrently)''. | ||
ref.: http://www.flightgear.org/ | |||
|- | |||
|align="center" |'''Multiplayer'''||[[Howto: Multiplayer|“Multiplayer”]] is not an installable program but an integrated function of the FGFS. As the name says, it enables communication of several players via a chat-function (keyboard) - or with this vocal interface ==> FGCom. | |||
|} | |||
<br> | |||
====Nice to have==== | |||
{| style="width:75%" border="1" | |||
|+ | |||
|- | |- | ||
|align="center" | '''FGrun'''||This [[FlightGear Launch Control]] (also known as FG-Wizard), is a graphical front end to start the FGFS. This makes it very easy to startup the FGFS with all it's possible options. In some newer distributions this is already part of the basic FGFS installation package | |align="center" | '''FGrun'''||This [[FlightGear Launch Control]] (also known as FG-Wizard), is a graphical front end to start the FGFS. This makes it very easy to startup the FGFS with all it's possible options. In some newer distributions this is already part of the basic FGFS installation package | ||
|- | |- | ||
|align="center" |''' | |align="center" |'''MPMap'''||[[MPMap]] is a pure browser application based on Google Maps, so it does not need any installation, except a Web-Browser. With MPMap you can watch all Multiuser-planes worldwide on a road-map, satellite picture or a composite of both. It includes most of the airports, navigational aids, and current weather informations. So it can be used for preflight planning, without having the FGFS started or even installed. But it needs a constant connection to the INTERNET - on the other hand you can do your preflight planning anywhere where there is a PC, connected to the INTERNET. | ||
|- | |- | ||
|align="center" |''' | |align="center" |'''Runwayfinder'''||This standalone Browser-Application( http://www.runwayfinder.com ) does present a fantastic Fight-Planning tool, showing similar aspects like the "MPMap" but adds an Aeronatical map. It does not link to FGFS or MPMap or Multiplayer -- and covers only the domestic USA. | ||
|- | |- | ||
|align="center" |''' | |align="center" |'''Atlas'''||[[Atlas]] displays the current position of your airplane on an landscape type of map together with navigational informations. It derives its data direct out of the installed FGFS databases. So you do not need any connections to the INTERNET. | ||
|- | |- | ||
|align="center" |'''Festival'''||Festival is a TTS (Text To Speech) system that can convert all in the FGFS displayed written text (ATC, Chat, etc.) into speech and put it on your loudspeakers. ref.: http://www.flightgear.org/Docs/getstart/getstartch5.html#x10-790005.6 | |align="center" |'''Festival'''||Festival is a TTS (Text To Speech) system that can convert all in the FGFS displayed written text (ATC, Chat, etc.) into speech and put it on your loudspeakers. ref.: http://www.flightgear.org/Docs/getstart/getstartch5.html#x10-790005.6 | ||
|} | |} | ||
<br> | |||
===Installing FGCom=== | |||
====Install on Linux==== | ====Install on Linux==== | ||
For Linux-Systems there are 3 ways to install: | For Linux-Systems there are 3 ways to install: | ||
Line 68: | Line 57: | ||
*'''Disadvantage:''' The availability of those packages is usually very late and most Distributors do not cover all FGFS-features. To our knowledge none of the Distributors has an FGCom package available as of March 2009. | *'''Disadvantage:''' The availability of those packages is usually very late and most Distributors do not cover all FGFS-features. To our knowledge none of the Distributors has an FGCom package available as of March 2009. | ||
*'''Installation:''' Follow the usual procedures of your distributer on how to install additional packages. | *'''Installation:''' Follow the usual procedures of your distributer on how to install additional packages. | ||
<br> | |||
'''2) Installing a “CVS complete”''' | '''2) Installing a “CVS complete”''' | ||
*'''Advantage:''' It is the very easiest form of installation and installs in one step all prerequisite/companion modules (FGFS, FGrun, FGcom, PLIB, OSG, Simgear, AT). Also it can be added and removed from the system without disturbing the rest of the system (Libraries, Menus, Structures, etc.). It was tested on several Ubuntu and Debian systems. | *'''Advantage:''' It is the very easiest form of installation and installs in one step all prerequisite/companion modules (FGFS, FGrun, FGcom, PLIB, OSG, Simgear, AT). Also it can be added and removed from the system without disturbing the rest of the system (Libraries, Menus, Structures, etc.). It was tested on several Ubuntu and Debian systems. | ||
*'''Disadvantage:''' No automated maintenance available. The handling is a little different from the standard Menu-driven practice. | *'''Disadvantage:''' No automated maintenance available. The handling is a little different from the standard Menu-driven practice. | ||
*'''Installation:''' http://wiki.flightgear.org/index.php/Scripted_Compilation_on_Linux_Debian/Ubuntu | *'''Installation:''' http://wiki.flightgear.org/index.php/Scripted_Compilation_on_Linux_Debian/Ubuntu | ||
<br> | |||
'''3) Compiling it locally''' | '''3) Compiling it locally''' | ||
*'''Advantage:''' After a successful installation it is integrated into the system like a package from the distributor. | *'''Advantage:''' After a successful installation it is integrated into the system like a package from the distributor. | ||
Line 105: | Line 96: | ||
make install | make install | ||
</li><br><li> | </li><br><li> | ||
continue with [[FGCOM#Test the basic function|testing the basic functions]] | continue with chapter [[FGCOM#Test the basic function|testing the basic functions]] | ||
</li></ol> | </li></ol> | ||
<br> | |||
====Install on Windows==== | ====Install on Windows==== | ||
Please use the Windows-Installation description on http://wiki.flightgear.org/index.php/FGCOM_for_Windows | |||
<br> | |||
====Install on Mac==== | ====Install on Mac==== | ||
You can download the "MAC OSX Binary" from the FGFS download-center ( http://www.flightgear.org/Downloads/binary.shtml#mac ). The current version of the code does contain the FGCOM. | You can download the "MAC OSX Binary" from the FGFS download-center ( http://www.flightgear.org/Downloads/binary.shtml#mac ). The current version of the code does contain the FGCOM. | ||
Line 122: | Line 109: | ||
But '''you do need OS X 10.5''' as prerequisite. With lower versions you will end up with a generic "bus error" message! | But '''you do need OS X 10.5''' as prerequisite. With lower versions you will end up with a generic "bus error" message! | ||
<br> | |||
===Testing=== | ===Testing=== | ||
During testing we will | |||
#test the basic FGCOM-functions without the FGFS | |||
#after that the FGCOM together with the FGFS | |||
#then test/adjust the Microphone and Loudspeaker | |||
For these tests please see the [[FGCOM_Testing|FGCOM_Testing]] | |||
<br> | |||
===Functional Test + User Briefing=== | |||
<br | |||
Experiences pointed out, that the cooperation FGCom/FGFS works more reliable, if the FGFS gets started first. So we will start with setting up a flight-test-environment: | Experiences pointed out, that the cooperation FGCom/FGFS works more reliable, if the FGFS gets started first. So we will start with setting up a flight-test-environment: | ||
====Start the FGFS==== | |||
We suggest to use the FGrun ([[FlightGear Launch Control]]) to define required and/or proposed settings, in order to avoid typo-errors etc. If you keep the “Show command line” active (compare item 3 following), you also get the correct writing for all the command-options (in case you later want to start from a command-line and/or out of a script). In the following we will just point out those commands which are significant for the FGCom-operation: | We suggest to use the FGrun ([[FlightGear Launch Control]]) to define required and/or proposed settings, in order to avoid typo-errors etc. If you keep the “Show command line” active (compare item 3 following), you also get the correct writing for all the command-options (in case you later want to start from a command-line and/or out of a script). In the following we will just point out those commands which are significant for the FGCom-operation: | ||
Line 386: | Line 269: | ||
Hit “OK” → “Run” and watch the FGFS starting. If screen-place allows you may want to pull the shown "FGFS Report-Window" to the side and watch how busy your PC is while loading the other multi-player models.<br> | Hit “OK” → “Run” and watch the FGFS starting. If screen-place allows you may want to pull the shown "FGFS Report-Window" to the side and watch how busy your PC is while loading the other multi-player models.<br> | ||
====Start the FGCom==== | |||
Open a [[Command line|command-window]] and change into the directory in which FGCom was installed (probably the same as the FGFS) and start the FGCom. Do not use any other options than the server address “-sfgcom.flightgear.org.uk”: | Open a [[Command line|command-window]] and change into the directory in which FGCom was installed (probably the same as the FGFS) and start the FGCom. Do not use any other options than the server address “-sfgcom.flightgear.org.uk”: | ||
{|border="1" | {|border="1" | ||
Line 528: | Line 411: | ||
10) You could turn now and watch the opposite: At about the same distance those two will become active again (automatically, if you did not change the settings). | 10) You could turn now and watch the opposite: At about the same distance those two will become active again (automatically, if you did not change the settings). | ||
<br><br> | <br><br> | ||
If you got here without any (technical) problems your FGCom is fully functional. | If you got here without any (technical) problems your FGCom is fully functional. Have fun when using it. | ||
<br> | |||
===Using FGCom=== | ===Using FGCom=== | ||
There are basically 3 types of FGCOM-usage: (ref. the introduction to this wiki-page]]): | There are basically 3 types of FGCOM-usage: (ref. the introduction to this wiki-page]]): | ||
Line 543: | Line 420: | ||
*Finally you can manipulate the frequency-tables (positions.txt in your FGFS/FGCOM local directory) and define an own frequency for special events. e.g. a Flight-School at one airport with maybe multiple student-groups. Of course those are local manipulations on your own PC, which you have to agree on with your (planned to be) partners in advance. | *Finally you can manipulate the frequency-tables (positions.txt in your FGFS/FGCOM local directory) and define an own frequency for special events. e.g. a Flight-School at one airport with maybe multiple student-groups. Of course those are local manipulations on your own PC, which you have to agree on with your (planned to be) partners in advance. | ||
<br> | |||
===Supplemantery Informations=== | ===Supplemantery Informations=== | ||
====Tips and Tricks==== | ====Tips and Tricks==== | ||
Line 749: | Line 627: | ||
Also note that the current server (fgcom.flightgear.co.uk) works with guest account, so '''do not use -U or -P''' | Also note that the current server (fgcom.flightgear.co.uk) works with guest account, so '''do not use -U or -P''' | ||
==Server installation== | <br><br> | ||
=='''Server installation'''== | |||
For running a FGCOM server you need Asterisk and depending on the amount of users much bandwith and CPU power. Because of putting pilots and ATCs in a VoIP conference the server-admin has to assure that there is enough network and cpu power to avoid drop-outs of the voice stream. | For running a FGCOM server you need Asterisk and depending on the amount of users much bandwith and CPU power. Because of putting pilots and ATCs in a VoIP conference the server-admin has to assure that there is enough network and cpu power to avoid drop-outs of the voice stream. | ||
Line 907: | Line 786: | ||
If you have problems you can contact me via email at "dcoredump AT gmail.com". | If you have problems you can contact me via email at "dcoredump AT gmail.com". | ||
==External links== | <br><br> | ||
=='''External links'''== | |||
* [http://squonk.abacab.org/dokuwiki/fgcom Old Official website] | * [http://squonk.abacab.org/dokuwiki/fgcom Old Official website] | ||
* [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual] | * [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual] | ||
* [http://sourceforge.net/projects/fgcom/ fgcom(SourceForge-Project)] | * [http://sourceforge.net/projects/fgcom/ fgcom(SourceForge-Project)] | ||
<br><br> | |||
==Development== | ==Development== | ||
TODO | TODO | ||
<br><br> | |||
=='''Status'''== | |||
*'''March, 2009:''' | |||
Adding User-Informations for installing, using, maintaining FGCOM on different platforms. | |||
*'''18 November, 2008:''' | |||
Latest SVN (rev 163) has the compile problems fixed. Also we have a '''new server: fgcom.flightgear.org.uk'''. User accounts not required (ie. do '''not''' use -U or -P) | |||
*'''31 October, 2008:''' | |||
==See also== | The latest SVN release at this time is the '''r149''' which does not compile due to a constant that is not defined (STL_STRING). Such constant appears at line 57 in the file ''src/fgcom_init.cpp'' which is: | ||
''#include STL_STRING'' | |||
I guess that such constant must point to the STL library include file but I am not sure. | |||
I revert to the '''r148''' SVN version which successfully compiles. | |||
Command to get such version is: ''svn co -r148 svn://svn.dfn.de:/fgcom/trunk fgcom-r148'' | |||
* '''19 June, 2008:''' Currently the server is <u>down</u> due to hardware problems. It is unknown when the service comes back because he currently has no time to fix the problems. | |||
* '''22 November 2007:''' Due to heavy development at this time there may be some differences between the information on the web pages and the installation. Please follow the discussions on the FlightGear development list! | |||
<br><br> | |||
=='''See also'''== | |||
*[[FlightGear related projects]] | *[[FlightGear related projects]] | ||
[[Category:Software]] | [[Category:Software]] |
edits