270
edits
ATC-pie installation guide: Difference between revisions
Jump to navigation
Jump to search
v1.9.0
Mickybadia (talk | contribs) (v1.8.7) |
Mickybadia (talk | contribs) (v1.9.0) |
||
| Line 5: | Line 5: | ||
== Installing == | == Installing == | ||
[[ATC-pie]] is free and open source, and programmed in | [[ATC-pie]] is free and open source, and programmed in Python for Qt5. It is therefore system-independant, but requires Python and its PyQt5 library to run. Otherwise, ATC-pie runs straight after download without any compiling (make, etc.) to do. | ||
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. | 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. | ||
| Line 16: | Line 16: | ||
: <code>git clone git://git.code.sf.net/p/atc-pie/code ATC-pie</code> | : <code>git clone git://git.code.sf.net/p/atc-pie/code ATC-pie</code> | ||
I say again: the download/clone alone is not enough; both | I say again: the download/clone alone is not enough; both Python and PyQt5 must be installed too. The exact dependencies and required versions are listed in the <code>README</code> file packed in the download. | ||
At this point you have a working program. But further software pieces can be installed to enable more of its features, as listed below. Depending on your use of ATC-pie, they can be recommended for more realism but they are not required, and can be installed later. Also read the <code>README</code> file for extra notes on installation. | At this point you have a working program. But further software pieces can be installed to enable more of its features, as listed below. Depending on your use of ATC-pie, they can be recommended for more realism but they are not required, and can be installed later. Also read the <code>README</code> file for extra notes on installation. | ||
| Line 25: | Line 25: | ||
* solo sessions with '''speech synthesis''' of AI pilots' radio messages, install ''pyttsx''; | * solo sessions with '''speech synthesis''' of AI pilots' radio messages, install ''pyttsx''; | ||
* FlightGear sessions with '''full ATC coordination''', including unlimited strip exchange (recommended!) and '''[[CPDLC]]''', install the ''Python IRC library''; | * FlightGear sessions with '''full ATC coordination''', including unlimited strip exchange (recommended!) and '''[[CPDLC]]''', install the ''Python IRC library''; | ||
* FlightGear and FSD sessions with realistic '''voice radio simulation''', install the ''FGCom-Mumble'' plugin (requires a ''Mumble''>=1.4 client); | * FlightGear and FSD sessions with realistic '''voice radio simulation''', install the ''FGCom-Mumble'' plugin (requires a ''Mumble''>=1.4 client)—alternatively for FlightGear sessions, the historic executable FGCom variant is supported; | ||
* all sessions (except solo) with an '''ATC phone line switchboard''', install ''PyAudio'', | * all sessions (except solo) with an '''ATC phone line switchboard''', install ''PyAudio'' (for FlightGear and FSD, ''PyMumble'' is also required). | ||
== Running == | == Running == | ||
Depending on your system and preference, you might be double-clicking, typing stuff or pulling your hair out. In any case what you must do is run a | Depending on your system and preference, you might be double-clicking, typing stuff or pulling your hair out. In any case what you must do is run a Python interpreter on the <code>ATC-pie.py</code> file from the downloaded directory. | ||
Tip for Windows users: create a shortcut whose "target" is <code>cmd /k Z:\path-to-pie\ATC-pie.py</code>, making sure "start in" is set to the same <code>Z:\path-to-pie</code> and that | Tip for Windows users: create a shortcut whose "target" is <code>cmd /k Z:\path-to-pie\ATC-pie.py</code>, making sure "start in" is set to the same <code>Z:\path-to-pie</code> and that <code>.py</code> files are associated with Python. | ||
=== Two program modes === | === Two program modes === | ||
| Line 54: | Line 54: | ||
| --map-range=''range'' || Only valid with a location code argument. Defines 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 does not affect radar range, which can still be greater or lower, and be changed within sessions.' || 100 in AD mode; 300 in CTR mode | | --map-range=''range'' || Only valid with a location code argument. Defines 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 does not affect radar range, which can still be greater or lower, and be changed within sessions.' || 100 in AD mode; 300 in CTR mode | ||
|- | |- | ||
| --views-send-from=''port'' || Sets the local UDP port number to bind for sending FGMS packets to | | --views-send-from=''port'' || Sets the local UDP port number to bind for sending FGMS packets to FlightGear viewers. This includes tower and additional viewers, but does not affect the FGMS connection port, chosen on session start. || 5009 | ||
|} | |} | ||
| Line 75: | Line 75: | ||
== Configuring == | == Configuring == | ||
Here are things you will soon want | Here are things you will soon need or want to set up for a regular use of ATC-pie: | ||
* set up a [[#Airport scene rendering|tower view]] to enable visual contact with your traffic in AD sessions; | * set up a [[#Airport scene rendering|tower view]] to enable visual contact with your traffic in AD sessions; | ||
* for FlightGear and FSD sessions, give yourself a "social name" so that others recognise you when using any of the ATC coordination/exchange features; | * for FlightGear and FSD sessions, give yourself a "social name" so that others recognise you when using any of the ATC coordination/exchange features; | ||
* for a realistic radio experience in FlightGear and FSD sessions, set up FGCom-mumble | * for a realistic radio experience in FlightGear and FSD sessions, set up FGCom-mumble. | ||
If you intend to operate often at a given location, it is sensible to: | If you intend to operate often at a given location, it is sensible to: | ||
* if it is an airfield location, download the latest airport data file from the [https://gateway.x-plane.com/airports/page# X-plane gateway] and place it in <code>CONFIG/ad</code> (see the <code>Notice</code> file there); | * if it is an airfield location, download the latest airport data file from the [https://gateway.x-plane.com/airports/page# X-plane gateway] and place it in <code>CONFIG/ad</code> (see the <code>Notice</code> file there); | ||
* review and fill the various fields in the location set-up dialog (runway capabilities deserve special focus for more realisitc aircraft intentions in AD solo sessions); | * review and fill the various fields in the location set-up dialog (runway capabilities deserve special focus for more realisitc aircraft intentions in AD solo sessions); | ||
* configure the workspace racks, bays and radar screens to suit the environment and service provided | * configure the workspace racks, bays and radar screens to suit the environment and service provided (they will be saved for future runs at the same location); | ||
* if using the radar, pin your preferred navpoints (they are restored on every run) and consider creating/importing background pictures to map terrain obstacles, procedure charts, etc. (see [[#Background images|section below]]); | * if using the radar, pin your preferred navpoints (they are restored on every run at the same location) and consider creating/importing background pictures to map terrain obstacles, procedure charts, etc. (see [[#Background images|section below]]); | ||
* for solo and teacher sessions at airports especially, build an elevation map (see <code>CONFIG/elev/Notice</code>). | * for solo and teacher sessions at airports especially, build an elevation map (see <code>CONFIG/elev/Notice</code>). | ||
| Line 91: | Line 91: | ||
=== Airport scene rendering === | === Airport scene rendering === | ||
[[File:ATC-pie-screenshot-towerViewing.png|thumbnail|Tower viewing, following a departing aircraft]] | [[File:ATC-pie-screenshot-towerViewing.png|thumbnail|Tower viewing, following a departing aircraft]] | ||
A '''tower view''' allows you to overlook your airport and the connected or simulated traffic, like a controller from a tower viewpoint. It allows to choose from the tower positions specified in the source data if any (X-plane seems only to allow | A '''tower view''' allows you to overlook your airport and the connected or simulated traffic, like a controller from a tower viewpoint. It allows to choose from the tower positions specified in the source data if any (X-plane seems only to allow one, but feel free to declare more for ATC-pie), otherwise defaults to somewhere over the airport to allow towering everywhere. It is disabled in CTR mode. | ||
There are two ways of activating a tower view. You may let ATC-pie start its own suitably configured FlightGear process, or have it connect to an external viewer manually set up to listen for traffic and accept telnet connections. | There are two ways of activating a tower view. You may let ATC-pie start its own suitably configured FlightGear process, or have it connect to an external viewer manually set up to listen for traffic and accept telnet connections. | ||
| Line 98: | Line 98: | ||
Connecting to an external viewer allows to run FlightGear on a different machine and thereby relieve your session from the CPU load a local instance induces. If you want to do so, get a hint of the required positioning options you should start your viewer with, from the tower view tab in the system settings dialog. Of course, scenery, models and liveries must also be available to the running process. | Connecting to an external viewer allows to run FlightGear on a different machine and thereby relieve your session from the CPU load a local instance induces. If you want to do so, get a hint of the required positioning options you should start your viewer with, from the tower view tab in the system settings dialog. Of course, scenery, models and liveries must also be available to the running process. | ||
In either case, once activated from the '' | In either case, once activated from the ''System'' menu, the tower view '''control pane''' is enabled, from which you can turn to runway points, follow selected aircraft... Direct FlightGear input in the view window is also possible: right click and drag allows to look around, {{key press|x}} and {{key press|Shift|x}} change the zoom level, etc. | ||
You can hook up '''additional viewers''' to your session, for example placed around your airport for exciting camera footage of challenging landings. You will not be able to control those viewers from ATC-pie like the tower viewer, but you will be able to activate | You can hook up '''additional viewers''' to your session, for example placed around your airport for exciting camera footage of challenging landings. You will not be able to control those viewers from ATC-pie like the tower viewer, but you will be able to activate the connections individually from the ''System'' menu. Additional viewers are registered by their host+port address, from the same dialog. | ||
Every such viewer registered on host ''XXX'' and port ''YYY'' should be running on ''XXX'' and started with options <code>--multiplay=out,TTT,HHH,PPP</code> and <code>--multiplay=in,TTT,,YYY</code>, where: | Every such viewer registered on host ''XXX'' and port ''YYY'' should be running on ''XXX'' and started with options <code>--multiplay=out,TTT,HHH,PPP</code> and <code>--multiplay=in,TTT,,YYY</code>, where: | ||