fgms 0.11.8
The
FlightGear MultiPlayer Server
project
page_flightgear.cxx
Go to the documentation of this file.
1 /**
2  * \page FlightGear FlightGear
3  *
4  * \section fg_intro The FlightGear Project (fg)
5  *
6  * - <b>FlightGear</b> is the project as a whole
7  * * The FlightGear project is made of many parts, and \ref fgms is one of them
8  * - Wiki: http://wiki.flightgear.org
9  * - Home: http://www.flightgear.org
10  * - Code: https://gitorious.org/fg
11  * - Bugs: https://code.google.com/p/flightgear-bugs/issues/list
12  * - Build: http://flightgear.simpits.org:8080/
13  *
14  * \subsection fg_mailing_list FG Mailing List
15  * Most developer cummunications is though the mailing list and IRC
16  * - http://wiki.flightgear.org/index.php/Mailing_list
17  * - http://wiki.flightgear.org/IRC
18  *
19  * \subsection fg_contents On this page
20  * * \ref fgfs below is the "command" used to launch the simulator
21  * * \ref fgms_for_fgms - at bottom is some extra dev information
22  *
23  * \section fgfs fgfs
24  * This is an example command line used to launch a sim
25  * \code
26  * > fgms --callsign=test1 --multiplay=out,4,mpserver14.flightgear.org,5000 --multiplay=in,4,localhost,5000
27  * \endcode
28  * The important command line vars for us in \ref fgms land are:
29  * \code
30  * --multiplay=out,4,mpserverXX.flightgear.org,5000
31  * --multiplay=in,4,server.ip.address,5000
32  * \endcode
33  * \warning
34  * There <b>must be no spaces</b> eg
35  * \code
36  --multiplay=in,4, my.server.address ,5000
37  oops ^ oops2 ^
38  * \endcode
39  *
40  *
41  * The <b>--multiplay</b> option is broken down as follows
42  * \code
43  --multiplay=[direction],[freq_hz],[host],[port]
44  \endcode
45  *
46  * - <b>direction</b>
47  * - <b>out</b> for sending to an mpserver
48  * - <b>in</b> for recieving from a connection
49  * - <b>freq_hz</b>
50  * - the number of times a second udp packets are sent
51  * - a high number eg +10 will be bombarding the network
52  * - around 4 frames a second is cool enough
53  * - even lower eg 2 frames a second
54  * - <b>host</b>
55  * - for <b>out</b> - this needs to be the server address eg mpserverNN.flightgear.org
56  * - for <b>in</b> - this needs to be your host name or ip eg localhost
57  * - <b>port</b>
58  * - by default this is 5000
59  *
60  * \warning Users were previously encouraged to use 10 hz. This consumes a lot of bandwidth.
61  * This number comes from the time when fgfs was not able to <i>'emulate'</i> a remote aircraft while no data is received.
62  * The first multiplayer versions just updated a remote aircraft's position on data reception
63  * and the aircraft stayed where it was until the next position arrived.
64  * Since then a lot of things have changed, but we never tried to reduce the number of packets.
65  * Its recommended that <b>2 to 4 pps are enough</b>.
66  *
67  * @see fgfs Command line options the the FlightGear wiki
68  * - http://wiki.flightgear.org/Command_line_options#MultiPlayer_Options
69  *
70  *
71  * \section fgms_for_fgms Info for fgms developers
72  *
73  * Bits of the multiplayer code from flightgear is copied as needed
74  * - See https://gitorious.org/fg/flightgear/trees/next/src/MultiPlayer
75  * - and \ref flightgear_inc
76  *
77  * Of interest also is the list of "properties" that are sent. Although
78  * these are simply relayed.
79  * - properties: https://gitorious.org/fg/flightgear/blobs/next/src/MultiPlayer/multiplaymgr.cxx#line69
80  * - A ::CHAT_MSG_ID is depreceated, instead its a property
81  * - <b>{10002, "sim/multiplay/chat", simgear::props::STRING}</b>
82  *
83  */