FGCom (before 3.0): Difference between revisions

Jump to navigation Jump to search
Switch to {{gitorious url}} and {{fgmeta url}} to fix the broken Gitorious links. This required a switch from <div> and <table> tags to <syntaxhighlight>.
(→‎Start FGCom: Review and add the new FS 3.0 to come)
(Switch to {{gitorious url}} and {{fgmeta url}} to fix the broken Gitorious links. This required a switch from <div> and <table> tags to <syntaxhighlight>.)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{cleanup}}
{{historical
| type  = article
| tense  = is
| text  = obsolete
| reason = The new version of FGCom is much more simple to use and a clean documentation is available at [[FGCom 3.0]]
| talk  =
| date  = 1 January 2015
| nocat  =
}}


{{Infobox Software
{{Infobox Software
Line 16: Line 24:
| type                  =  
| type                  =  
| license                = [[GNU General Public License]]
| license                = [[GNU General Public License]]
| website                = http://sourceforge.net/projects/fgcom/
| website                = {{gitorious url|fg|fgcom}}
}}
}}
'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind it), FlightGear has a realtime voice communication system which enriches the FlightGear capabilities, especially for [[Howto: Multiplayer|multiplayer]] events, like:
'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind it), FlightGear has a realtime voice communication system which enriches the FlightGear capabilities, especially for [[Howto: Multiplayer|multiplayer]] events, like:


Line 75: Line 84:
#*:: and unzip it into a directory of your choice
#*:: and unzip it into a directory of your choice
#*:: then you start fgcom in a terminal like:
#*:: then you start fgcom in a terminal like:
<div>
::::<syntaxhighlight lang="sh>
::::<table>
cd /home/YourName/fgfs/bin  
<tr><pre>
cd '/home/YourName/fgfs/bin  
./fgcom
./fgcom
</pre></tr></table></div>
</syntaxhighlight>
# '''Downloading from the “Distributor” (Debian, Ubuntu, Red Hat, Suse, etc.).'''  
# '''Downloading from the “Distributor” (Debian, Ubuntu, Red Hat, Suse, etc.).'''  
#* '''Advantage:''' This is the easiest way and ensures that maintenance and services for this package and all concurrencies to it are provided automatically for a reasonable time-frame.
#* '''Advantage:''' This is the easiest way and ensures that maintenance and services for this package and all concurrencies to it are provided automatically for a reasonable time-frame.
Line 89: Line 96:
#* '''Disadvantage:''' No automated maintenance available. The handling is a little different from the standard Menu-driven practices.
#* '''Disadvantage:''' No automated maintenance available. The handling is a little different from the standard Menu-driven practices.
#* '''Installation:''' use the [[Scripted Compilation on Linux Debian/Ubuntu]]
#* '''Installation:''' use the [[Scripted Compilation on Linux Debian/Ubuntu]]
<div>
::{{#tag:syntaxhighlight|
::<table>
<tr><pre>
mkdir fgcom
mkdir fgcom
cd fgcom
cd fgcom
wget http://www.gitorious.org/fg/fgmeta/raw/download_and_compile.sh
wget {{fgmeta url|download_and_compile.sh}}
chmod +x ./download_and_compile.sh  
chmod +x ./download_and_compile.sh  
./download_and_compile.sh PLIB FGCOM
./download_and_compile.sh PLIB FGCOM
</pre></tr>
| lang = "sh"
}}
... it will ask 2 x for the root password
... it will ask 2 x for the root password
then it looks like this:
then it looks like this:
<tr><pre>
::<syntaxhighlight lang="sh">
[ 95%] Building CXX object CMakeFiles/fgcom.dir/src/fgcom.cpp.o
[ 95%] Building CXX object CMakeFiles/fgcom.dir/src/fgcom.cpp.o
[ 97%] Building CXX object CMakeFiles/fgcom.dir/src/fgcom_init.cpp.o
[ 97%] Building CXX object CMakeFiles/fgcom.dir/src/fgcom_init.cpp.o
Line 116: Line 122:
Usage: ./download_and_compile.sh -h
Usage: ./download_and_compile.sh -h
for help
for help
</pre></tr>
</syntaxhighlight>
then you can start fgcom like this:
then you can start fgcom like this:
<tr><pre>
::<syntaxhighlight lang="sh">
./run_fgcom.sh -Sdelta384.server4you.de
./run_fgcom.sh -Sfgcom.flightgear.org
</pre></tr>
</syntaxhighlight>
</table></div>
 
<br>
==== Install on Mac ====
==== Install on Mac ====
# '''MacFlightGear 1.9.1/2.0.0'''<br />
# '''MacFlightGear 1.9.1/2.0.0'''<br />
Line 130: Line 135:
#* '''Disadvantage:''' There may be only a engineering test version available (as of today) - use that with care!
#* '''Disadvantage:''' There may be only a engineering test version available (as of today) - use that with care!
#* '''Installation:'''You can download the needed "Standalone FGCOM".zip from http://fgcom.flightgear.org/download/.
#* '''Installation:'''You can download the needed "Standalone FGCOM".zip from http://fgcom.flightgear.org/download/.
<br><br>
 
