Page ContentsPage Contents (click to expand)
  1. [VERSION]
  2. [BRAKES]
  3. [GEAR_WARNING_SYSTEM]
  4. [LIGHTS]
    1. Legacy Lights
  5. [ELECTRICAL]
    1. circuit.N
    2. battery.N
    3. alternator.N
    4. externalpower.N
    5. bus.N
    6. curve.N
  6. [HYDRAULIC_SYSTEM]
  7. [PNEUMATIC_SYSTEM]
  8. [VACUUM_SYSTEM]
  9. [PITOT_STATIC]
  10. [STALL_WARNING]
  11. [DEICE_SYSTEM]
  12. [RADIOS]
  13. [GEAR_WARNING_SYSTEM]
  14. [AUTOPILOT]
  15. [SMOKESYSTEM]
  16. [FOLDING_WINGS]
  17. [VOICEALERTS]
  18. [PRESSURIZATION]
  19. [AUXILIARY POWER UNIT]
  20. [WATER BALAST SYSTEM]
  21. [LocalVars]

SYSTEMS CONFIG DEFINITION

The systems.cfg file is an optional aircraft file for defining different aircraft systems. Below you can find information on the different sections used in the systems.cfg file as well as what parameters and values are expected within them.

 

 

[VERSION]

The [VERSION] section provides version information for the configuration file. In Microsoft Flight Simulator, major versions should always be at least equal to 1. Note that this section information is mandatory and should always be included.

 

Parameter Description Type Required
major Major CFG file version number, values must be greater than 0. Integer Yes
minor Minor CFG file version number, values must be greater than 0. Integer Yes

 

 

[BRAKES]

This section controls the aircraft's brake systems. Available parameters are:

 

Parameter Description Type Required
parking_brake

The type of parking brake available.

Integer:

0 = none
1 = parking break
2 = ground restraint brake

No
differential_braking_scale Differential braking is a function of using both brakes and the rudder pedal input. The amount of difference between the left and right brake is scaled by this value. Setting this to 0.0 means no differential braking is desired, while a setting of 1.0 is the normal setting for when differential braking is desired - which is particularly useful for tailwheel airplanes. Float
toe_brakes_scale Sets the scaling of the toe braking effectiveness. Note that a setting of 0.0 scales the brakes to no effectiveness, and default value is 1.0.     Float
parking_brake_linked_to_toe_brakes This parameter governs whether the parking brake will release upon application of the toe brakes. By default this is set to 1 (TRUE), but a setting of 0 (FALSE) will prevent this behavior. Bool
hydraulic_system_scalar On brakes dependent on the hydraulic system, this is the ratio of hydraulic system to maximum brake hydraulic pressure. Float
auto_brakes The number of autobrakes available (0 means no autobrakes) Integer
show_brake_message Whether to show the braking message (TRUE, 1) or not (FALSE 0) in the UI. Bool
rto_disabled_on_takeoff Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) for an . Bool
autobrakes_disabled_on_takeoff Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) for takeoff. Bool
autobrakes_requires_antiskid Whether the autobrake systems require anti-skid (TRUE, 1) or not (FALSE, 0). Bool
autobrakes_disabled_on_braking Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) when manually braking. Bool
autobrakes_disabled_on_thrust Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) on reverse thrust. Bool
no_toe_brake_input_smoothing Whether to disable (TRUE, 1) or not (FALSE, 0) input soothing for toe brakes. Bool
gear_warning_available Sets the type of gear warning system available on the aircraft.

Integer:

0 = None
1 = Normal
2 = Amphibian
(audible alert for water vs. land setting).

 

 

 

[GEAR_WARNING_SYSTEM]

This section defines the functionality of the gear warning system for the aircraft. This is generally related to the throttle lever position and the flap deflection. Available parameters are:

 

Parameter Description Type Required
gear_warning_available Sets the type of gear warning system available on the aircraft.

Integer:

0 = None
1 = Normal
2 = Amphibian
(audible alert for water vs. land setting).

Yes
pct_throttle_limit The throttle limit, below which the gear warning will activate if the gear is not down and locked while the flaps are deflected to at least the setting for flap_limit_idle below. This flap limit can be 0 so that the warning effectively is a function of the throttle. A value between: 0 (idle) and 1.0 (Max throttle).     Float No
flap_limit_idle This limit is the flap deflection above which the warning will activate if the gear is not down and locked while the throttle is below the limit specified by pct_throttle_limit. Setting this limit to a value greater than 0, the pilot can reduce the throttle to idle without activating the warning (this is often utilized in jets to decelerate/descend the aircraft).     Float No
flap_limit_power The flap limit, above which the warning will activate (regardless of throttle position).     Float No

 

 

 

[LIGHTS]

This section controls the lights on the aircraft. The given index value can then be passed to the corresponding light simvar to apply a different behaviour to different lights. For example the simvar .

 

Available parameters are:

 

Parameter Description Type Required
lightdef.N
Each light has it's own definition as a hash map (explained below) where each item in the table has it's own definition. Lights are numbered from 0.

Hash Map

(see Data Types for more information)

No

 

