utils/TerraSync/README.txt

   1 TerraSync
   2 =========
   3
   4 Usage:
   5
   6     terrasync -p <port> [ -s <rsync_source> ] -d <rsync_dest>
   7
   8 Example:
   9
  10     $ fgfs --atlas=socket,out,1,localhost,5500,udp --fg-scenery=/data1/Scenery-0.7.9
  11     $ nice terrasync -p 5500 -d /data1/Scenery-0.7.9
  12
  13 Requirements:
  14
  15     - rsync util installed in your path.
  16     - mkdir util installed in your path.
  17
  18 TerraSync is a utility that is intended to run as a light weight
  19 background process.  It's purpose is to monitor the position of a
  20 FlightGear flight and pre-fetch scenery tiles from a remote server
  21 based on the current FlightGear position.
  22
  23 This allows you to do a base install of FlightGear with no add on
  24 scenery.  Now just go and fly anywhere.  Scenery is fetched "just in
  25 time" and accumulated on your HD so it is already there next time you
  26 fly.  You can fly anywhere and essentially just the scenery you need
  27 is auto-installed as you fly.
  28
  29 Terrasync runs as a separate process and expects the --atlas=port
  30 format to be sent from fgfs.  The fgfs output tells the terrasync util
  31 where FlightGear is currently flying.  Terrasync will then issue the
  32 appropriate commands to rsync the surrounding areas to your local
  33 scenery directory.  The user need to choose a port for
  34 FlightGear->TerraSync communication and then specify the server
  35 location and destation scenery tree.
  36
  37 As you fly, terrasync will periodically refresh and pull any new
  38 scenery tiles that you need for your position from the server.
  39
  40 This also works if the scenery on the scenery server is updated.
  41 Rsync will pull any missing files, or any updated files.
  42
  43 There is a chicken/egg problem when you first start up in a brand new
  44 area.  FlightGear is expecting the scenery to be there *now* but it
  45 may not have been fetched yet.  I suppose without making a more
  46 complex protocol, the user will need to be aware of this.  The user
  47 could restart flightgear after the initial rsync completes, and then
  48 after that everything should be good, assuming the flight track is
  49 "continuous" and the user has the necessary bandwidth to keep up with
  50 flight speeds.
  51
  52 Final notes:
  53
  54 I have set up an initial scenery server at
  55 baron.flightgear.org::Scenery-0.7.9.  This is the 0.7.9 vintage
  56 scenery with airports rebuilt to include lighting.  Alex Perry also
  57 has a partial rsync server, but I don't know it's current status.
  58 William Riley has rebuilt the entire world, but the tiles are zipped
  59 in 10x10 degree chunks on on a relatively low bandwidth connection.
  60 There are aspects of the 0.7.9 scenery I like including the quality of
  61 the terrain, but William scenery has roads and streams which is also
  62 nice.