==== Install on Windows ====
==== Install on Windows ====
# '''Please use the Windows installation description'''
# '''Please use the Windows installation description'''
Line 262: Line 267:


==== Start FGCom ====
==== Start FGCom ====
Open a [[Command line|command-window]] and change into the directory in which FGCom was installed (probably the same as FlightGear) and start FGCom. You must decide what server you want to use! As of Oct.2013 there are 2 FGCOM-servers available:
Open a [[Command line|command-window]] and change into the directory in which FGCom was installed (probably the same as FlightGear) and start FGCom. The server you want to use for events is '''fgcom.flightgear.org''' (fgcom.flightgear.org.uk was the originally used server and is not available any more).
::{| border="2" cellpadding="5"
||delta384.server4you.de||This is the currently (Oct 2013) used server for events.
|-
||fgcom.flightgear.org||This is a new development. It should be formally available with FS 3.0, expected for Spring 2014. You may use it for testing
|-
||''<small>(fgcom.flightgear.org.uk)</small>''||''<small>This originally used server is not available any more</small>''
|}
Due to technicalities it is not possible to speak from 1 server to the other - so try one and change if you notice that your friends are using the other.


To start FGCom with a defined server you must insert the server-address after a "-S" (watch: The "S" must be a capital!):
To start FGCom with the defined server you must insert the server address after a "-S" (watch: The "S" must be a capital!):
::{| border="2" cellpadding="5"
::{| border="2" cellpadding="5"
! style="background:#efefef" |Linux||fgcom -Sdelta384.server4you.de
! style="background:#efefef" |Linux||fgcom -Sfgcom.flightgear.org
|"-Sfgcom..." with capital "S"
|"-Sfgcom..." with capital "S"
|-
|-
Line 283: Line 280:
|-
|-
! style="background:#efefef" |Windows  
! style="background:#efefef" |Windows  
|cd 'C:\Program Files\Flightgear\win32'<br />fgcom.exe -Sdelta384.server4you.de
|cd 'C:\Program Files\Flightgear\win32'<br />fgcom.exe -Sfgcom.flightgear.org
|"-Sfgcom..." with capital "S"
|"-Sfgcom..." with capital "S"
|}
|}
Line 292: Line 289:
<br><br>
<br><br>
'''1) The first response should be:'''
'''1) The first response should be:'''
   /fgcom - a communication radio based on VoIP with IAX/Asterisk  
   fgcom - a communication radio based on VoIP with IAX/Asterisk
   (c)2007 by H. Wirtz <wirtz@dfn.de>  
   Original (c) 2007-2011 by H. Wirtz <wirtz@dfn.de>
   Version 1.2.2 build 206M
  OSX and Windows ports 2012-2013 by Yves Sablonier and Geoff R. McLane, resp.
   Using iaxclient library Version SVN 206M
   Version 3.1.0 compiled Mar  2 2014, at 00:21:19
   Using iaxclient library Version SVN 261
    
    
   Successfully parsed command-line options.  
   Successfully parsed commandline options
   Reading list of airports...done.
  Loaded file [/usr/share/flightgear/special_frequencies.txt].
   Initializing IAX client as guest:xxxxxxxxxxx@fgcom.flightgear.org1)
   Reading airports [/usr/share/flightgear/positions.txt]
  loaded 47171 entries
   Initializing IAX client as guest:xxxxxxxxxxx@fgcom.flightgear.org
 
If, due to a prior flight, COM1 was set to anything else but 118.600 (e.g. to 119.650) you will see the following 2 lines added to the above shown initialization of the FGCom-window:
If, due to a prior flight, COM1 was set to anything else but 118.600 (e.g. to 119.650) you will see the following 2 lines added to the above shown initialization of the FGCom-window:
  Selected frequency: 119.650  
  Selected frequency: 119.650  
Line 494: Line 495:
  fgcom --help
  fgcom --help