The hash map that each light takes is comprised of the following key:value pairs, separated by the # symbol:

 

Key Value Description Required
Type

Integer:

1 = Beacon
2 = Strobe
3 = Navigation or Position
4 = Panel
5 = Landing
6 = Taxi
7 = Recognition
8 = Wing
9 = Logo
10 = Cabin

11 = Pedestrian

12 = Glareshield

13 = Ambient

Tells the sim what type of light is being defined for the aircraft. Yes
LocalPosition

1D Table of 3 values: z, x, y

The local position offset position relative to the Datum Reference Point. Values are in . Yes
LocalRotation 1D Table of 3 values: x, y, z The local angle of rotation for the light. Values are in degrees from -360° to 360°. Yes
EffectFile FX file ID The FX file that describes the light. These files have *.fx extensions and should be placed in the root effects folder. Yes
Node Node name The aircraft node to which you attach the light. No
PotentiometerIndex Integer This drives the light intensity of the light indexed when using the SimVar LIGHT_POTENTIOMETER. Yes
EmMesh File ID The node name where the light is attached. No

 

Below you can see an example of a light definition:

lightdef.18 = Type:4#LocalPosition:-1.2,0.65,14.0#LocalRotation:0,0,0#EffectFile:fx_cockpit_small_yellow,#PotentiometerIndex:2

 

Legacy Lights

When working with legacy aircraft from FSX (for example) you will find that lights were defined slightly differently. Here we explain the format used for those lights, but for new aircraft you should be using the lightdef.N parameter.

 

Legacy lights are defined using the following parameter:

 

Parameter Description Type Required
light.N
This is a light definition comprised of a 1D table of values. Lights are numbered from 0.

1D Table of Values

(see Data Types for more information)

No

 

The table for these lights takes 8 entries, listed below:

 

Position Description Type Required
0 This defines which circuit, or switch, the light is connected to. Multiple lights may be connected to a single switch.

Integer:

1 = Beacon
2 = Strobe
3 = Navigation or Position
4 = Panel
5 = Landing
6 = Taxi
7 = Recognition
8 = Wing
9 = Logo

10 = Cabin

11 = Pedestrian

12 = Glareshield

13 = Ambient

Yes
1 The z position relative to the Datum Reference Point, in . Float

Yes

(unless a NODE is specified, see below)

2 The x position relative to the Datum Reference Point, in . Float
3 The y position relative to the Datum Reference Point, in . Float
4 The X axis rotation, in degrees. Float No
5 The Y axis rotation, in degrees. Float
6 The Z axis rotation, in degrees. Float
7 The FX file name that is used by this light (for example, fx_navred). These files have *.fx extensions and should be placed in the root effects folder. String Yes

 

When writing out a light definition, you may specify a node on the aircraft model instead of the (z/x/y) position, and omit or include the rotation parameters depending on requirements. Below are examples of various combinations of data you can use to define a light:

; light.n = CircuitType, NODE_HELPER_NAME, fxfile
light.0 = 3, light_navigation_node, fx_navred

; light.n = CircuitType, ZOffset, XOffset, YOffset, XRotationInDegrees, YRotationInDegrees, ZRotationInDegrees, fxfile
light.0 = 3, -2.6, -17.4, 3.6, 90.0, 0.0, 0.0, fx_navred

; light.n = CircuitType, NODE_HELPER_NAME, XRotationInDegrees, YRotationInDegrees, ZRotationInDegrees, fxfile
light.0 = 3, light_navigation_node, 90.0, 0.0, 0.0, fx_navred

 

 

[ELECTRICAL]

This section controls everything related to the aircraft electrical systems. An electrical system is defined by its components, of which there are 5 types:

Each of these components can be defined multiple times as parameters within the [ELECTRICAL] configuration header. For how to access the information that these parameters add to an aircraft, please see the section on SimVars And Keys.

 

Parameter Description Type Required
circuit.N The aircraft bus hash table. You can define multiple buses for an aircraft, starting at N = 1. Details on the circuit map are given here: circuit.N

Hash Map

(see Data Types for more information)

Yes
battery.N The aircraft battery hash table. You can define multiple batteries for an aircraft, starting at N = 1. Details on the map contents are given here: battery.N

Hash Map

(see  for more information)

Yes
alternator.N The aircraft alternator hash table. You can define multiple alternators for an aircraft, starting at N = 1. Details on the map contents are given here: alternator.N

Hash Map

(see Data Types for more information)

Yes
externalpower.N The aircraft external power supply hash table. You can define multiple external power supplies for an aircraft, starting at N = 1. Details on the map contents are given here: externalpower.N

Hash Map

(see Data Types for more information)

Yes
bus.N The aircraft bus hash table. You can define multiple buses for an aircraft, starting at N = 1. Details on the map contents are given here: bus.N

Hash Map

(see Data Types for more information)

Yes
curve.N A 1D table of values. You can define multiple curves for an aircraft, starting at N = 1, and the curves can be used in multiple different parameters. Details on the table contents are given here: curve.N

1D Table of Values

(see Data Types for more information)

