This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
ivac2:firdef_map [2015/06/08 15:24] splendor.bouman |
ivac2:firdef_map [2017/06/19 21:36] (current) ian.beswick [Data format] |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| Please be mindful of the realism of your map elements. Many radar screens are designed to show fewer elements than what you may have drawn in IvAc 1 sector files. We recommend basing all maps on pictures of real radar screens, then tweaking data as required for use on IVAO. | Please be mindful of the realism of your map elements. Many radar screens are designed to show fewer elements than what you may have drawn in IvAc 1 sector files. We recommend basing all maps on pictures of real radar screens, then tweaking data as required for use on IVAO. | ||
| - | ===== Colour schemes ===== | + | ===== Themes ===== |
| - | All map elements are given a colour scheme | + | Every FIR can specify an unlimited number of themes. Themes are defined by the theme directory name located in ''fir/theme/(theme_name)'' |
| - | ===== File structure ===== | + | Each named theme directory groups the following files: |
| + | * [[ivac2:firdef_mapsymbols_xml|mapsymbols.xml]] | ||
| + | * [[ivac2:firdef_mapcolors_xml|mapcolors.xml]] | ||
| + | * [[ivac2:firdef_mapfonts_xml|mapfonts.xml]] | ||
| + | * [[ivac2:firdef_sddsymbols_xml|sddsymbols.xml]] | ||
| + | * [[ivac2:firdef_sddcolors_xml|sddcolors.xml]] | ||
| + | * [[ivac2:firdef_sddfonts_xml|sddfonts.xml]] | ||
| - | During startup the maps folder is read and all files with a ''.map'' extension are processed. Each ''*.map'' file shall contain the root element ''<maps>'' and at least one ''<map>'' element. | + | Map elements should refer to a color defined in [[ivac2:firdef_mapcolors_xml|mapcolors.xml]]. Wherever possible a generic name for each color element should be used such as ''gnd_taxiway'' as this will allow easier management of colors within themes. |
| - | The ''*.map'' files are located in the ''fir/maps/'' directory, which can contain one level of sub-directories (example: ''fir/maps/adxx'' ). We strongly recommend that you use sub-directories to logically group map files together. | + | Please be mindful of the realism of your themes. Remember many radar screens limit the amount of colour and tone down contrast. We strongly recommend you base your themes on pictures of real rdar screens. |
| - | <code XML> | + | As there is no limit to the amount of themes you can define per FIR each position could conceivably have a different look for each controller position: e.g. Airport 1 uses theme 1, Airport 2 uses theme 2, ACC uses theme 3. |
| - | <maps> | + | ===== File structure ===== |
| - | <map id="EBBU_AIRSP" name="AIRSP" group="ACC" text="false" visible="true" layer="450"> | + | |
| - | <!-- map elements go here --> | + | |
| - | </map> | + | |
| - | </maps> | + | |
| - | </code> | + | |
| + | During startup the maps folder is read and all files with a ''.map'' extension are processed. The map files are located in the ''fir/maps/'' directory, which can contain one level of sub-directories (example: ''fir/maps/adxx'' ). We strongly recommend that you use sub-directories to logically group map files together. | ||
| + | |||
| + | You can also define a ''groups.xml'' file on the route maps folder ''fir/maps/groups.xml'' this file defines how the maps window looks and contains more information. | ||
| + | |||
| + | * [[ivac2:firdef_map_groups|groups.xml]] | ||
| ===== Drawing logic ===== | ===== Drawing logic ===== | ||
| Line 51: | Line 57: | ||
| All maps are defined in XML format. There are a large amount of free/open source tools available on the Internet to edit XML files, we also publish schema files which can be used to verify that the XML files use the correct syntax. | All maps are defined in XML format. There are a large amount of free/open source tools available on the Internet to edit XML files, we also publish schema files which can be used to verify that the XML files use the correct syntax. | ||
| + | |||
| + | |||
| + | ^Root Element|maps|| | ||
| + | ^Element|map|| | ||
| + | ^Attribute^Format^Remarks^ | ||
| + | |id|string|unique identifier for the map| | ||
| + | |name|string|map name, to be displayed on the map menu| | ||
| + | |group|string|group which the map is contained within on the map menu| | ||
| + | |layer|integer|layer number which this map is to be displayed at| | ||
| + | |visible|bool|True or False, indicating whether the map should be visible initially| | ||
| + | |text|bool|True or False, indicating whether the map text should be visible initially| | ||
| + | |||
| + | For example: | ||
| + | |||
| + | <code XML> | ||
| + | <maps> | ||
| + | <map id="EDYY_BRU_AIRSP" name="EDYY BRU" group="AIRSPACE" layer="110" visible="false" text="false" > | ||
| + | .... | ||
| + | </map> | ||
| + | </maps> | ||
| + | </code> | ||
| + | |||
| + | |||
| We have included a small chapter at the end of this document to give you some examples of great tools which you could use to create your divisions FIR definition(s). | We have included a small chapter at the end of this document to give you some examples of great tools which you could use to create your divisions FIR definition(s). | ||