src/NetworkOLK/Tools/README

   1 Welcome to FlightGear Deamon fgd
   2 --------------------------------
   3 Here the first Tools to play with FlightGear Deamon.
   4 This is yet pre-alpha and the sources remain to be tidied up,
   5 and to get documented.
   6
   7
   8 Theory of operation:
   9 --------------------
  10 The FlightGear Deamon called fgd is a standalone program which registers
  11 FGFS players willing to have a multiplayer FGFS environment via TCP/IP.
  12 Information like player's ip/lon/lat/alt etc. can be send to fgd.
  13 The deamon fgd in turn sends back the gathered information upon request.
  14 The purpose of the scan prog "fgd_scan" is to locate free ports on the
  15 network, which can be used for exchanging data between FGFS and fgd.
  16 The commando program fgd_com serves as an example of how the communication
  17 to fgd can be done. For the moment consider fgd_com as FGFS.
  18 Parts of fgd_com will be later incorporated into FGFS.
  19
  20
  21 How to play with the tools:
  22 ---------------------------
  23 Just fire up fgd on whatever machine reachable from the one on which
  24 FGFS will be running. Even the same machine is ok.
  25 Then use fgd_scan to locate the fgd-deamon.
  26 Also use fgd_com to pass some commandos to fgd.
  27
  28
  29 How to compile:
  30 ---------------
  31 Use the Makefile with make or just gcc -o prog prog.c
  32
  33
  34 Usage:
  35 ------
  36 - fgd [start port] [end port] <-v -vv>
  37
  38 where
  39       - start port  and  end port is the range where it should listen and
  40         talk to. (Later the range will be used to check for a free port
  41         within this range, which can be used for communicating with FGFS.
  42         for the moment make sure you use the _SAME_ port value for start
  43         and stop. A good starting point should be above 10000.
  44       - -v or -vv is the verbose level. This param can be ommitted.
  45
  46
  47 - fgd_scan [host] [start port] [end port] <-v -vv>
  48
  49 comment: params are the same as for fgd except that the start-stop range
  50          must be different to detect fgd.
  51
  52          Also host means the host running fgd, not where the scanner is
  53          fired up.
  54
  55          Just for fun you can take also the dangerous (priviledged ports)
  56          But the fgd-scanner will be stuck at some used ports.
  57          It doesn't hurt to experiment in the used regions, a ctrl-c
  58          will abort the scanning so that new params can be used.
  59
  60
  61 - fgd_com  [FGD-host] [start port] [end port] [-v -vv] [commando] <FGFS-host>
  62
  63 comment: see fgd_scan, but you must enter either a ip/fqdn or dummystring as
  64          last param, some commandos use it to pass it as real information to
  65          fgd.
  66
  67
  68 The commandos for fgd_com:
  69 --------------------------
  70
  71  0 : fgd idenditfies itself, answeres back to scanner
  72  1 : registering to fgd
  73  2 : show who's registered
  74  3 : send message to one specific user           (not implemented yet)
  75  4 : send message to all users                   (not implemented yet)
  76  5 : scan for other fgd's                        (not implemented yet)
  77  6 : update (fgd sends it's database to user)    (not implemented yet)
  78  8 : unregister from fgd
  79  9 : shutdown fgd
  80
  81 Comments:
  82 ---------
  83 Commands 1/2/8 use the last parameter (see above, dummy-string) for the
  84 ip or hostname or fqdn of the fgfs-machine which will be added/listed/removed
  85 from fgd.
  86 Try registering and unregistering various hosts to see if the add/remove
  87 mechanism works well. It should work correctly.
  88
  89
  90 Examples:
  91 ---------
  92 - fgd olk 10003 10003 -vv
  93   fgd runs on host "olk" using port "10003" using max. verbose level
  94
  95 - fgd_com olk 10003 10003 -vv 1 johnny
  96   send "register host"-command to fgd running on host "olk" using port"10003"
  97   and register machine "johnny"
  98
  99 To do:
 100 ------
 101 - clean-up code
 102 - document the code
 103 - convert code from c to c++
 104 - find a place within FGFS where to reside
 105 - make the code more autodetectable, to reduce commandline params
 106 - implement missing commands
 107 - find other useful commands
 108 - find and resolve bugs ;-)
 109
 110
 111 REMEMBER:
 112 ---------
 113 This 3 toys are pre-alpha and dirty and need also to be documented.
 114
 115 Send comments/flame/beer/whatever to delise@rp-plus.de
 116
 117 Oliver Delise 25/May/99