Yes
max_battery_voltage The maximum battery voltage. Float Yes
generator_alternator_voltage The generator alternator voltage. Float Yes
max_generator_alternator_amps The maximum alternator amperage. Float Yes
alternators Set to TRUE (1) to indicate that alternators are available, or FALSE (0) otherwise. Bool Yes
num_batteries The number of batteries available. Integer Yes
apu_pct_rpm_per_second This is a percentage of the maximum per second. Float Yes
electric_always_available

Set to TRUE(1) to always enable electrical equipment, otherwise set to FALSE(0).

Bool Yes
navcom1

Can be used to override default settings for the NAVCOM1 electrical circuit. (Bus type, max amp, min voltage)

This is a legacy parameter and should not be used except to support FSX aircraft.

Table No
navcom2

Can be used to override default settings for the NAVCOM2 electrical circuit. (Bus type, max amp, min voltage)

This is a legacy parameter and should not be used except to support FSX aircraft.

Table No
navcom3

Can be used to override default settings for the NAVCOM3 electrical circuit. (Bus type, max amp, min voltage)

This is a legacy parameter and should not be used except to support FSX aircraft.

Table No
battery_capacity_pct_to_voltage

Can be used to override default settings for correspondence between % Max Battery Capacity and voltage.

This is a legacy parameter and should not be used except to support FSX aircraft.

Table No
battery_max_capacity_amph

Can be used to override the default Battery Capacity (in ). Default is 24 or 42 depending on Battery Voltage.

This is a legacy parameter and should not be used except to support FSX aircraft.

Float No
battery_charging_current

Controls the battery's charging current (In Amps). Default is 10% of the capacity.

This is a legacy parameter and should not be used except to support FSX aircraft.

Float No
apu_pct_rpm_per_second

Controls the speed at which the 's RPM increases. Default is 0.4.

This is a legacy parameter and should not be used except to support FSX aircraft.

Float No

 

circuit.N

Circuits are the most used electrical components, and the circuit hash map is comprised of the following multiple  key:value pairs, separated by the # symbol. This hash map takes the following form:

circuit.N = Type:<circuit_type>:<index>#Connections:<bus:max_amp>#Power:<table>#Name:<debug_name>

Note that you may have more than one circuit of the same type, in which case you would increment the <value> parameter, starting from 1. A full example of a single circuit definition would be like this:

circuit.1 = Type:CIRCUIT_GENERAL_PANEL:1#Connections:bus.1#Power:0.5,1,20.0#Name:General_Panel_Main
Key Value Description Required
Type 1D Table Table that contains the type of circuit being created along with an identifying index for the circuit type (in case you wish to define multiple circuits of the same type). You can find a complete list of the available variables here: [ELECTRICAL] - circuit.N - Type Yes
Connections 1D Table

Table of the different buses that this circuit is connected to, eg:

Connections: bus.1, bus.3

You can find more information from the following section: [ELECTRICAL] - Connections

Yes
Power 1D Table of 3 Values

This table of three values is related to the power consumption, where:

  • 1st value: A minimum Watt consumption
  • 2nd value: A maximum/ideal Watt consumption
  • 3rd value: A minimum voltage

Here is an example of how this key/value pair is structured:

Power:10.0, 15.0, 20.0

You can find a full and detailed explanation of what these values refer to from the following section: [ELECTRICAL] - circuit.N - Power

Yes
Name String The name of the circuit. This is an identifier name and is only added for debugging purposes. Cannot contain special characters or spaces. No

 

battery.N

A battery is a power supplier with a set capacity that decreases over time depending on the load it must sustain. The battery hash map is comprised of a set of key:value pairs, separated by the # symbol and takes the following form:

battery.N = Connections:<buses>#Capacity:<value>#Voltage:<curve_ref>#Name:<debug_name>

A full example of a single battery definition would be like this:

battery.1 = Connections:bus.3#Capacity:13.6#Voltage:curve.1#Name:Main_Battery
Key Value Description Required
Connections 1D Table

Table of the different buses that this battery is connected to, eg:

Connections: bus.1, bus.3

You can find more information from the following section: [ELECTRICAL] - Connections

Yes
Capacity Float The battery capacity, in ampere hours.
Voltage Curve.N The voltage for capacity percentage, defined using a curve (explained in the curve.N section).
Name String The name of the battery. This is an identifier name and is only added for debugging purposes. Cannot contain special characters or spaces. No

 

alternator.N

This defines an alternator power source dependent on an engine/'s , and the appended number corresponds to its unique id (starting at 1). The alternator hash map is comprised of key:value pairs, separated by the # symbol, and takes the following form:

alternator.N = Connections:<buses>#iEng:<value>#Voltage:<curve_ref>#load:<curve_ref> #Name:<debug_name>

or:

alternator.N = Connections:<buses>#iEng:<value>#RatedVoltage:<value>#load:<curve_ref> #Name:<debug_name>

A full example of a single alternator definition would be like this:

alternator.1 = Connections:bus.3#iEng:0#RatedVoltage:28#Load:curve.3#Name:LH_Alternator
Key Value Description Required
Connections 1D Table

