Difference between revisions of "ATC-pie installation guide"

From FlightGear wiki
Jump to: navigation, search
(v1.3.1)
(v1.3.4)
Line 22: Line 22:
 
=== More to install? ===
 
=== More to install? ===
 
The above alone will provide you with a working program, but a few software pieces can further be installed to enable extra features. They are recommended for more realistic fun, but not required and can be installed later anyway. These are:
 
The above alone will provide you with a working program, but a few software pieces can further be installed to enable extra features. They are recommended for more realistic fun, but not required and can be installed later anyway. These are:
* ''FlightGear'' for '''tower viewing''' in airport games (though it can be run on a separate machine, see feature note below);
+
* ''FlightGear'' for '''tower viewing''' in airport games (though it can be run on a separate machine, see [[ATC-pie user guide#Tower view window|feature note]] in the user guide);
 
* ''PocketSphinx'' for '''voice instruction recognition''' in solo games;
 
* ''PocketSphinx'' for '''voice instruction recognition''' in solo games;
 
* ''pyttsx'' for '''speech synthesis''' of pilot radio communications in solo games.
 
* ''pyttsx'' for '''speech synthesis''' of pilot radio communications in solo games.
Line 55: Line 55:
 
|}
 
|}
  
== Running for the first time ==
+
== Getting started ==
  
 
=== Initial configuration ===
 
=== Initial configuration ===
Line 63: Line 63:
  
 
A message pops up when opening a location for the first time, inviting you to configure the local settings and listing features that may be missing in the provided (X-plane) data. If you intend to play here or come back often, it is sensible to:
 
A message pops up when opening a location for the first time, inviting you to configure the local settings and listing features that may be missing in the provided (X-plane) data. If you intend to play here or come back often, it is sensible to:
* open the location settings dialog to set things up, e.g. airport runway capabilities (necessary for realisitc solo games);
+
* open the location settings dialog to set things up, e.g. airport runway capabilities (necessary for more realisitc solo games);
 
* if you have a custom airport file to use, e.g. downloaded from the [https://gateway.x-plane.com/airports/page# X-plane gateway] to replace one reported insufficient, place it in <code>resources/apt</code> (see the <code>Notice</code> file there);
 
* if you have a custom airport file to use, e.g. downloaded from the [https://gateway.x-plane.com/airports/page# X-plane gateway] to replace one reported insufficient, place it in <code>resources/apt</code> (see the <code>Notice</code> file there);
 
* if playing with radar: set up a background picture set with the terrain maps and procedure charts you need, and pin and save your preferred navpoints and labels so that they are restored on the next run;
 
* if playing with radar: set up a background picture set with the terrain maps and procedure charts you need, and pin and save your preferred navpoints and labels so that they are restored on the next run;
 
* create and name strip racks according to the service provided and save them for future runs too.
 
* create and name strip racks according to the service provided and save them for future runs too.
 +
 +
For more detailed and advanced configuration, check the <code>README</code> file for a summary of editable options and the corresponding <code>Notice</code> files.
  
 
=== Starting sessions ===
 
=== Starting sessions ===
Line 72: Line 74:
 
* callsigns for ATCs in FlightGear are expected to start with the ICAO code of the controlled airport or sector, and end with a hint on the provided service (twr, gnd, ctr...);
 
* callsigns for ATCs in FlightGear are expected to start with the ICAO code of the controlled airport or sector, and end with a hint on the provided service (twr, gnd, ctr...);
 
* before choosing your callsign on MP connect, make sure it is not already in use;
 
* before choosing your callsign on MP connect, make sure it is not already in use;
 +
* you can connect more than one ATC-pie instance from the same computer, but must use different ports;
 
* note that [[FGMS]] restricts callsign length to 7 characters.  :-(
 
* note that [[FGMS]] restricts callsign length to 7 characters.  :-(
  
 
Solo games:
 
Solo games:
* wind will be randomised at start, but you can choose an active runway first so that it is constrained to blow in a favourable direction;
+
* wind will be randomised at start, but can be forced to blow in a favourable direction if you select an active runway first;
 
* traffic is spawned with intentions according to the solo game options, so to avoid undesired traffic at start it is preferable to configure them before starting the game.
 
* traffic is spawned with intentions according to the solo game options, so to avoid undesired traffic at start it is preferable to configure them before starting the game.
  
 
[[Category:ATC-pie]]
 
[[Category:ATC-pie]]

Revision as of 05:20, 8 August 2017

Installing

Downloading

There are essentially two ways of downloading ATC-pie: one is to download a tarball to extract locally; the other is to clone the Git repository. The latter requires Git, but will keep you in sync with updates more easily. Your choice.

Downloading the tarball:

  1. get the latest stable version from the project page;
  2. extract the files to the directory of your choice.

To clone the Git repository:

git clone git://git.code.sf.net/p/atc-pie/code ATC-pie

In either case, you will have no compiling to do (make, etc.), but will require the following dependencies installed: Python3 and and its bindings to Qt5 (as listed in the README file in the downloaded directory).

If you chose cloning with Git, you can update your software when a new release is announced with a single command from the downloaded directory:

git pull

More to install?

The above alone will provide you with a working program, but a few software pieces can further be installed to enable extra features. They are recommended for more realistic fun, but not required and can be installed later anyway. These are:

  • FlightGear for tower viewing in airport games (though it can be run on a separate machine, see feature note in the user guide);
  • PocketSphinx for voice instruction recognition in solo games;
  • pyttsx for speech synthesis of pilot radio communications in solo games.

See the general README file for more notes on installation.

Running

Depending on your system and preference, you might be double-clicking, typing stuff or pulling your hair out. In any case what you need is to run a Python3 interpreter on the ATC-pie.py file in the top-level directory.

Two program modes

Initial graphical launcher, with AD & CTR game mode choice

On program start, a welcome launcher window should open, from which you may start a session in either airport (AD) or centre (CTR) mode, i.e. respectively with or without a base airfield.

The airport mode is for ATC positions like approach or tower control. In this mode, ATC-pie places the radar at the chosen base airfield, depicts its tarmac and runways, and enables features like tower viewing and runway selection.

The centre mode is designed for en-route control centre simulation. It disables all airport-specific features, and allows to place the radar anywhere on Earth. When selecting this mode:

  • The location code is a designator of your choice (excluding airport codes), under which to save your location-specific settings. A good idea is to use ICAO airspace designations, e.g. SBBS for the Brasilia FIR in central Brazil or LFFF for the Paris region in France.
  • The radar position field specifies the point on which to centre the radar. For example, LFPO>090,15 will centre the radar on a point 15 NM to the East of Orly airport. See down resources/bg-img/Notice for a full description of the syntax for point specification.

You may also bypass the launcher and start directly at a given location with the following command, using an ICAO code for an airport, or a previously defined CTR position:

./ATC-pie.py location_code

Command line arguments

Besides the location code, the following command line options are available:

Option Effect and argument specification Default
--map-range=range Define the distance in NM from the radar centre up to which the map will be drawn and navpoints listed in the navigator (accepted values are 20..500). This option can only be used with a location argument. 100 in AD mode; 300 in CTR mode
--views-send-from=port Change the local UDP port number to bind for sending FGMS packets to views. This includes all tower and additional views, but does not affect the multi-player connection ports, chosen on MP connect. 5009

Getting started

Initial configuration

Things you will want to do when running ATC-pie for the first time:

  • If you intend to use the radio like you should in FlightGear multi-player games, try an echo test from the System menu. If you have problems hearing yourself, check the FGCom version in the system set-up, read the resources/fgcom/Notice file and search for "FGCom" in the ATC-pie FAQ.
  • In the same dialog, if you want to use the internal tower viewing system, make sure you have the right paths set for your FlightGear installation.

A message pops up when opening a location for the first time, inviting you to configure the local settings and listing features that may be missing in the provided (X-plane) data. If you intend to play here or come back often, it is sensible to:

  • open the location settings dialog to set things up, e.g. airport runway capabilities (necessary for more realisitc solo games);
  • if you have a custom airport file to use, e.g. downloaded from the X-plane gateway to replace one reported insufficient, place it in resources/apt (see the Notice file there);
  • if playing with radar: set up a background picture set with the terrain maps and procedure charts you need, and pin and save your preferred navpoints and labels so that they are restored on the next run;
  • create and name strip racks according to the service provided and save them for future runs too.

For more detailed and advanced configuration, check the README file for a summary of editable options and the corresponding Notice files.

Starting sessions

FlightGear multi-player connection:

  • callsigns for ATCs in FlightGear are expected to start with the ICAO code of the controlled airport or sector, and end with a hint on the provided service (twr, gnd, ctr...);
  • before choosing your callsign on MP connect, make sure it is not already in use;
  • you can connect more than one ATC-pie instance from the same computer, but must use different ports;
  • note that FGMS restricts callsign length to 7 characters.  :-(

Solo games:

  • wind will be randomised at start, but can be forced to blow in a favourable direction if you select an active runway first;
  • traffic is spawned with intentions according to the solo game options, so to avoid undesired traffic at start it is preferable to configure them before starting the game.