returns the following useful info
returns the following useful info
    fgcom - a communication radio based on VoIP with IAX/Asterisk
 
    (c)2007 by H. Wirtz <wirtz@dfn.de>
  fgcom - a communication radio based on VoIP with IAX/Asterisk
    Version 1.2.2 build 163M
  Original (c) 2007-2011 by H. Wirtz <wirtz@dfn.de>
    Using iaxclient library Version SVN 163M
  OSX and Windows ports 2012-2013 by Yves Sablonier and Geoff R. McLane, resp.
  Version 3.1.0 compiled Mar  2 2014, at 00:21:19
  Using iaxclient library Version SVN 261
    
    
  OPTION                                       DESCRIPTION
    OPTION                                               DESCRIPTION
    
    
  -d, -debug, --debug=                         show debugging information
    -d, -debug, --debug=                                 show debugging information
  -S, -voipserver, --voipserver=               voip server to connect to (default: 'fgcom.flightgear.org')
    -S, -voipserver, --voipserver=                       voip server to connect to (default: 'fgcom.flightgear.org')
  -s, -fgserver, --fgserver=                   network device to connect to  (default: 'localhost')
    -s, -fgserver, --fgserver=                           fg to connect to  (default: 'localhost')
  -p, -port, --port=                           where we should listen to FG (default: '16661')
    -p, -port, --port=                                   where we should listen to FG (default: '16661')
  -a, -airport, --airport=                     airport-id (ICAO) for ATC-mode
    -a, -airport, --airport=                             airport-id (ICAO) for ATC-mode
  -f, -frequency, --frequency=                 frequency for ATC-mode
    -f, -frequency, --frequency=                         frequency for ATC-mode
  -U, -user, --user=                           username for VoIP account (default: 'guest')
    -C, -callsign, --callsign=                            callsign to use (default: 'guest')
  -P, -password, --password=                   password for VoIP account (default: 'guest')
    -U, -user, --user=                                   username for VoIP account (default: 'guest')
  -i, -mic, --mic=                             mic input level (0.0 - 1.0)
    -P, -password, --password=                           password for VoIP account (default: 'guest')
  -o, -speaker, --speaker=                     speaker output level (0.0 - 1.0)
    -i, -mic, --mic=                                     mic input level (0.0 - 1.0)
  -b, -mic-boost, --mic-boost=                 enable mic boost
    -o, -speaker, --speaker=                             speaker output level (0.0 - 1.0)
  -l, -list-audio, --list-audio=               list audio devices
    -b, -mic-boost, --mic-boost=                         enable mic boost
  -r, -set-audio-in, --set-audio-in=           use <devicename> as audio input
    -t, -silence-threshold, --silence-threshold=          set silence threshold (-60.0 - 0.0)
  -k, -set-audio-out, --set-audio-out=         use <devicename> as audio output
    -l, -list-audio, --list-audio=                       list audio devices
  -c, -codec, --codec=                         use codec <codec> as transfer codec (default: 'u')
    -r, -set-audio-in, --set-audio-in=                   use <devicename> as audio input
    -k, -set-audio-out, --set-audio-out=                 use <devicename> as audio output
    -c, -codec, --codec=                                 use codec <codec> as transfer codec (default: 'u')
    -T, -positions, --positions=                          location positions file (default: '/usr/share/flightgear/positions.txt')
    -Q, -special, --special=                              location spl. frequency file (opt) (default: '/usr/share/flightgear/special_frequencies.txt')
    
    
  Available codecs:
    Available codecs:
        u - ulaw (default and best codec because the mixing is based onto ulaw)
          u - ulaw (default and best codec because the mixing is based onto ulaw)
        a - alaw
          a - alaw
        g - gsm
          g - gsm
        s - speex
          s - speex
        7 - G.723
          7 - G.723
    
    
  Mode 1: client for COM1 of flightgear:
        $ fgcom
  - connects fgcom to fgfs at localhost:16661
        $ fgcom -sother.host.tld -p23456
  - connects fgcom to fgfs at other.host.tld:23456
    
    
  Mode 2: client for an ATC at <airport> on <frequency>:
    Mode 1: client for COM1 of flightgear:
        $ fgcom -aKSFO -f120.500
          $ fgcom
  - sets up fgcom for an ATC radio at KSFO 120.500 MHz
    - connects fgcom to fgfs at localhost:16661
          $ fgcom -sother.host.tld -p23456
    - connects fgcom to fgfs at other.host.tld:23456
    
    
     Note that /home/hcs/src/fgcom/trunk/src/fgcom starts with a guest account unless you use -U and -P!
     Mode 2: client for an ATC at <airport> on <frequency>:
          $ fgcom -aKSFO -f120.500
    - sets up fgcom for an ATC radio at KSFO 120.500 MHz
 
 
  Note that fgcom starts with a guest account unless you use -U and -P!


Also note that the current server (fgcom.flightgear.co) works with guest account, so '''do not use -U or -P'''
Also note that the current server (fgcom.flightgear.org) works with guest account, so '''do not use -U or -P'''


== Server installation ==
== Server installation ==
Line 585: Line 594:
* [[FGComGui]]
* [[FGComGui]]


[[Category:FGCom| ]]
== External link ==
* [http://sourceforge.net/projects/fgcom/ Old repository] at sourceforge
 
[[Category:FGCom]]
[[Category:Multiplayer]]
[[Category:Multiplayer]]


[[fr:FGCom]]
[[fr:FGCom]]

Navigation menu