Table of the different buses that this alternator is connected to, eg:

Connections: bus.1, bus.3

You can find more information from the following section: [ELECTRICAL] - Connections

Yes
iEng Integer An engine index to get it's power from (starting at 0).
Voltage Curve.N The voltage for the given RPM or %RPM, defined using a curve (explained in the curve.N section). This should only be supplied if the RatedVoltage parameter is not used.
RatedVoltage Float The voltage that the alternator is rated for. This should only be supplied if the Voltage parameter is not used.   
Load Curve.N The load values based on RPM, defined using a curve (explained in the curve.N section).
Name String The name of the alternator. This is an identifier name and is only added for debugging purposes. Cannot contain special characters or spaces. No

 

externalpower.N

An external power source is a power supplier with a constant and infinite power output, and the appended number corresponds to its unique id (starting at 1). The external power hash map is comprised of key:value pairs, separated by the # symbol, and takes the following form:

externalpower.N = Connections:<buses>#RatedVoltage:<value>#Load:<value>#Name:<debug_name>

A full example of a single external power source definition would be like this:

externalpower.1 = Connections:bus.8#RatedVoltage:28.5#Load:400
Key Value Description Required
Connections 1D Table

Table of the different buses that this alternator is connected to, eg:

Connections: bus.1, bus.3

You can find more information from the following section: [ELECTRICAL] - Connections

Yes
RatedVoltage Float The voltage that the alternator is rated for.
Load Integer The load output, which is constant.
Name String The name of the external power source. This is an identifier name and is only added for debugging purposes. Cannot contain special characters or spaces. No

 

bus.N

A bus is a hub for connecting different components (and other buses) to each other, and the appended number corresponds to its unique id (starting at 1). The bus hash map is comprised of key:value pairs, separated by the # symbol, and takes the following form:

bus.N = Connections:<buses>#Name:<debug_name>

A full example of a single bus definition would be like this:

bus.3 = Connections:bus.1, bus.2#Name:Hot_Battery_BUS

 

Key Value Description Required
Connections 1D Table

Table of the different buses that this bus is connected to, eg:

Connections: bus.1, bus.3

You can find more information from the following section: [ELECTRICAL] - Connections

No
Name

string

The name of the bus. This is an identifier name and is only added for debugging purposes. Cannot contain special characters or spaces. No

 

curve.N

The curve parameter is defined as a 1D table of paired values, and the parameter is appended with a number that corresponds to its unique id (starting at 1). The exact number of paired values that are in the curve will depend on the use the curve is going to get, since curves are used by other parameters to store information. For example, you may have defined a battery like this:

battery.1 = Connections:bus.3,bus.5#Capacity:15.5#Voltage:curve.1#Name:Battery_Main

In this case, curve.1 references the battery voltage capacity, and would have been defined like this:

curve.1 = 0:21, 0.1:10.5, 0.5:12, 0.9:13, 1:13.4

 

 

[HYDRAULIC_SYSTEM]

This section controls the hydraulic pressure systems. Available parameters are:

 

Parameter Description Type Required
normal_pressure The normal hydraulic pressure, in . Float No
electric_pumps The number of electric pumps for the hydraulics. Integer
engine_map

This is a table of whether an engine has a hydraulic unit or not. For example:

1, 0, 0, 1

This means there are pumps on engines 1 and 4, but not on 2 and 3.

1D Table of Integers

(see Data Types for more information)

ailerons_require_hydraulics Sets whether the ailerons require hydraulics (TRUE, 1) or not (FALSE, 0). Bool
rudder_require_hydraulics Sets whether the rudder requires hydraulics (TRUE, 1) or not (FALSE, 0). Bool
spoilers_require_hydraulics Sets whether the spoilers require hydraulics (TRUE, 1) or not (FALSE, 0). Bool
elevator_require_hydraulics Sets whether the elevator requires hydraulics (TRUE, 1) or not (FALSE, 0). Bool

 

 

[PNEUMATIC_SYSTEM]

This section controls the pneumatic system of the aircraft. Available parameters are:

 

Parameter Description Type Required
max_pressure The maximum permitted pressure for the pneumatic system, in . Float No
apu_max_pressure The maximum pressure from the bleed permitted for the , in . Float No
bleed_air_scalar Pneumatic pressure is a function of bleed air from the turbine engine. This scalar is used to multiply this bleed air pressure. Float No

 

 

[VACUUM_SYSTEM]

This section controls the aircraft vacuum system. Available parameters are:

 

Parameter Description Type Required
max_pressure The maximum suction pressure, in . Float No
vacuum_type The type of vacuum system installed on the aircraft.

Integer:

1 = engine pump
2 = pneumatic
3 = venturi

No
electric_backup_pressure The electrical backup pressure value, in . Float No
engine_map

This is a table of whether an engine has a vacuum pump unit or not. For example:

1, 0, 0, 1

This means there are pumps on engines 1 and 4, but not on 2 and 3.

1D Table of Integers

(see Data Types for more information)

No
suction_gain Speed at which suction grows. Default is 0.85. Float No
suction_min Minimum suction value possible when system is operating. Default is 4.05. Float No

 

 

