Settings ‐ SID - Gameagle/vSID GitHub Wiki
A SID designator can be defined multiple times with different settings. This option enables a lot of possibilities to have a working setup for almost every special case at the airport. A sequential number per SID waypoint is always required as "key" due to the .json format (see example).
How the plugin is working
Initially the restrictions per designator are checked. If a designator mets all conditions, it is internally stored. If not, the designator will be ignored. After that the designator with the highest priority is choosen as assigned SID. If later another designator with a lower priority is found it is the new internally stored one.
Settings are in "key:value" pairs. If no setting is set in config the plugin falls back to the default value.
Settings Level
There are different "settings level" where the settings can be placed. SID settings on Airport Level are the highest level and used for every SID at the airport (e.g. for the initial climb). This is followed by the Waypoint Level, Designator Level and ID Level. All settings (except the runway) can be used on every level.
Settings on a lower level will overwrite the level above.
{
"ICAO": {
"sids": {
"SID_WAYPOINT/FULL_SID_NAME": {
"SID_DESIGNATOR":{
"ID": {
}
}
}
}
}
}
Waypoint: last waypoint of the SID (first waypoint to be filed) or full SID if not in the default SID scheme (waypoint - number - designator).
Designator: SID designator. If no designator available (e.g. for military SIDs) numbers 1, 2, ... need to be used and the full SID name need to be defined as waypoint.
ID: Numbers 1, 2, ... when a SID has to be defined multiple times with different conditions.
The ID level with the runway is always required for a SID to be assigned.
SID Settings
Runway (mandatory)
Corresponding runway for the SID designator. If a designator is used for multiple runways, they can be specified here as well. The first active runway will be assigned.
"rwy": "26L",
"rwy": "07C,07R",
The runway always has to be included on ID level!
Waypoint
If the last waypoint of the SID deviates of the waypoint/name used in the SID name (the one used in the setting above), it need to specified here to match the correct SID.
"wpt": "ZELTI"
"XXX" is used when all waypoints should be accepted for this SID.
default: ""
This setting is designed for SIDs where the first filed waypoint does not match the SIDs last waypoint name (e.g. german military SIDs "NL123" that ends at waypoint "ABCDE", when a SID should not be flown to the end or with multiple transitions at the end of the SID). When the first filed waypoint matches any SID waypoint in the config, this setting can not be used to assign a different SID!
Priority
SIDs are assigned based on the priority (1 - 98). If all restrictions are met, the SID with the highest priority will be assigned.
SIDs with prio 99 (lowest prio, e.g. if a designator will not be assigned generally) and prio 0 (highest prio, e.g. if a designator should be deactived with a rule/area) will never be assigned automatically and need to be selected manually.
It is possible to define the same prio multiple times. If there are no further restrictions that will lead to ignore a designator and there are multiple matches with the same prio, the first match found will be assigned.
"prio": 1
default value: 99
Initial Climb
Initial climb in feet.
"initial": 7000
default value: 0 | no initial climb will be displayed or set by the plugin
Climb via SID
SID has specific altitude or speed restrictions that requires a special phraseology. Initial climb is colored (see general settings) based on this setting. It could also be used for anything that need special attention if there is not such a difference for the phraseology in other countries.
"climbvia": false
available settings: true | false (default)
Pilotfiled SID
SID will only be assigned if filed by the pilot. If not filed, it will not be assigned by the plugin and need to be selected manually.
"pilotfiled": true
available settings: true | false (default)
If the SID should also be assigned if not filed, a second designator without this option is required.
Aircraft Type
If TRUE, SID is only assigned to defined aircraft. If FALSE, SID is not assigned to defined aircraft.
"acftType": {"B744": true, "B748": true}
available settings: true | false default: {}
Destination
If TRUE, SID is only assigned to defined destination, all other destinations will be skipped. If FALSE, SID is not assigned to defined destination.
"dest": {"EDDN": true}
available settings: true | false default: {}
Route Restrictions
When a specific waypoint or airway need to be part of the filed route or is not allowed, the following setting can be used.
"route": {"allow": {"1": "NETEX,RASCA", "2": "NETEX,DELOM"}, "deny": {"1": "Z82"}
Wake Turbulence Category (WTC)
By default all wake turbulence categories are accepted. If the SID should be assigned to a specific or multiple specific WTCs, this can be set here.
"wtc": "LM"
available settings: LMHJ default: ""
Enginetype
If the SID should be used for a specific enginetype only.
"engineType": "PT"
available settings: J (jet), T (turbo-prop), P (piston) default: ""
Wing Type
Wing type to differentiate between e.g. helis and fixed wing aircraft (landplane). Euroscope definitions are used.
"wingType": "H"
available settings: H (heli), L (landplane), S (seaplane), A (amphibian), G (gyrocopter), T (tilt-wing) default value: L
Amount of Engines
If the SID should be used for a specific amount of engines only (e.g. 2 or 3 engined heavies).
"engineCount": 3,
default value: 0 (disabled)
If not specified any amount is accepted.
Maximum Take-Off Weight (MTOW)
If the SID should be used for a aircraft below a maximum take-off weight only.
"mtow": 130000
(value in kg)
default value: 0 (disabled)
Custom Rules
Custom rules are used as all other item and can activated or deactibated. The specific SID will only by assigned if a cutom rule is active. Priority "0" should be used if a rule should deactivate the automatic assignment for this designator.
"customRule": "traalg"
default: ""
When a custom rule is activated while the auto mode is in use, all outbounds without clearance received flag will get the new SID automatically if the rule applies.
Areas
SID will only be assigned to outbounds in the specified area.
"area": "cargo"
available settings: "" | a matching name defined in areas section default: ""
Priority "0" should be used if a rule should deactivate the automatic assignment for this designator.
Each area needs at least three coordination identifier (to create a triangle at minimum). Coordination identifiers to not have to enclose the entire area, the last coordination identifier will be connected to the first.
Active by default
"active": true,
available settings: true | false (default)
Coordination Identifier
Any key that describes a point (p1, p2, ...) is suitable. Each coordination identifier consists of a pair of coordinates in "Euroscope" format (e.g. "N050.02.51.447", "E008.33.25.848")
"p1": {"lat": "N050.02.20.342", "lon": "E008.35.26.388"},
no default value, mandatory setting when used
Arrival Runway as Departure Runway
When arrival runways can be used as departure runway even if only active as arrival runway. This setting is only available in combination with areas. This setting need to be defined within the area setting! To use is for the entire airport, an area can be defined covering the complete airport.
"arrAsDep": true
available settings: true | false (default)
Equipment
ICAO flightplan equipment including PBN codes can be defined wether they need to be available or not. When pilots file FAA equipment the plugin will transform this into the ICAO equipment codes internally. It's also possible to define if "RNAV" or "NON-RNAV" is required for a SID.
"equip": {"RNAV": true, "NON-RNAV": true, "T": false}
default: "equip": {"RNAV": true"}
By default all aircraft with NO equipment at all, PBN filed or defined as "always RNAV capable" are assumed to be RNAV capable (this will results in less false NON-RNAV as the other way around). NON-RNAV traffic need to file the equipment without ICAO RNAV equipment codes (A, B, G, R) and PBN!
FAA Codes: A, B, D = SDF | M, N, P = DFILTUV | C, I, Y = SDFIRY | G, S, V = SDFGRY | W = SDFWY | ****Z = SDE2E3FIJ1RWY | L, X, T, U = SDE2E3FGIJ1RWY (bold = RNAV)
Due to some network/plugin (e.g. Topsky) issues with equipment codes, FAA code "X, T, U" (NON-RNAV, no DME) is considered as "L" (RNAV) as this will result in less misinterpretations.
Additionally a list with always RNAV capable aircraft is used (e.g. A320, B738, B744, A310). Aircraft with ICAO Equipment I (INS) are defined as NON-RNAV as most of them prefere NON-RNAV SIDs on Vatsim.
Low Visibility Procedures (LVP)
Used if there is a specific SID assignment for low visibility operations. When the LVP mode is active, only designators with the LVP on setting will be assigned. If a waypoint has no LVP mode in the settings, SID will be assigned the same way as the mode is off.
"lvp": 1,
available settings: 1 (on) | 0 (off) | -1 (disabled) default value: -1 (disabled)
Active Arrival/Departure Runways
Used if a SID is only used for specific runway configurations.
"actArrRwy": {"allow": {"any": "07L,07R"}},
"actDepRwy": {"deny": {"all": "07L,07R"}},
default: {}
ALL = All specified runways need to be active. ANY = At least one of the specified runways need to be active. ALLOW = Runway must be active. DENY = Runway must not be active.
This setting only applies for the airport where the config is used for, not any other airport around. If the SIDs are depending on the runway config at an other airport, a custom rule should be used!
Time Settings
For SIDs only available during specific times (e.g. noise abatement SIDs during night).
"timeFrom": 22,
"timeTo": 06,
available settings: 0-24 (24h clock) | -1 (disabled) default: -1 (disabled)
Departure Transitions
This setting should be used when a SID is followed by a departure transition to the first waypoint in the flightplan (used e.g. at LIMC, LIRF).
"trans": {"waypoint": "designator", "waypoint2": "designator"}
Transitions can only be set up in combination with a SID like all other settings. All restrictions that are valid for the Transition need to be defined via the SID as usual. In that case it's likely that a SID need to be defined more than once to cover all assingment rules.
Please check the examples for more details.
Within the .ese file all SIDs and Transitions need to be defined as single SID! Based on the config file, vSID is aware of what is a Transitions and what is the SID.
vSID will define the combination of SID and Transition within the flightplan the following way: SIDxTransition.
To display/draw the route correct on Euroscope (.sct file), it is recommended to additionally combine SID and Transition as discribed above (with GNG use the "procedure combiner").
SID and Climb Highlight
If required the SID as well as the initial climb can be highlighted. This setting might be usefull to remind the controller on special conditions for a SID/altitude.
"clmbHighlight": true
"sidHighlight": true