ATC-pie user guide: Difference between revisions

v1.4.1
(v1.4.0)
(v1.4.1)
Line 8: Line 8:
* the [https://www.youtube.com/playlist?list=PL1EQKKHhDVJvvWpcX_BqeOIsmeW2A_8Yb online] '''video tutorial''';
* the [https://www.youtube.com/playlist?list=PL1EQKKHhDVJvvWpcX_BqeOIsmeW2A_8Yb online] '''video tutorial''';
* the in-app '''quick reference''' available from the ''Help'' menu (summary of mouse/keyboard gestures, display conventions...);
* the in-app '''quick reference''' available from the ''Help'' menu (summary of mouse/keyboard gestures, display conventions...);
* a skilled '''teacher''' to connect to as a student (personal training);
* to '''play solo'''!
* to '''play solo'''!


Line 242: Line 243:
* loose strip bays, to move unracked strips over custom backgrounds, e.g. ground charts of the airport.
* loose strip bays, to move unracked strips over custom backgrounds, e.g. ground charts of the airport.


There are two ways to create backgrounds in the program. One working for all purposes is to '''import pictures''' (pixmap files like JPEG or PNG, including transparency); the other works only for radar backgrounds and consists in writing '''drawing specification''' files to paint coloured lines and labelled points. This allows to import anything from the most complex coloured height map to the the most schematic airspace outline. The <code>resources/bg-img/Notice</code> file explains how to import and draw background images. All pictures and drawing points are positioned using lat/lon coordinates, navpoints in map range and radial/distance expressions as per the "point specification" syntax explained in the notice.
There are two ways to create backgrounds in the program. One working for all purposes is to '''import pictures''' (pixmap files like JPEG or PNG, including transparency); the other works only for radar backgrounds and consists in writing '''drawing specification''' files to paint coloured lines and labelled points. This allows to import anything from the most complex coloured height map to the the most schematic airspace outline. The <code>resources/bg-img/Notice</code> file explains how to import and draw background images.


For example, you can map out procedures (SID, STAR, IAD...), grouping them by associated runways. Drawings are generally appropriate for that because they allow referring to named points as per the published procedures and avoid manual positioning. But if you want more than schematic line plots, you should create the picture yourself. Using an image processing tool like ''GIMP'', superimpose a transparent layer on top of a real map canvas, or over a screenshot of your ATC-pie radar with pinned navaids as landmarks, and freely decorate your picture.
For example, you can map out procedures (SID, STAR, IAD...), grouping them by associated runways. Drawings are generally appropriate for that because they allow referring to named points as per the published procedures and avoid manual positioning. But if you want more than schematic line plots, you should create the picture yourself. Using an image processing tool like ''GIMP'', superimpose a transparent layer on top of a real map canvas, or over a screenshot of your ATC-pie radar with pinned navaids as landmarks, and freely decorate your picture.
Line 249: Line 250:
# Located in the ''System'' menu, the "image positioning helper" allows to move and resize imported pictures, adjusting the corners visually rather than programmatically if you have no specification for them. All visible pixmap images will be moved simultaneously, so you can work with several at a time if you want to. On dialog box close, a file is generated in the <code>output</code> directory for you to copy from.
# Located in the ''System'' menu, the "image positioning helper" allows to move and resize imported pictures, adjusting the corners visually rather than programmatically if you have no specification for them. All visible pixmap images will be moved simultaneously, so you can work with several at a time if you want to. On dialog box close, a file is generated in the <code>output</code> directory for you to copy from.
# The "download OSM background" option facilitates map retrieval from the [[OpenStreetMap]] still image server. After specifying corners and a scale, a PNG map will be generated in the <code>output</code> directory for you to import. Caution: downloads can fail for large images; try reducing the requested size or resolution in such case. Also, the server is rather limited so make parsimonious use of it.
# The "download OSM background" option facilitates map retrieval from the [[OpenStreetMap]] still image server. After specifying corners and a scale, a PNG map will be generated in the <code>output</code> directory for you to import. Caution: downloads can fail for large images; try reducing the requested size or resolution in such case. Also, the server is rather limited so make parsimonious use of it.
# If you have a sector file for your area (.sct), the <code>sectorExtract.py</code> script will translate the contained diagrams into ATC-pie drawings. While the generated files always require some post-editing, it is generally the best option for things like SID/STAR diagrams. See the <code>README</code> file for a description.
# If you have a VATSIM/IVAO sector file for your area (.sct), the "extract drawings from sector file" option will translate the contained diagrams into ATC-pie drawings. While the generated files always require some post-editing, it is generally the best option for things like SID/STAR diagrams.


== Communications ==
== Communications ==
Line 274: Line 275:
Here is how ATC-pie decides what to do with a text alias of the form <code>$foo</code> on chat message send:
Here is how ATC-pie decides what to do with a text alias of the form <code>$foo</code> on chat message send:
# If it is one of the predefined list, the substitution is the one described. If not, it is a custom alias and we carry on to the next step.
# If it is one of the predefined list, the substitution is the one described. If not, it is a custom alias and we carry on to the next step.
# Look for a line beginning with "foo=" in the general notes (notepad dock). If one is found, the alias is substituted with what follows the '='.
# Look for a line beginning with "foo=" in the general notes (notepad dock). If one is found, the alias is substituted with what follows the '<code>=</code>' character.
# Perform the same search through the local notes. If nothing is found, consider the current selection.
# Perform the same search through the local notes. If nothing is found, consider the current selection.
# If a strip is part of the current selection, look inside the comment field and search likewise.
# If a strip is part of the current selection, look inside the comment field and search likewise.
# Substitution is unsuccessful. ATC-pie will open an edit box so that you can review your message before sending it.
# Substitution is unsuccessful. ATC-pie will open an edit box so that you can review your message before sending it.
NB: You can test all this without polluting any game channel by holding the mouse down on the "Msg" button and selecting "check message". This will allow you to view what replacements would take place.


Moreover, ATC-pie strips everything up to the first '''pipe character''' (<code>|</code>), if any, before a message is processed and sent. You may check this with test line "stripped part|sent part" and observe that only the "sent part" makes it to the message contents. You can therefore make your life easier with piped shortcuts in your preset message list. They will pop up like any other message in the filtered menu as you type. For example, the following preset message enables something like a dot-command for sending a bearing to your base airport in a few key strokes:
Moreover, ATC-pie strips everything up to the first '''pipe character''' (<code>|</code>), if any, before a message is processed and sent. You may check this with test line "stripped part|sent part" and observe that only the "sent part" makes it to the message contents. You can therefore make your life easier with piped shortcuts in your preset message list. They will pop up like any other message in the filtered menu as you type. For example, the following preset message enables something like a dot-command for sending a bearing to your base airport in a few key strokes:
265

edits