[PITOT_STATIC]

A pitot-static system is a system of pressure-sensitive instruments that is most often used in aviation to determine an aircraft's airspeed, Mach number, altitude, and altitude trend. This section permits you to set certain attributes for using this system. Available parameters are:

 

Parameter Description Type Required
vertical_speed_time_constant This is a speed-time constant, used for the vertical speed generation in gauges. Values in 1/seconds. Increasing will cause a more instantaneous reaction in the visual speed indicator Float Yes
pitot_heat Pitot heat scalar value used to weight temperature increase for pitot system. Float Yes

 

 

[STALL_WARNING]

This section controls the stall warning system. Available parameters are:

 

Parameter Description Type Required
type The warning system type.

Integer:

0 = normal
1 = electric

No
stick_shaker Whether force feedback stick shaking is enabled (TRUE, 1) or not (FALSE, 0). Bool No

 

 

[DEICE_SYSTEM]

This section controls the de-ice system. Available parameter is:

 

Parameter Description Type Required
structural_deice_type The de-ice type on the aircraft.

Integer:

0 = none
1 = bleed air heated leading edge
2 = bleed air boots
3 = engine vacuum pump boots

No

 

 

[RADIOS]

This section controls the aircraft radios. Note all systems listed here start at N = 1, and the available parameters are:

 

Parameter Description Type Required
TransponderDefault Default Frequency of the aircraft (will be overridden by FLT and ATC values). Default is 1234. Float No
Audio.N Set whether audio system N is available (TRUE, 1) or not (FALSE; 0). At least 1 audio system needs to be defined. Bool Yes
Com.N Set whether the com receiver N is available (TRUE, 1) or not (FALSE; 0) and whether it has a standby (TRUE, 1) or not (FALSE, 0). At least 1 com receiver needs to be defined, and you can have a maximum of 2.

1D Table of Bools

(see Data Types for more information)

Yes
Nav.N Set whether the navigation receiver N is available (TRUE, 1) or not (FALSE; 0), whether it has a standby (TRUE, 1) or not (FALSE, 0), and whether it has glide-slope (TRUE, 1) or not (FALSE, 0). At least 1 com receiver needs to be defined, and you can have a maximum of 4.

1D Table of Bools

(see Data Types for more information)

Yes
Adf.N Set whether the system N is available (TRUE, 1) or not (FALSE; 0) and whether it has a standby (TRUE, 1) or not (FALSE, 0). At least 1 system needs to be defined, and you can have a maximum of 2.

1D Table of Bools

(see Data Types for more information)

Yes
Transponder.N Set whether the transponder N is available (TRUE, 1) or not (FALSE; 0). At least 1 transponder needs to be defined.     Bool Yes
Marker.N Set whether the marker system N is available (TRUE, 1) or not (FALSE; 0). At least 1 marker system needs to be defined.     Bool Yes

 

 

[GEAR_WARNING_SYSTEM]

This section controls the gear warning system. Available parameters are:

 

Parameter Description Type Required
gear_warning_available Set's what type of gear warning is available.

Integer:

  1. 0 = None
  2. 1 = Normal
  3. 2 = Amphibian
True
flap_limit_power If flaps are extended beyond this limit - expressed as a percentage - then a warning will be give. Float True
flap_limit_idle This value is the check for minimum throttle positions if flaps are extended beyond this limit. Float True
pct_throttle_limit When flap limit idle is reached, a landing warning will be activated if throttle lever position goes below this limit, expressed as a percentage.   True

 

 

[AUTOPILOT]

This section controls the aircraft autopilot systems. Available parameters are:

 

Parameter Description Type Required
autopilot_available Setting this to 1 (TRUE) makes the autopilot system available to the aircraft, otherwise set it to 0 (FALSE) to disable autopilot. Bool Yes
flight_director_available Setting this to 1 (TRUE) makes the flight director available to the aircraft, otherwise setting it to 0 (FALSE) will disable the flight director. Bool Yes
min_feet_for_ap  Set the height (in ) below which the autopilot is automatically disabled. Default is -1000 (essentially disabled). Float No
min_flight_time_for_ap Set the time (in seconds) after takeoff until the autopilot can be enabled. Default is 0 (essentially disabled). Float No
default_vertical_speed The default vertical speed, in  per second, that the autopilot will command when selecting a large altitude change.     Float No
autothrottle_available When this is set to 1 (TRUE) it makes available an autothrottle system on the aircraft. Set to 0 (FALSE) otherwise. Bool No
autothrottle_arming_required When this is set to 1 (TRUE) the autothrottle is required to be armed prior to it being engaged. Setting it to 0 (FALSE) allows the autothrottle to be engaged directly. Bool No
autothrottle_does_not_move_lever When this is set to 1 (TRUE) the autothrottle will not move the throttle lever. Set it to 0 (FALSE) if this is not the behavior you require. Bool No
autothrottle_managed_by_plane When this is set to 1 (TRUE) the autothrottle will be managed automatically by the aircraft. Set it to 0 (FALSE) if this is not the behavior you require. Bool No
autothrottle_takeoff_ga If this is set to 1 (TRUE) then takeoff / go-around operations with the autothrottle will be enabled. 0 (FALSE) disables this behavior. Float No
autothrottle_max_rpm This sets the highest engine speed that the autothrottle will attempt to maintain as a percentage of the maximum engine speed. Float No
pitch_takeoff_ga The default pitch that the Takeoff/Go-Around mode references, in degrees. Float No
autoland_available Setting this to 1 (TRUE) makes the autopilot autoland system available to the aircraft, otherwise set it to 0 (FALSE) to disable autoland. Bool No
altimeter_indicator Indicates which altimeter indicator system on the aircraft is being referenced by the autopilot. Integer No
attitude_indicator Indicates which attitude indicator system on the aircraft is being referenced by the autopilot Integer No
direction_indicator Indicates which direction indicator system on the aircraft is being referenced by the autopilot, where 0 is the first (and default). Integer No
use_no_default_pitch Setting this to 1 (TRUE) tells the autopilot not to use the default pitch option. Set to 0 (FALSE) to use it. Bool No
default_pitch_mode This determines the default pitch mode when the autopilot is enabled.

Integer:

  1. 0 = None
  2. 1 = Pitch
  3. 2 = Altitude
  4. 3 = Vertical Speed
No
pitch_use_trim When set to 1 (TRUE) the autopilot will use the trim to hold pitch, and when set to 0 (FALSE) it will use the elevator directly. Bool No
max_pitch The maximum pitch angle, in degrees, that the autopilot will command either up or down. Float No
max_pitch_acceleration The maximum angular pitch acceleration, in degrees per second squared, that the autopilot will command up or down. Float No
max_pitch_velocity_lo_alt The maximum angular pitch velocity, in degrees per second, which the autopilot will command when at an altitude below that specified by the parameter max_pitch_velocity_lo_alt_breakpoint. Float No
max_pitch_velocity_hi_alt The maximum angular pitch velocity, in degrees per second, which the autopilot will command when at an altitude above the altitude specified by the parameter max_pitch_velocity_hi_alt_breakpoint. The maximum velocity is interpolated between the hi and lo altitude velocities when between the hi and lo altitude breakpoints.
 
Float No
max_pitch_velocity_lo_alt_breakpoint The altitude below which the autopilot maximum pitch velocity is limited by the parameter max_pitch_velocity_lo_alt. Float No
max_pitch_velocity_hi_alt_breakpoint The altitude above which the autopilot maximum pitch velocity is limited by the parameter max_pitch_velocity_hi_alt. The maximum velocity is interpolated between the hi and lo altitude velocities when between the hi and lo altitude breakpoints. Float No
use_no_default_bank Setting this to 1 (TRUE) tells the autopilot not to use the default bank option. Set to 0 (FALSE) to use it.

Bool

No
default_bank_mode This determines the default bank mode when the autopilot is enabled.

Enum:

  1. 0 = None
  2. 1 = Wing level
  3. 2 = Heading
  4. 3 = Roll Hold
No
max_bank_acceleration The maximum angular bank acceleration, in degrees per second squared, that the autopilot will command left or right. Float No
max_bank_velocity The maximum angular bank velocity, in degrees per second, which the autopilot will command left or right. Float No
max_bank The maximum bank angle, in degrees, that the autopilot will command either left or right. Float No
auto_max_bank If 1 (TRUE) it adds an extra max bank selection for the autopilot that automatically changes depending on the airspeed. Set to 0 (FALSE) to disable the option. Bool No
auto_max_bank_table

Sets the correspondence between an airspeed (in s) and a max bank value (in degrees). For example:

auto_max_bank_table=0.000000:15.000000, 249.900000:15.000000, 250.000000:25.000000

2D Table of Floats

(see Data Types for more information)

No
auto_max_bank_min_alt Sets the altitude (in ) above ground level below which the max bank angle is limited (see auto_max_bank_min_alt_angle) in feet. Float No
auto_max_bank_min_alt_angle Sets the max bank angle (in degrees) when the plane is in auto max bank angle mode below the minimum altitude set by auto_max_bank_min_alt. Float No
max_throttle_rate This value sets the maximum rate at which the autothrottle will move the throttle position. In the example, the maximum rate is set to 10% of the total throttle range per second. Float No
pitch_proportional_control Pitch proportional controller constant. Float No
pitch_integrator_control Pitch integral controller constant. Float No
pitch_derivative_control Pitch derivative controller constant. Float No
pitch_integrator_boundary The boundary, or maximum signal error, in degrees in which the pitch integrator function is active. Float No
pitch_derivative_boundary The boundary, or maximum signal error, in degrees in which the pitch derivative function is active. Float No
roll_proportional_control Roll proportional controller constant. Float No
roll_integrator_control Roll integral controller constant. Float No
roll_derivative_control Roll derivative controller constant. Float No
roll_integrator_boundary The boundary, or maximum signal error, in degrees in which the roll integrator function is active. Float No
roll_derivative_boundary The boundary, or maximum signal error, in degrees in which the roll derivative function is active. Float No
hdg_proportional_control Heading proportional controller constant. Float No
hdg_integrator_control Heading integral controller constant. Float No
hdg_derivative_control Heading derivative controller constant. Float No
hdg_integrator_boundary The boundary, or maximum signal error, in degrees in which the heading integrator function is active. Float No
hdg_derivative_boundary The boundary, or maximum signal error, in degrees in which the heading derivative function is active. Float No
vs_proportional_control Vertical speed proportional controller constant. Float No
vs_integrator_control Vertical speed integral controller constant. Float No
vs_derivative_control Vertical speed derivative controller constant. Float No
vs_integrator_boundary The boundary, or maximum signal error, in degrees in which the vertical speed integrator function is active. Float No
vs_derivative_boundary The boundary, or maximum signal error, in degrees in which the vertical speed derivative function is active. Float No
nav_proportional_control_ex1 Proportional controller constant in lateral navigation modes. Float No
nav_integrator_control_ex1 Integral controller constant in lateral navigation modes. Float No
nav_derivative_control_ex1 Derivative controller constant in lateral navigation modes. Float No
nav_integrator_boundary_ex1 The boundary, or maximum signal error, in degrees in which the integrator function is active. Float No
nav_derivative_boundary_ex1 The boundary, or maximum signal error, in degrees in which the derivative function is active. Float No
nav_yaw_proportional_control Proportional controller constant in yaw navigation modes.     Float No
nav_yaw_integrator_control Integral controller constant in yaw navigation modes. Float No
nav_yaw_derivative_control Derivative controller constant in yawnavigation modes. Float No
nav_yaw_integrator_boundary The boundary, or maximum signal error, in degrees in which the yaw integrator function is active. Float No
nav_yaw_derivative_boundary The boundary, or maximum signal error, in degrees in which the yaw derivative function is active. Float No
gs_proportional_control Proportional controller constant in glideslope mode. Float No
gs_integrator_control Integral controller constant in glideslope mode. Float No
gs_derivative_control Derivative controller constant in glideslope mode. Float No
gs_integrator_boundary The boundary, or maximum signal error, in degrees in which the glideslope integrator function is active. Float No
gs_derivative_boundary The boundary, or maximum signal error, in degrees in which the derivative function is active. Float No
yaw_damper_gain The proportional gain on the yaw dampers yaw rate error. Float No
head_hold_pid

The full heading hold  definition for the propeller, as a table. Follows the format of:

P, I1, I2, D, I1-boundary, 12-Boundary, D-boundary

1D Table of Floats

(see Data Types for more information)

No
airspeed_hold_pid

The full airspeed hold  definition for the propeller, as a table. Follows the format of:

P, I1, I2, D, I1-boundary, 12-Boundary, D-boundary

1D Table of Floats

(see Data Types for more information)

No
max_altitude_ref Sets the maximum altitude (in ) that can be set in the Autopilot. Defaults to 99900. Float No
max_vertical_speed_ref Sets the maximum vertical speed (in  per minute) that can be set in the Autopilot. Defaults to 9900. Float No
min_vertical_speed_ref Sets the minimum vertical speed (in  per minute) that can be set in the Autopilot. Defaults to 9900. Float No
min_IAS_ref Sets the minimum  reference (in ) that can be set in the Autopilot. Default is 0. Float No
max_IAS_ref Sets the maximum  reference (in ) that can be set in the Autopilot. Default is 0. Float No
min_Mach_ref Sets the minimum that can be set in the Autopilot. Defaults to 0. Float No
max_Mach_ref Sets the maximum  that can be set in the Autopilot. Defaults to 0. Float No
alt_mode_slot_index Set the selected altitude slot index reserved for Alt mode, 0 will use the current selected index. Integer No
flc_proportional_control The proprotional control mode value. Default is 20.0. Float No
flc_integrator_control The   integrator control mode value. Default is 1.0. Float No
flc_derivative_control The derivative control mode value. Default is 50.0. Float No
flc_integrator_boundary The   integrator control boundary. Default is 100.0. Float No
flc_derivative_boundary The derivative control boundary. Default is 1000.0. Float No
flc_min_pitch_low_alt Sets the minimum AP pitch (in degrees) when the plane is in mode and below flc_min_low_alt_limit. Float No
flc_min_low_alt_limit Sets the maximum height (in ) below which the pitch in  mode is limited. Disabled if <=0. Default is 0. Float No
min_feet_for_athr Set the height (in ) below which the auto-throttle is automatically disabled. Disabled by default. Float No
altitude_english_slow_increment Sets the slow increments (in ) of the autopilot's altitude when in english units. Float No
altitude_english_fast_increment Sets the fast increments (in ) of the autopilot's altitude when in english units. Float No
altitude_english_fastest_increment Sets the fastest increments (in ) of the autopilot's altitude when in english units. Float No
altitude_metric_slow_increment Sets the slow increments (in meters) of the autopilot's altitude when in metric units. Float No
altitude_metric_fast_increment Sets the fast increments (in meteres) of the autopilot's altitude when in metric units. Float No
altitude_metric_fastest_increment Sets the fastest increments (in meters) of the autopilot's altitude when in metric units. Float No
metric_VS_increment Sets the increments of the autopilot's vertical speed when in metric units (meters per minute). Float No
english_VS_increment Sets the increments of the autopilot's vertical speed when in english units ( per minute). Float No
IAS_slow_increment Sets the slow increments of the autopilot's target speed (in s). Float No
IAS_fast_increment Sets the fast increments of the autopilot's target speed (in s). Float No
IAS_fastest_increment Sets the fastest increments of the autopilot's target speed (in s). Float No
mach_increment Sets the increments of the autopilot's target speed (in ). Float No
hdg_ref_var Set the compass variable to be used as the source of heading reference.

Enum:

  1. 0 = Magnetic
  2. 1 = Gyro
No

 

 

[SMOKESYSTEM]

This section controls the aircraft smoke system. Available parameter is:

 

Parameter Description Type Required
smoke.N

Each parameter N defines a smoke point position, where N starts at 0. Points are defined as a table of values using the following order:

z, x, y, fx_name

The position values are the local position offset relative to the Datum Reference Point (in  and the fx_name value is the name of one of the FX files that should be used.

1D Table of Floats

(see Data Types for more information)

No

 

 

[FOLDING_WINGS]

If the aircraft being defined has folding wings, this section should be included. Available parameters are:

 

Parameter Description Type Required
wing_fold_system_type The type of system used to fold the wings

Integer:

  1. 0 = Hydraulic
  2. 1 = Electrical
  3. 2 = Pneumatic
  4. 3 = Manual
No
fold_rates The folding rates for the left wing and right wing, as a table of two values (left, right). Rates are expressed as 1/seconds.

1D Table of Floats

(see Data Types for more information)

No

 

 

[VOICEALERTS]

This section controls any voice alerts for the aircraft. Available parameters are:

 

Parameter Description Type Required
LowFuelPct

Sets the low fuel warning voice alert, as a table of 3 values in the following order:

check_value, check_type, check_frequency

For check_type +1, -1, or 0, representing greater than, less than or equal to.

1D Table of Floats

(see Data Types for more information)

No
OverGLimit

Sets the over G limit, as a table of 3 values in the following order:

check_value, check_type, check_frequency

For check_type +1, -1, or 0, representing greater than, less than or equal to.

1D Table of Floats

(see Data Types for more information)

No

 

 

[PRESSURIZATION]

This section controls the cabin pressurization systems. Available parameters are:

 

Parameter Description Type Required
design_cabin_pressure The cabin pressure, as designed, in . Float No
max_pressure_differential The maximum pressure deferential permitted, in . Float No

 

 

[AUXILIARY POWER UNIT]

This section controls systems. Available parameter is:

 

Parameter Description Type Required
Available Indicates whether there is an system (TRUE, 1) or not (FALSE, 0). Bool No

 

 

[WATER BALAST SYSTEM]

This section controls the water balance system for gliders. Available parameters are:

 

Parameter Description Type Required
NumberOfReleaseValves The number of ballast release valves available. Integer No
DumpRate The dump rate for the ballast, in s per second. Float No
Tank.N

Each parameter N defines a ballast tank, where N starts at 0. Tank details are defined as a table of values using the following order:

max_weight, z, x, y, valve_index

The weight is in s, the position values are the local position offset relative to the Datum Reference Point (in , and the index is the valve index (from 1 to NumberOfReleaseValves). Tanks are numbered from 0 to 5 where:

  • 0 = Front Fuselage
  • 1 = Rear Fuselage
  • 2 = Left Outboard
  • 3 = Left Inboard
  • 4 = Right Inboard
  • 5 = Right Outboard

1D Table of Floats

(see Data Types for more information)

No

 

 

[LocalVars]

This section can be used to set the initial value of persistent local variables to be used in the XML Model Behaviours templates and gauges. When an aircraft is selected by a user and the flight is first started, these "LocalVars" are defined (using the LocalVar.N parameter) and then initialised using a default value (done using the LocalVarDefault.N parameter). Any changes to these variables that have been made will then be saved to a file (states.cfg) when the flight is exited. This file will be saved to a local location on the users computer using the following path schema:

C:\Users\<USERNAME>\AppData\Roaming\Microsoft Flight Simulator\SimObjects\<AIRCRAFT_NAME>\states.cfg

The next time the aircraft is used, the local variables will be initialised as before, only now they will be set to the values stored in the states.cfg. Note that if you define a variable here but don't initialise it, then the first time it is used it will be considered as having a value of 0. 

 

Parameter Description Type Required
LocalVar.N

This defines the name of one or more local variables that will have their value saved. Each variable should be defined as a string, and is indexed from 0. For example:

LocalVar.0 = myLocalVariable

String No
LocalVarDefault.N

This defines a local variable default value. Each variable defined using the  parameter should have a corresponding default value and index. For example:

LocalVarDefault.0 = 10

int/float/string, etc... No

 

 

©2021 Microsoft      Contact Us      Privacy Policy      MSFS Forums      SDK Q&A Support