SDK FS2004

8/10/2019 SDK FS2004

1/68

Microsoft Flight Simulator 2004:A Century of FlightSoftware Development Kit

Aircraft Container System

February 2004

8/10/2019 SDK FS2004

2/68

Aircraft Container SDK Overview ............................................................................................................. 1

File hierarchy................................................................................................................................................ 2

The aircraft.cfg file....................................................................................................................................... 3

Introduction................................................................................................................................................ 3

Testing Changes to aircraft.cfg .................................................................................................................. 3

Configuration sets and their [fltsim. ] sections ......................................................................................... 4

[General] section ....................................................................................................................................... 7

[forcefeedback] section .............................................................................................................................. 8Stick shaker parameters.......................................................................................................................... 8Gear bump parameters............................................................................................................................ 9Ground bumps parameters...................................................................................................................... 9Crash parameters .................................................................................................................................. 10

[Reference_Speeds] section...................................................................................................................... 10

[flight_tuning] section.............................................................................................................................. 11Flight control effectiveness parameters................................................................................................ 11Stability parameters.............................................................................................................................. 11Lift parameter ....................................................................................................................................... 12High Angle of Attack parameters......................................................................................................... 12Propeller-induced turning effect parameters......................................................................................... 12Drag parameters.................................................................................................................................... 13

[weight_and_balance] section ................................................................................................................. 13Moments of Inertia ............................................................................................................................... 16

[fuel] section............................................................................................................................................. 17

[GeneralEngineData] section .................................................................................................................. 17

[piston_engine] section ............................................................................................................................ 18

[propeller] section.................................................................................................................................... 20

[TurbineEngineData] section................................................................................................................... 22

[jet_engine] section.................................................................................................................................. 23

[turboprop_engine] section...................................................................................................................... 23

[contact_points] section ........................................................................................................................... 23

[gear_warning_system] section ............................................................................................................... 26

[brakes] section........................................................................................................................................ 27[airplane_geometry] section .................................................................................................................... 27

[flaps.n] section........................................................................................................................................ 30

[electrical] section.................................................................................................................................... 31

[pitot_static] section................................................................................................................................. 34

[exits] section ........................................................................................................................................... 35

[views] section.......................................................................................................................................... 35

i

8/10/2019 SDK FS2004

3/68

[lights] section.......................................................................................................................................... 35

[keyboard] section.................................................................................................................................... 36

[radios] section ........................................................................................................................................ 37

[smokesystem] section.............................................................................................................................. 37

[effects] section ........................................................................................................................................ 37[hydraulic_system] section....................................................................................................................... 38

[stall_warning] section ............................................................................................................................ 39

[direction_indicators] section .................................................................................................................. 39

[attitude_indicators] section .................................................................................................................... 39

[turn_indicators] section.......................................................................................................................... 39

[airspeed_indicators] section................................................................................................................... 40

[autopilot] section .................................................................................................................................... 40

Helicopter specific sections ........................................................................................................................ 45

[helicopter] section .................................................................................................................................. 45

[fuselage_aerodynamics] section............................................................................................................. 48

[MainRotor] section ................................................................................................................................. 48

[SecondaryRotor] section......................................................................................................................... 49

The kneeboard content files....................................................................................................................... 50

Creating or modifying the Checklist and Reference pages....................................................................... 51

The panel.cfg file......................................................................................................................................... 51

The model.cfg file ....................................................................................................................................... 51

Introduction.............................................................................................................................................. 51

[models] section ....................................................................................................................................... 51

The sound.cfg file........................................................................................................................................ 52

Introduction.............................................................................................................................................. 52

[fltsim] section.......................................................................................................................................... 52

[sound_engine] section ............................................................................................................................ 53[sound_engine] parameters for jet aircraft............................................................................................ 53[sound_engine] parameters for turboprop aircraft ................................................................................ 54[sound_engine] parameters for piston aircraft ...................................................................................... 55

Specific engine sound sections (sound lists)............................................................................................. 56

[wind_sound] section ............................................................................................................................... 57

Ground sound sections ............................................................................................................................. 59

Other sound sections ................................................................................................................................ 61

ii

8/10/2019 SDK FS2004

4/68

The Texture folder...................................................................................................................................... 63

Using aliasing .............................................................................................................................................. 64

An example ............................................................................................................................................... 64

iii

8/10/2019 SDK FS2004

5/68

Aircraft Container SDK OverviewThe Aircraft Container system organizes Flight Simulator aircraft files and attributes so that most

aircraft-related files are located close together. This logical and consistent organization makes

the files easy to customize. This document includes the following sections: File hierarchy

Provides an overview of the aircraft container systems organizational structure.

The aircraft.cfg fileExplains the structure of and parameters in an aircrafts aircraft.cfg file, including the use

of configuration sets that enable components to be shared among several aircraft.

The kneeboard content files

Explains the structure of the files that populate the tabs of the kneeboard, and how tocustomize them.

The panel.cfg fileProvides a brief description of an aircrafts panel.cfg file.

The model.cfg fileExplains the structure of and parameters in an aircrafts model.cfg file

The sound.cfg fileExplains the structure of and parameters in an aircrafts sound.cfg file

The Texture folder

Describes the contents of an aircrafts Texture folder.

Using AliasingExplains how to use aliasing to avoid file duplication by sharing components among

several aircraft.

Important Notes:

This SDK documents the aircraft container system and related files as implemented inFlight Simulator 2004. Not all of the features and functionality described here are

backward-compatible with aircraft from earlier versions of Flight Simulator and Combat

Flight Simulator.

This document contains information on how to modify and share components among

existing aircraft. It does not explain how to create new aircraft.

The .cfg files referenced in this document are simple text files (configuration files with

a .cfg extension) and can be viewed and edited using any text editor, such as MicrosoftNotepad. They can be found in the appropriate aircraft subfolders of the FS9\Aircraft

folder. To become more familiar with the structure and syntax used in .cfg files, you

should view actual files as you read this document. These files should be modified only

and with caution--by experienced developers, as changes could render aircraft

inoperable.

1

8/10/2019 SDK FS2004

6/68

The information included in this SDK is not supported by Microsoft Product Support.

File hierarchyThe aircraft container system organizes aircraft-related files and folders in a hierarchical and

consistent way and mirrors the way the files interact with one another. An aircraft container issimply an aircraft folder within the FS9\Aircraft folder. Each aircraft folder (e.g., B737_400,

Lear45, C182) contains:

aircraft.cfg Specifies which model, panel, sound, texture, and kneeboard components touse, as well as certain aircraft-specific parameters.

aircraftname.air Contains the aircrafts flight model.

aircraftname_check.htm Provides aircraft-specific text for the Checklists tab of the

kneeboard.

aircraftname_ref.htm Provides aircraft-specific text for the Reference tab of thekneeboard.

Model folder Contains the model.cfg file that specifies the visual models to render

during normal flight and during a crash, as well as the visual model color scheme. Also

contains the .mdl visual model files.

Panel folder Contains the panel.cfg file that defines the layout of an aircraftsinstrument panels and view parameters. Also contains associated .bmp files. (For detailed

information about panels, see the Panels SDK.)

Sound folder Contains the sound.cfg file that describes the aircrafts sounds and the

initial, minimum, and maximum volume associated with each sound. Also containsassociated .wav files.

Texture folder Contains textures (.bmp files) used in the presentation of the aircrafts

visual model.

Note that through aliasing, more than one aircraft can access and use the same panel, model, andsound .cfg files (and hence the same panel, model, and sound component files) without copyingthe files to all the aircraft containers. For more information, see Using Aliasinglater in this

document.

2

8/10/2019 SDK FS2004

7/68

The aircraft.cfg file

Introduction

The aircraft.cfg file represents the highest level of organization within an aircraft container. Eachaircraft has its own aircraft.cfg file located in its container (aircraft folder). For example, the

Cessna 182S aircraft.cfg can be found at

drive:\..\FS9\Aircraft\C182\aircraft.cfg

The aircraft.cfg file specifies the versions of the aircraft included in the aircraft container, as well

as the attributes (name, color, sound, panels, gauges, and so on) for each aircraft and where to

find the files that define those attributes.

Within the aircraft.cfg file there are a number of sections. Brackets enclosing the section name

identify the various sections. In order for Flight Simulator to make proper use of any variable, it

is important that the variable be located in the correct section. While exact spelling is important,none of the terms is case-sensitive.

Testing Changes to aircraft.cfg

To see the effects of a change, the aircraft must be reloaded. Aircraft are loaded into the memorycache from disk, so you have to flush the cache to enable your changes to be reflected in-game.

This involves a couple steps:

1. Configure a key command to Reload User Aircraft. Set up a key command to reloadyour aircraft from within the simulation. Go to Settings, Controls Assignments, and

scroll down to the Reload User Aircraft event. By default, its unassigned. UseChange Assignmentto configure a keystroke combination for this event. Once

assigned, you can use this key command to reload the aircraft within the simulation.

2. Turn off AI Traffic in the game. AI traffic aircraft are maintained in the cache and even ifyou update the aircraft youre currently piloting, if the same aircraft is being used by AI

traffic, then your cache wont get updated automatically by simply reloading the plane.So to ensure your aircraft is reloaded from disk, you must also go to the Settings Screen,

choose Traffic, and set the Air Traffic Density slider all the way to the left to 0%.

Now you can test changes made to aircraft.cfg within the game by using the Reload User

Aircraft key command.

3

8/10/2019 SDK FS2004

8/68

Any errors made in creating or editing the aircraft.cfg file will show up, along with the followingerror messages, while an aircraft is being loaded. The error messages are listed in order; that is,

the first error message represents an error early in the aircraft-loading process.

Error Message DescriptionAircraft initializationfailure.

Indicates that some essential files are missing from the aircraftcontainer. If the files are missing, the aircraft wouldn't usually bedisplayed in the Select Aircraft dialog box; as a result, this error israre.

Failed to start up theflight model.

The .air file was not loaded successfully.

This is not a FlightSimulator aircraft model.

The visual model (.mdl) file for this aircraft is not compatible withFlight Simulator

Visual model could not bedisplayed.

An error occurred while loading the visual model (.mdl) file.

The following sections detail each bracketed aircraft.cfg section and its associated parameters. As

you read, you should look at actual aircraft.cfg files to become more familiar with the structureand syntax of them. They can be found in the individual aircraft containers, and viewed using

any text editor.

Configuration sets and their [fltsim. ] sections

Each [fltsim. ]section of an aircraft.cfg file represents a different version (configuration) of

the aircraft, and is known as a configuration set. Configuration sets allow a single aircraft

container to represent several aircraft, and allow those aircraft to share components.

If there is only one section (labeled [fltsim.0]), it is because there is only one configuration setin that aircraft container. If there is more than one configuration set (labeled [fltsim.0],

[fltsim.1], [fltsim.2], and so on), each one refers to a different version of the aircraft.

For instance, there are five versions of the Cessna 182, all housed in the same C182 aircraft

container (folder). Each version has its own [fltsim. ]section. The various versions must

vary by their title, and may also vary other items such as the panel, description, or sounds.

While these configuration sets share many components, they can each use different panels. The

panel lines in the respective [fltsim. ] sections thus refer to the respective panel folder for

each aircraft: For example, the panel=parameter in the [fltsim.1]section is panel=ifr

means that this version of the C182 uses the panel files in the panel.ifr subfolder.

When creating and referencing multiple model, panel, sound, and texture directories, use the

naming conventionfoldername.extension, where the extension is a unique identifier for thatconfiguration set (e.g., .ifr). To refer to the folder from the relevant parameter in the aircraft.cfg

file, just specify extension(e.g., panel=ifr). If a parameter isn't explicitly set (as in the

[fltsim.1]section in the example above), it automatically refers to the default (extension-less)

folder.

4

8/10/2019 SDK FS2004

9/68

The parameters in each configuration set can refer to the same files, to different files, or to a mix

of files. While using different panels, all Cessna configurations use the same sounds, and thus the

sound parameters in all three [fltsim. ]sections point to the single sound folder in the C182

folder.

Each aircraft defined by a configuration set will appear as a separate listing in the Select Aircraftdialog box. The fact that multiple aircraft share some components is hidden from the user.

From a users perspective, they are distinct aircraft (just as if all the common files wereduplicated and included in three distinct aircraft containers). From a developers perspective, the

aircraft are really just different configuration sets of the same aircraft. Because they share some

files, they make much more efficient use of disk space.

Within each [fltsim. ] section are parameters that define the details of that particular

configuration set:

Parameter Example Description

title title= Cessna Skylane 182S The title of the aircraft that will appear in theSelect Aircraft dialog.

sim sim= Cessna182S Specifies which .air (flight model) file(located in the aircraft folder) to use.

model model= Specifies which model folder to reference.panel panel= Specifies which panel folder to reference.sound sound= Specifies which sound folder to reference.

texture Texture= Specifies which texture folder to reference.kb_checklists kb_checklists=

Cessna182S_checkSpecifies which _check.txt file (located inthe aircraft folder) to use on the Checkliststab of the kneeboard.

kb_reference kb_reference= Cessna182S_ref Specifies which _ref.txt file (located in theaircraft folder) to use on the Reference tab

of the kneeboard.atc_id atc_id= N700MS The tail number displayed on the exterior of

the aircraft. This parameter can also beedited from the Select Aircraft dialog (if theatc_id_enable parameter is set to 1). Notapplicable to imported Flight Simulator 98or Combat Flight Simulator aircraft. .(Note: custom tail numbers burned intotextures will not be modified by this).

atc_id_color atc_id_color=0xc6eff7ff Specifies, in RGB hexadecimal, the color ofthe tail number. The first two charactersfollowing the 0x specify the red value inhex, the second two characters the green,

and the third set the blue. The final twocharacters are unused. Each value can bebetween 0 ff hex, which is 0 to 255decimal. (Note: custom tail numbersburned into textures will not be modified bythis).

5

8/10/2019 SDK FS2004

10/68

atc_id_font atc_id_font=Verdana,-11,1,600,0

Specifies how the tail number is displayedon the aircraft. The first field specifies thefont. The second is the relative height ofthe tail number characters. The third fieldshould be 1, indicating to use your systemsdefault character set. The fourth fieldrepresents the relative heaviness of thecharacters. The final field is a flag thatspecifies the characters to be italicized.The example shown is the default used inFS. (Note: custom tail numbers burned intotextures will not be modified by this).

atc_parking_types atc_parking_types=CARGO,RAMP Specifies the preferred parking for thisaircraft, used by ATC. If this line is omitted,

ATC will determine parking according to thetype of aircraft and parking available. Ifmultiple values are listed, preference will begiven in the order in which they are listed.The valid values may be one or more of thefollowing: RAMP, CARGO, GATE, DOCK,

MIL_CARGO, MIL_COMBAT.atc_parking_codes atc_parking_codes=AAL Specifies an ICAO airline designation so

that ATC can direct the aircraft to a gatethat has also been designated specificallyfor that same airline (e.g. AAL for American

Airlines). Documentation on specifyingparking spaces can be found in theScenery Facilities Database document.

atc_heavy atc_heavy=1 Setting this flag to 1 will result in the ATCsystem appending the phrase heavy tothe aircrafts callsign.

atc_airline atc_airline=GlobalFreightways

The ATC system will use the specifiedairline name with this aircraft. This is

dependant on ATC recognizing the name.ATC will treat this aircraft as an airlinerwhen this is used in conjunction withatc_flight_number. Refer to the ATCVoicepack SDK for more information.

atc_flight_number atc_flight_number=1123 The ATC system will use this number aspart of the aircrafts callsign. ATC will treatthis aircraft as an airliner when this is usedin conjunction with atc_airline. Refer to the

ATC Voicepack SDK for more information.

ui_manufacturer ui_manufacturer = Cessna This value identifies the manufacturer sub-category used to group aircraft in theselect aircraft dialog inside FS.

ui_type ui_type = C182S Skylane This value identifies the type sub-categoryused to group aircraft in the select aircraftdialog inside FS.

ui_variation ui_variation = White withblue and purple

This value identifies the variation sub-category used to group aircraft in theselect aircraft dialog inside FS.

6

8/10/2019 SDK FS2004

11/68

description description=When Cessna sawhow well their Model 180 wasselling, they looked for away to make it an evenbigger success\s the answerwas the Model 182. TheCessna 182 Skylane feels andacts like a heavier, morepowerful version of itssibling, the 172 Skyhawk.The airplane is a workhorseand a stable platform forflying on instruments. Evenwith a full tank, the 182carries a family-size usefulload and performs admirablyas an aerial sport utilityvehicle.

The aircraft description can be modified tosay whatever you like about the aircraft.This information will be displayed in thedescription box inside FS when theaircraft is selected. (The \s is used toproduce a semicolon ( ; ) punctuation markwithin the in-game description.)

visual_damage visual_damage=0 Setting this flag to 1 enables visualdamage (e.g. parts breaking off) to be seen

when crashing the aircraft into the scenery.Note: visual damage will only work if it isbuilt into the aircrafts .mdl file.

[General] section

In addition to the [fltsim. ] sections, the [General] section contains information related to ALL

variations of the aircraft. For example, the Cessna 182RG, 182S, and 182S IFR are all the same

TYPE of aircraft, and in actuality, all contain the same flight model. As such, there are some

things that are NOT variable across variations:

Parameter Example Descriptionatc_type atc_type = Cessna This is the specific aircraft type that the ATC

system recognizes for this type of aircraft.

atc_model atc_model = C182 This is the specific aircraft model that the ATCsystem recognizes for this type of aircraft.

editable editable = 0 Determines whether the aircraft can be editedusing the Flight Simulator Aircraft Editorapplication. When set to 0, the aircraft will beread-only in the editor and a copy will have to bemade for editing. When set to 1, the aircraft willbe editable.

7

8/10/2019 SDK FS2004

12/68

performance performance=MaximumSpeed\t\n145 kts167 mph\t269km\/h\n\nCruiseSpeed\t\n140 kts161 mph \t259km\/h\n\nEngine\t\nTextronLycoming IO-540-AB1A5230hp\n\nPropeller\t\nThree-bladed McCauley constantspeed\n\nMaximumRange\t\n968 nm1,114 sm \t1,793km\n\nServiceCeiling\t\n18,100 ft \t5,517 m\n\nFuelCapacity\t\n92 U.S. gal348 L \n\nEmptyWeight\t\n1,910 lb \t

866 kg\n\nMaximum GrossWeight\t\n3,110 lb \t1,411 kg\n\nLength\t\n29ft\t 8.84m\n\nWingspan\t\n36 ft\t11 m\n\nHeight\t\n9 ft\t2.77 m\n\nSeating\t\nUp to4 \n\nUseful Load\t\n1,200lb \t 544 kg

The performance description for the aircraft cannow be edited. The \t is a tab character, andthe \n is a new-line character. As the flightmodel for all variations is the same, theperformance of each variation should also beidentical.

[forcefeedback] section

As detailed in the tables below, the parameters in the [forcefeedback]section of an aircraft.cfgfile define the forces generated by that aircraft in the users Force Feedback Joystick, so that

different aircraft can have different force effects (a different "feel" in the stick).

Stick shaker parameters

These parameters define the simulated stick shaker force felt in the stick or yoke when flying an

aircraft equipped with a stick shaker (such as the Learjet 45).

Parameter Example (from Lear45aircraft.cfg)

Datatype

Range

stick_shaker_magnitude stick_shaker_magnitude=5000 Integer 010000stick_shaker_direction stick_shaker_direction=0

Integer 035999

degrees

stick_shaker_period stick_shaker_period=111111

Integer 02^32-1microseconds

8

8/10/2019 SDK FS2004

13/68

Gear bump parameters

These parameters define the simulated forces transferred from the airframe and gear drag to the

stick or yoke when the aircrafts nose and main landing gear is raised or lowered (cycled). Infixed-gear aircraft this effect won't be felt because, by definition, the landing gear doesn't move.

Different aircraft have different gear geometries that result in each of the gear mechanisms

starting and ending its cycle at a different time. The timing deltas are brief, typically less than a

second between the time that each gear starts and ends its cycle.

Parameter Example (from Lear45 aircraft.cfg) Datatype

Range

gear_bump_nose_magnitude gear_bump_nose_magnitude=3000 Integer 010000gear_bump_nose_direction gear_bump_nose_direction=18000 Integer 035999

degrees

gear_bump_nose_duration gear_bump_nose_duration=250000 Integer 02^32-1microseconds

gear_bump_left_magnitude gear_bump_left_magnitude=2700 Integer 010000gear_bump_left_direction gear_bump_left_direction=9000 Integer 035999

degreesgear_bump_left_duration gear_bump_left_duration=250000 Integer 02^32-1

microseconds

gear_bump_right_magnitude gear_bump_right_magnitude=2700 Integer 010000

gear_bump_right_direction gear_bump_right_direction=27000 Integer 035999degrees

gear_bump_right_duration gear_bump_right_duration=250000 Integer 02^32-1microseconds

Ground bumps parameters

These parameters collectively define a composite force that simulates the forces felt through an

aircraft's ground steering controls as the aircraft travels over an uneven surface. The parametersare divided into two subgroups (numbered 1 and 2), and define the behavior of two distinctforces. The combination of the two forces (1 and 2), define a composite force that is transferred

to the stick or yoke. The two forces are both sinusoidal periodic forces, with frequencies

determined by the following linear equation:

frequency = (ground_bumps_slope* aircraft_ground_speed) + ground_bumps_intercept

The ground_bumps_magnitudeparameters set the magnitude of the force. The

ground_bumps_angleparameters set the direction from which the force is felt.

Parameter Example (from Lear45 aircraft.cfg) Datatype

Range

ground_bumps_magnitude1 ground_bumps_magnitude1=1300 Integer 010000

ground_bumps_angle1 ground_bumps_angle1=08900 Integer 035999degrees

ground_bumps_intercept1 ground_bumps_intercept1=3.0 Floating-point

01000000.0cycles persecond

9

8/10/2019 SDK FS2004

14/68

ground_bumps_slope1 ground_bumps_slope1=0.20 Floating-point


ground_bumps_magnitude2 ground_bumps_magnitude2=200 Integer 010000ground_bumps_angle2 ground_bumps_angle2=09100 Integer 035999

degrees

ground_bumps_intercept2 ground_bumps_intercept2=1.075 Floating-point 01000000.0cycles persecond

ground_bumps_slope2 ground_bumps_slope2=0.035 Floating-point


Crash parameters

These parameters define the simulated forces felt in the stick or yoke when the aircraft crashes.The parameters are divided into two subgroups (numbered 1 and 2), and define the behavior of

two distinct crash-induced forces. The first force is a constant force that lasts for 0.5 seconds.

After 0.5 seconds, it stops and the second force starts. The second force is a periodic square waveforce; its amplitude declines linearly to 0.

Parameter Example (from Lear45aircraft.cfg)

Description Datatype

Range

crash_magnitude1 crash_magnitude1=10000 Sets the magnitude ofthe first force.

Integer 010000

crash_direction1 crash_direction1=01000 Sets the direction fromwhich first force is felt.

Integer 035999degrees

crash_magnitude2 crash_magnitude2=10000 Sets the initialmagnitude of thesecond force.

Integer 010000

crash_direction2 crash_direction2=9000 Sets the direction fromwhich the secondforce is felt.

Integer 035999degrees

crash_period2 crash_period2=75000 Determines thefrequency (frequency= 1/period) of thesecond crash force.


crash_duration2 crash_duration2=2500000 Sets the amount oftime that the secondcrash force is felt.


[Reference_Speeds] section

The values given in this section are also included mainly for use in FSEDIT. However, you may

modify these values by hand, but you are unlikely to see any affects on the aircraft behaviorwithout running FSEDIT.

10

8/10/2019 SDK FS2004

15/68


flaps_up_stall_speed flaps_up_stall_speed = 54.0 Stall speed of the aircraft in a clean(flaps up) configuration at standardsea level conditions, (Knots True

Airspeed, KTAS).

full_flaps_stall_speed full_flaps_stall_speed = 43.2 Stall speed of the aircraft in a dirty(flaps full down) configuration atstandard sea level conditions,(Knots True Airspeed, KTAS).

cruise_speed cruise_speed = 140.0 Typical cruise speed of the aircraftin a clean (flaps up) configuration ata typical cruise altitude, (Knots True

Airspeed, KTAS).

max_indicated_speed max_indicated_speed=175 Maximum design indicatedairspeed. Also referred to as NeverExceed Speed or Red Line of theaircraft, (Knots Indicated Airspeed)

max_mach max_mach=0.9 Maximum design mach of the

aircraft. This generally only appliesto turbine airplanes.

[flight_tuning] section

Flight control effectiveness parameters

The following parameters are multipliers on the default "power" of the control surfaces. For

example, a value of 1.1 increases the effectiveness by 10 percent. Likewise, a value of 0.9decreases the effectiveness by 10 percent. A negative number reverses the normal effect of the

control. Omission of a parameter results in Flight Simulator defaulting to a value of 1.0.

Note:elevator_effectiveness, aileron_effectiveness, and rudder_effectivenessare

adjustable using the Flight Simulator Aircraft Editor.

Parameter Example (from C182 aircraft.cfg) Aerodynamic term

elevator_effectiveness elevator_effectiveness=1.0 Cmde

aileron_effectiveness aileron_effectiveness=1.0 Cldarudder_effectiveness rudder_effectiveness=1.0 Cndrelevator_trim_effectiveness elevator_trim_effectiveness=1.0 Cmdetr

aileron_trim_effectiveness aileron_trim_effectiveness=1.0 Cldatrrudder_trim_effectiveness rudder_trim_effectiveness=1.0 Cndrtr

Stability parameters

The following parameters are multipliers on the default stability (damping effect) about the

corresponding axis of the airplane. For example, a value of 1.1 increases the damping by 10%.Likewise, a value of 0.9 decreases the damping by 10%. A negative number results in an

unstable characteristic about the axis. A positive damping effect is simply a moment in the

11

8/10/2019 SDK FS2004

16/68

direction opposite of the rotational velocity. Omission of a parameter will result in Flight

Simulator defaulting to a value of 1.0.

Note:These three parameters are adjustable using the Flight Simulator Aircraft Editor

Application.

Parameter Example Aerodynamic term

pitch_stability pitch_stability=1.0 Cmq

roll_stability roll_stability=1.0 Clpyaw_stability yaw_stability=1.0 Cnr

Lift parameter

The following parameter is a multiplier on the coefficient of lift at zero angle of attack ("cruiselift" in this context refers to the lift at relatively small angles of attack, which is typical for an

airplane in a cruise condition). This scaling is decreased linearly as angle of attack moves toward

the critical (stall) angle of attack, which prevents destabilizing low speed and stall characteristicsat high angles of attack. Modify this value to set the angle of attack (and thus pitch) for a cruise

condition. A negative value is not advised, as this will result in extremely unnatural flight

characteristics. Omission of this parameter will result in Flight Simulator defaulting to a value of

1.0.

Note:This parameter is adjustable using the Flight Simulator Aircraft Editor Application.

Parameter Example Aerodynamic term forparameter

cruise_lift_scalar cruise_lift_scalar=1.0 CL0

High Angle of Attack parameters

The following parameters are multipliers on the effects on roll and yaw at high angles of attack.

The default values are 1.0.

Parameter Example

hi_alpha_on_roll hi_alpha_on_roll=1.0

hi_alpha_on_yaw hi_alpha_on_yaw=1.0

Propeller-induced turning effect parametersThe following parameters are multipliers on the effects induced by rotating propellers These areoften called left turning tendencies for clockwise rotating propellers, although MSFS

automatically handles counter-clockwise rotating propellers. The default values are 1.0.

Parameter Example

p_factor_on_yaw p_factor_on_yaw=1.0

torque_on_roll torque_on_roll=1.0

12

8/10/2019 SDK FS2004

17/68

gyro_precession_on_roll gyro_precession_on_roll=1.0

gyro_precession_on_yaw gyro_precession_on_yaw=1.0

Drag parameters

Drag is the aerodynamic force that determines the aircraft speed and acceleration. There are twobasic types of drag that the user can adjust here. Parasitic drag is composed of two basic

elements: form drag, which results from the interference of streamlined airflow, and skin friction.

Parasite drag increases as airspeed increases. Induced drag results from the production of lift.

Induced drag increases as angle of attack increases.

The following parameters are multipliers on the two respective drag coefficients. For example, a

value of 1.1 increases the respective drag component by 10 percent. A value of 0.9 decreases thedrag by 10 Percent. Negative values are not advised, as extremely unnatural flight characteristics

will result. Omission of a parameter results in Flight Simulator defaulting to a value of 1.0.

Note:These two parameters are adjustable using the Flight Simulator Aircraft Editor

Application.

Parameter Example (from C182aircraft.cfg)

Aerodynamic term forparameter

parasite_drag_scalar parasite_drag_scalar=1.0 Cd0

induced_drag_scalar induced_drag_scalar=1.0 Cdi

[weight_and_balance] section

The weight and center of gravity of the aircraft can be affected through the following parameters.

The sign convention for positions is positive equals longitudinally forward, laterally to the right,

and vertically upward.Note: In the stock aircraft, the station_load.0, 1, etc. parameters are enclosed in quotation marks.

These are used by internal language translation tools, and are not necessary for in-game use.

Parameter Example Units / format Description

max_gross_weight max_gross_weight =3110

pounds Maximum design grossweight of the aircraft.This parameter is usedsolely in FSEDIT to helpdetermine theaerodynamic

coefficients.

13

8/10/2019 SDK FS2004

18/68

empty_weight empty_weight=1810 pounds Total weight (in pounds)of the aircraft minususable fuel, passengers,cargo, and expendablearmament (CombatFlight Simulator aircraft).If not specified, the valuepreviously set in the .airfile will be used.

reference_datum_position reference_datum_position= 3.6, 0, 0

feet,feet,feet Offset (in feet) of theaircraft's referencedatum from the standardFlight Simulator centerpoint, which is on thecenterline chord aft ofthe leading edge. Bysetting the ReferenceDatum Position, actualaircraft loading data canbe used directly

according to theaircraft's manufacturer. Ifnot specified, the defaultis 0,0,0 (FlightSimulator's defaultcenter).

empty_weight_CG_position empty_weight_CG_position= -3.0, 0, 0

feet,feet,feet Offset (in feet) of thecenter of gravity of thebasic empty aircraft (nofuel, passengers, orbaggage) from theReference DatumPosition.

14

8/10/2019 SDK FS2004

19/68

station_load.0 station_load.0=170,-3.0, -1.5,0.0,Pilot

pounds,feet,feet,feet

Specifies the weight andposition of passengersor payload at a stationspecified with a uniquenumber, station_load.N.The first parameternumber on each linespecifies the weight (inpounds), followed by theoffset (in feet) of thestation (longitudinal,lateral, and vertical) fromthe Reference DatumPosition. The addition ofstations results in acorresponding change inaircraft flight dynamicsdue to the change of thetotal weight andmoments of inertia. The

final field is the stringname that is used in thePayload dialog (15character limit).Omission of this willresult in a genericstation name beingused.

station_load.1 station_load.1=170,-3.0, 1.5, 0.0,Front Passenger


Same as above

station_load.2 station_load.2=160,-6.2, -1.5, 0.0,Rear

Passenger


Same as above

max_number_of_stations max_number_of_stations=50

number Max Number of Stationsspecifies the maximumnumber of stations FlightSimulator will calculatewhen the aircraft isloaded. This allows anunlimited number ofstations to be specified.Note that an excessivelylarge number hereresults in a longer loadtime for the aircraft when

selected, although thereis no effect on real-timeperformance.

15

8/10/2019 SDK FS2004

20/68

Moments of Inertia

A moment of inertia (MOI) defines the mass distribution about an axis of an aircraft. A momentof inertia for a particular axis is increased as mass is increased and/or as the given mass is

distributed farther from the axis. This is largely what determines the inertial characteristics of the

aircraft.

The following weight and balance parameters define the MOIs of the empty aircraft, meaning

that the value should not reflect fuel, passengers, baggage, or expendable armament (CombatFlight Simulator aircraft). Flight Simulator determines the total MOIs with these influences

within the simulation. The units are slug - ft^2. Omission of a parameter will result in Flight

Simulator defaulting to the value set in the .air file, if one exists.


empty_weight_pitch_MOI empty_weight_pitch_MOI=1400.0 The moment of inertia(MOI) about the lateralaxis.

empty_weight_roll_MOI empty_weight_roll_MOI=1137.0 The moment of inertia(MOI) about thelongitudinal axis.

empty_weight_yaw_MOI empty_weight_yaw_MOI=2360.0 The moment of inertia(MOI) about the verticalaxis.

empty_weight_coupled_MOI empty_weight_coupled_MOI = 0.0 The moment of inertia(MOI) about the roll andyaw axis (usually zero).

These values can be estimated with the following formula:

MOI = EmptyWeight * (D^2 / K)

Where:

Pitch Roll Yaw

D= Length (feet) Wingspan (feet) 0.5* (Length+Wingspan)

K= 810 1870 770

This formula yields only rough estimates. Actual values vary based on aircraft material, installed

equipment, and number of engines and their positions.

16

8/10/2019 SDK FS2004

21/68

[fuel] sectionThis section defines the characteristics of the fuel system, including the tanks, fuel type, and the numberof fuel selectors. The maximum number of selectors supported is 2. This value is intended to match thenumber of visual selectors on the instrument panel.


Units Description

Center1Center2Center3LeftMainLeftAuxLeftTipRightMainRightAuxRightTipExternal1External2

LeftMain = -3.85, -2.10, 2.50,46.0, 0.00RightMain= -3.85, 2.10, 2.50,46.0, 0.00

Feet,Gallons

Thelongitudinal,lateral, andvertical positionof the tank.Next are theusable andunusablecapacities ofthe tanks.

fuel_type fuel_type=1 1 Avgas, 2 JetA

number_of_tank_selectors number_of_tank_selectors=1 Number of fueltank selectors(max 4 should be lessthan or equal tonumber ofengines).

electric_pump electric_pump = 1 Boolean thatsets whetheran electric

boost pump isavailable, 0 =FALSE, 1 =TRUE.

[GeneralEngineData] sectionEvery type of aircraft, even a glider, should have this section in the aircraft.cfg file. Basically, this sectiondescribes the type of engine, the number of engines, where the engines are located, and a fuel flowscalar to modify how much fuel the engine requires to produce the calculated power.


engine_type engine_type = 0 Integer that identifies what type ofengine is on the aircraft. 0 = piston,1 = Jet, 2 = None, 3 = Helo-turbine,4 = Rocket.

engine.0engine.1engine.2engine.3

engine.0 = 2.4, 0..0, 0.0 Offset (in feet) of the engine from theReference Datum Position(longitudinal, lateral and vertical).Each engine location specifiedincreases the engine count(maximum of four engines allowed).

17

8/10/2019 SDK FS2004

22/68

fuel_flow_scalar fuel_flow_scalar = 1.0 Scalar for modifying the fuel flowrequired by the engine(s). A value ofless than 1.0 causes a slower fuelconsumption for a given powersetting, a value greater than 1.0causes the aircraft to burn more fuelfor a given power setting.

min_throttle_limit min_throttle_limit=0 Defines the minimum throttle position(percent of max). Normally 0 forpiston aircraft and -0.25 for turbineairplane engines with reverse thrust.

max_contrail_temperature max_contrail_temperature=-39.0

Ambient temperature, in Celsius, inwhich engine vapor contrails will turnon. The default value is about -39degrees Celsius for turbine engines.For piston engines, the contrail effectis turned off unless a temperaturevalue is set here.

master_ignition_switch master_ignition_switch=0 1=Available, 0=Not Available(default). If available, this switchmust be on for the ignition circuit,and thus the engines, to beoperable. Turning it off will kill allengines.

[piston_engine] section

A piston engines power can be determined through a series of equations that represent theOtto cycle of a four-stroke piston engine, multiplied by the number of pistons available. This

section contains all the information Flight Simulator needs to be able to determine how muchpower your engine is capable of producing. (Power can also be scaled from the calculated values

generated for piston engines with the power_scalar value.)


power_scalar power_scalar = 1.0 Changing this value affects theamount of power delivered byth engine to the propellorshaft.

cylinder_displacement cylinder_displacement= 90.3 Cubic inches per cylinderdisplacement.

compression_ratio compression_ratio = 8.5 Compression ratio of eachcylinder.

number_of_cylinders number_of_cylinders= 6 Integer value; number of

cylinders in the engine.number_of_magnetos number_of_magnetos=2 Number of magnetos on thepiston engine. Only values of1 and 2 are supported.

max_rated_rpm max_rated_rpm = 2400 Maximum rated revolutions perminute (RPM) of the engine(red line).

max_rated_hp max_rated_hp = 230 Maximum rated brakehorsepower output of theengine.

18

8/10/2019 SDK FS2004

23/68

fuel_metering_type fuel_metering_type = 0 Integer value indicating thefuel metering type; 0 = FuelInjected, 1 = GravityCarburetor, 2 = AerobaticCarburetor.

cooling_type cooling_type = 0 Integer value indicating the

method of engine cooling; 0 =air cooled, 1 = liquid cooled.

normalized_starter_torque normalized_starter_torque = 0.3 This value can be modified toincrease/decrease the torquesupplied by the starter to getthe prop turning. Increasethis value for a greater torqueeffect, decrease it for a lowertorque setting.

turbocharged turbocharged = 0 Boolean to indicate if theengine is turbocharged; 0 =FALSE, 1 = TRUE.

max_design_mp max_design_mp = 0 If a turbocharger is present,this value indicates themaximum design manifoldpressure supplied by theturbocharger (inHg).

min_design_mp min_design_mp = 0 If a turbocharger is present,this value indicates theminimum design manifoldpressure of the turbocharger(inHg).

critical_altitude critical_altitude = 0 Altitude to which theturbocharger, if present, willprovide the maximum designmanifold pressure (feet).

emergency_boost_type emergency_boost_type = 0 Integer value indicating the

emergency boost typeavailable; 0 = None, 1 =Water Injection, 2 =Methanol/Water Injection, 3 =War Emergency Power,(typically used in WWII combataircraft).

emergency_boost_mp_offset emergency_boost_mp_offset = 0 Additional manifold pressuresupplied by emergency boost,if available.

emergency_boost_gain_offset emergency_boost_gain_offset =0

Multiplier on manifold pressuredue to emergency boost.

fuel_air_auto_mixture fuel_air_auto_mixture = 0 Boolean to indicate if

automatic fuel-to-air mixture isavailable; 0 = FALSE, 1 =TRUE.

auto_ignition auto_ignition = 0 Boolean to indicate ifautomatic ignition is available;0 = FALSE, 1 = TRUE.

19

8/10/2019 SDK FS2004

24/68

max_rpm_mechanical_efficiency_scalar

max_rpm_mechanical_efficiency_scalar = 1.0

Scalar value that can bemodified to tune themechanical efficiency of theengine at maximum rpm.Increase this value to increasethe mechanical efficiency,decrease it to decrease themechanical efficiency.

idle_rpm_mechanical_efficiency_scalar

idle_rpm_mechanical_efficiency_scalar = 1.0

Scalar value that can bemodified to tune themechanical efficiency of theengine at idle rpm. Increasethis value to increase themechanical efficiency,decrease it to decrease themechanical efficiency.

max_rpm_friction_scalar max_rpm_friction_scalar = 1.0 Scalar value that can bemodified to tune the internalfriction of the engine atmaximum rpm. Increase thisvalue to increase the friction,decrease it to decrease thefriction.

idle_rpm_friction_scalar idle_rpm_friction_scalar = 1.0 Scalar value that can bemodified to tune the internalfriction of the engine at idlerpm. Increase this value toincrease the friction, decreaseit to decrease the friction, (canbe used to tune the rpm atwhich the engine idles).

[propeller] sectionThe thrust generated by a given propeller is a function of the power delivered through thepropeller shaft, RPM, blade angle, airplane speed, and ambient density. Note:This parameter is

adjustable using the Flight Simulator Flight Dynamics Editor portion of the FSEDIT tool.


thrust_scalar thrust_scalar = 1.0 Parameter that scales the calculatedthrust provided by the propeller.

propeller_type propeller_type = 0 Integer that identifies what type ofpropeller is on the aircraft. 0 = ConstantSpeed, 1 = Fixed Pitch.

propeller_diameter propeller_diameter = 6.8 Diameter of propeller blades, tip to tip, infeet.

propeller_blades propeller_blades = 2 Integer value indicating the number ofblades on the propeller (2, 3 or 4).

propeller_moi propeller_moi = 5.7 Propeller moment of inertia, (slug ft2).

beta_max beta_max = 31.8 Maximum blade pitch angle for constantspeed prop (degrees). (Not used if fixedpitch.)

20

8/10/2019 SDK FS2004

25/68

beta_min beta_min = 17.0 Minimum blade pitch angle for constantspeed prop (degrees). (Not used if fixedpitch.)

min_gov_rpm min_gov_rpm = 1400 The minimum RPM controlled by thegovernor for a constant speed prop.

prop_tc prop_tc = 0.1 Time constant for prop

gear_reduction_ratio gear_reduction_ratio = 1.0 The reduction ratio from the engineoutput RPM to prop RPM.

fixed_pitch_beta fixed_pitch_beta = 20 Blade pitch angle for fixed pitch prop(degrees). (Not used if constant speed.)

low_speed_theory_limit low_speed_theory_limit = 80 The speed at which low-speed propellertheory gets blended into the high speedpropeller theory, (feet/second).

prop_sync_available prop_sync_available = 0 Boolean to indicate if propeller-sync isavailable (twin engine aircraft); 0 =FALSE, 1 = TRUE.

prop_deice_available prop_deice_available = 0 Boolean to indicate if propeller de-icing isavailable; 0 = FALSE, 1 = TRUE.

prop_feathering_available prop_feathering_available =

0

Boolean to indicate if prop feathering is

available (constant speed prop only); 0 =FALSE, 1 = TRUE.

prop_auto_feathering_available

prop_auto_feathering_available = 0

Boolean to indicate if prop auto-feathering is available (constant speedprop only); 0 = FALSE, 1 = TRUE.

min_rpm_for_feather min_rpm_for_feather = 0 Minimum RPM at which the prop willfeather (if feathering is available).

beta_feather beta_feather = 0 Propeller pitch angle when feathered(degrees).

power_absorbed_cf power_absorbed_cf = 0 Coefficient of friction power absorbed bypropeller.

defeathering_accumulators_available

defeathering_accumulators_available = 0

Boolean to indicate if de-featheringaccumulators are available; 0 = FALSE,1 = TRUE.

feathering_switches feathering_switches=0 Boolean indicating if feathering switchesare available. 0 = FALSE, 1 = TRUE.Feathering switches (as found on theDouglas DC3), allow the pilot toautomatically feather the propeller via aswitch, regardless of the propeller leverposition.

prop_reverse_available prop_reverse_available = 0 Specifies the scalar on the calculatedpropeller reverser effect. A value of 0will cause no reverse thrust to beavailable. A value of 1.0 will cause thetheoretical normalthrust to be available.Other values will scale the normal

calculated value accordingly.minimum_on_ground_beta minimum_on_ground_beta =

0Minimum blade pitch angle when theaircraft is on the ground (degrees).

minimum_reverse_beta minimum_reverse_beta = 0 Minimum blade pitch angle when thepropeller is in reverse (degrees).

21

8/10/2019 SDK FS2004

26/68

number_of_propellers number_of_propellers=2 By default, the number of propellers willbe set to the number of engines. TheWright Flyer is an example of wherethere are a different number of propellersthan engines. The number of propellersmust not be less than the number ofengines.

engine_map engine_map = 0,0 By default, propeller 1 is driven byengine 1, propeller 2 by engine 2, and soon. This parameter allows the propellersto be driven by other than thecorresponding engine. The series ofnumbers, separated by commas,represent the engine index which drivesthe propeller. In the example (from theWright Flyer), both propellers are drivenby the first engine (engine.0). Thecorresponding torque from the props willalso affect the driving enginesappropriately.

propeller.0,1,n propeller.0 = -6.9,-6.2,3.1 By default, the propeller thrust is locatedat the position specified for thecorresponding engine in the[GeneralEngineData] section. Thisparameter allows for the propeller to belocated at the specified offset(longitudinal, lateral, vertical) in feet fromthe enginethat is driving it. Example isfrom the Wright Flyer, which has twopropellers offset from the engine. Thepropeller position is where the thrust isapplied to the aircraft.

[TurbineEngineData] sectionA turbine engine ignites fuel and compressed air to create thrust. These parameters define the

power (thrust) output of a given jet engine.

Parameter Example (from lear45 aircraft.cfg) Description

fuel_flow_gain fuel_flow_gain = 0.0025 Fuel flow gain constant.inlet_area inlet_area = 4.2895 Engine nacelle inlet area, (ft

2)

rated_N2_rpm rated_N2_rpm = 29920 Second stage compressor ratedRPM.

static_thrust static_thrust = 3500 Maximum rated static thrust at sealevel (lbs).

afterburner_available afterburner_available = 0 Boolean value to indicate if anafterburner is available; 0 =FALSE, 1 = TRUE.

22

8/10/2019 SDK FS2004

27/68

reverser_available reverser_available = 1 Specifies the scalar on thecalculated reverse thrust effect. Avalue of 0 will cause no reversethrust to be available. A value of1.0 will cause the theoreticalnormalreverse thrust to beavailable. Other values will scalethe normal calculated valueaccordingly.

[jet_engine] section

The thrust_scalarparameter scales the calculated thrust for jet engines (from the

[TurbineEngineData] section).

Note:his parameter is adjustable using the Flight Simulator Flight Dynamics Editor.

Parameter Example (from lear45 aircraft.cfg)

thrust_scalar thrust_scalar = 1.0

[turboprop_engine] section

The amount of power generated by an engine and the power required for a propeller to turnthrough the air determine the increase and decrease of the RPM. A turboprop engine is really a

combination of a turbine engine and a propeller. The values in the [turboprop_engine] section

are included to modify values specific to the turboprop.

Note:These parameter is adjustable using the Flight Simulator Flight Dynamics Editor.

Parameter Example (from beech_king_air_350aircraft.cfg)

Description

power_scalar power_scalar = 1.0 Changing this value affects theamount of power delivered by theengine to the propeller shaft.

maximum_torque maximum_torque = 3270 Maximum shaft-torque availablefrom the engine (ft-lbs).

[contact_points] section

You can configure and adjust the way aircraft reacts to different kinds of contact, including

landing gear contact and articulation, braking, steering, and damage accrued through excessive

speed.

You can also configure each contact point independently for each aircraft, and there is no limit to

the number of points you can add. The data for configuring the points are placed in the[contact_points] section of the aircraft.cfg. When importing an aircraft that does not contain this

set of data, the program will generate the data from the .airfile the first time the aircraft is

loaded, and then write it to the aircraft.cfg.

23

8/10/2019 SDK FS2004

28/68

It may be useful to first look at the .cfgfile of an existing aircraft; you can learn a lot from the

many developer comments, which are followed by two slashes (//).

Each contact point contains a series of values that define the characteristics of the point,

separated by commas. Each point's data set takes the form point.n=, where n is the index to

the particular point, followed by the data.

Example:[contact_points]point.0= 1, -18.0, 0, -3.35, 3200, 0, 0.50,180, 0.25, 2.5, 0.90, 1.0, 4.0, 0, 0, 200

Below is a description of each element of the example contact point data set:

Parameter Element Description1 (1) Class Integer defining the type of contact

point: 0 = None, 1 = Wheel, 2 =Scrape, 3 = Skid, 4 = Float, 5 =Water Rudder

2 (-18.0) Longitudinal Position The longitudinal distance of the pointfrom the defined reference datum(feet). Positive is forward (out thenose).

3 (0) Lateral Position The lateral distance of the point fromthe defined reference datum (feet).Positive is starboard (right, asviewed from the top with the airplanepointing up).

4 (-3.35) Vertical Position The vertical distance of the pointfrom the defined reference datum(feet). Positive is up.

5 (3200) Impact Damage Threshold The speed at which an impact with

the ground can cause damage(feet/min).

6 (0) Brake Map Defines which brake input drives thebrake (wheels only). 0 = None, 1 =Left Brake, 2 = Right Brake.1

7 (0.50) Wheel Radius Radius of the wheel (feet).8 (180) Steering Angle The maximum angle (positive and

negative) that a wheel can pivot(degrees).

9 (0.25) Static Compression This is the distance a landing gear iscompressed when the empty aircraftis at rest on the ground (feet). Thisterm defines the strength of the

strut, where a smaller number willincrease the stiffness of the strut.

10 (2.5) Ratio of MaximumCompression to StaticCompression

Ratio of the max dynamiccompression available in the strut tothe static value. Can be useful incoordinating the compression ofthe strut when landing.

24

8/10/2019 SDK FS2004

29/68

11 (0.90) Damping Ratio This ratio describes how well theground reaction oscillations aredamped. A value of 1.0 isconsidered critically damped,meaning there will be little or noosciallation. A damping ratio of 0.0is considered undamped, meaningthat the oscillations will continue witha constant magnitude. Negativevalues result in an unstable groundhandling situation, and valuesgreater than 1.0 might also causeinstabilities by being over damped.Typical values range from 0.6 to0.95.

12 (1.0) Extension Time The amount of time it takes thelanding gear to fully extend undernormal conditions (seconds). Avalue of zero indicates a fixed gear.

13 (4.0) Retraction Time The amount of time it takes thelanding gear to fully retract undernormal conditions (seconds). Avalue of zero indicates a fixed gear.

14 (0) Sound Type This integer value will map a point toa type of sound:0 = Center Gear,1 = Auxiliary Gear,2 = Left Gear,3 = Right Gear,4 = Fuselage Scrape,5 = Left Wing Scrape,6 = Right Wing Scrape,7 = Aux1 Scrape,

8 = Aux2 Scrape,9 = Tail Scrape.

15 (0) Airspeed Limit This is the speed at which landinggear extension becomes inhibited(knots). Not used for scrape pointsor non-retractable gear.

16 (200) Damage from Airspeed The speed above which the landinggear accrues damage (knots). Notused for scrape points or non-retractable gear.

In addition to the specific data for each contact point, there are global [contact_point]parameters that are also used:


max_number_of_points max_number_of_points = 21 Integer value indicating themaximum number of points theprogram will look for in the[contact_points] section.

25

8/10/2019 SDK FS2004

30/68

static_pitch static_pitch = 3.82 The static pitch of the aircraft whenat rest on the ground (degrees).The program uses this value toposition the aircraft at startup, inslew, and at any other time whenthe simulation is not activelyrunning.

static_cg_height static_cg_height = 3.015 The static height of the aircraftwhen at rest on the ground (feet).The program uses this value toposition the aircraft at startup, inslew, and at any other time whenthe simulation is not activelyrunning.

gear_system_type gear_system_type=1 This parameter defines the systemtype which drives the gearextension and retraction.0 = electrical,1 = hydraulic,2 = pneumatic,3 = manual,4 = none.

[gear_warning_system] section

The following parameters define the functionality of the aircrafts gear warning system. This is

generally a function of the throttle lever position and the flap deflection.


gear_warning_available gear_warning_availiable =1

Sets the type of gear warningsystem available on the aircraft. 0 =

None, 1 = Normal, 2 = Amphibian(audible alert for water vs. landsetting).

pct_throttle_limit pct_throttle_limit = 0.1 The throttle limit, below which thegear warning will activate if the gearis not down and locked while theflaps are deflected to at least thesetting for flap_limit_idle below.This flap limit can be 0 so that thewarning effectively is a function ofthe throttle. 0 = idle, 1.0 = Maxthrottle.

26

8/10/2019 SDK FS2004

31/68

flap_limit_idle flap_limit_idle = 0 In conjunction with the throttle limitspecified above, this limit is the flapdeflection, above which the warningwill activate if the gear is not downand locked while the throttle isbelow the limit specified above. Bysetting this limit to a value greaterthan zero, the pilot can reduce thethrottle to idle without activating thewarning. This is often utilized in jetsto decelerate/descend the aircraft.

flap_limit_power flap_limit_power = 30 The flap limit, above which thewarning will activate (regardless ofthrottle position).

[brakes] section

The following parameters define the


parking_brake = 1 Boolean setting if a parking brake isavailable on the aircraft.0 = FALSE, 1 = TRUE.

toe_brakes_scale = 1.0 Sets the scaling of the brakingeffectiveness. 1.0 is the default.0.0 scales the brakes to noeffectiveness.

differential_braking_scale = 0 Differential braking is a function ofthe normal both brakes on and therudder pedal input. The amount ofdifference between the left and rightbrake is scaled by this value. 1.0 isthe normal setting if differentialbraking is desired (particularly ontailwheel airplanes). 0.0 is thesetting if no differential braking isdesired.

[airplane_geometry] section

The airplane [airplane_geometry] section has been added mainly for use with the FSEDITapplication and the ability to create a flight model from aircraft geometrical input. Although you

can edit these values by hand here in the aircraft.cfg file, modification of SOME of thesevariables will have little to no effect on airplane performance, as the flight model aerodynamiccoefficients are all still located in the [aircraft_title].air file. The FSEDIT program will change

the aerodynamic coefficients in the .air file based on the values in this section (and others), but

changing the values in the aircraft.cfg file WITHOUT running the FSEDIT application willresult in little, if any, noticeable changes in aircraft behavior. Nonetheless, these values have

been exposed for your convenience.

27

8/10/2019 SDK FS2004

32/68


Description

wing_area wing_area = 176.0 Area of the top surface of the entire wingtip-to-tip (ft

2).

wing_span wing_span = 36.0 Wing span is the horizontal distance fromwing-tip to wing-tip (feet).

wing_root_chord wing_root_chord = 4.9 Length of the wing chord (leading edge totrailing edge) at the intersection of thewing and the fuselage (feet).

wing_dihedral wing_dihedral = 1.7 When looking at the front of an aircraft,this is the angle between the wing leadingedge and a horizontal line parallel to theground (degrees).

wing_incidence wing_incidence = 1.5 When looking at the side of an aircraftfrom the wing tip, this is the angle themean wing chord makes with a horizontalline parallel to the ground, (degrees).Note: this parameter is not used in the

real-time aerodynamic calculations, as itis already factored into the lift and dragparameters. It will however influence thecalculation of the lift and drag constantsand tables generated through Fsedit.

wing_twist wing_twist This is the difference in wing incidencefrom the root chord and the tip chord ofthe wing, (degrees). Also known aswash-out.

oswald_efficiency_factor oswald_efficiency_factor= 0.7

This is a measure of the aerodynamicefficiency of the wing. A theoreticallyperfect wing will have an OEF of 1.0.

wing_winglets_flag wing_winglets_flag = 0 Boolean to indicate if the aircraft

incorporates the use of winglets; 0 =FALSE, 1 = TRUE.

wing_sweep wing_sweep = 0.0 When looking down on top of an aircraft,this is the angle the wing leading edgemakes with a horizontal line perpendicularto the fuselage, (degrees).

wing_pos_apex_lon wing_pos_apex_lon = -2.4

Longitudinal distance of the wing apex(measured at centerline of aircraft) fromdefined reference point (feet). Thisdistance is measured POSITIVE in theforward (out the aircraft nose) direction.

wing_pos_apex_vert wing_pos_apex_vert =0.0

Vertical distance of the wing apex(measured at centerline of aircraft) fromdefined reference point (feet). Thisdistance is measured POSITIVE in theUP direction.

htail_area htail_area = 39.0 Area of the top surface of the entirehorizontal tail (tip-to-tip) (ft

2).

htail_span htail_span = 11.7 Horizontal tail span is the horizontaldistance from horizontal tail-tip tohorizontal tail -tip (feet).

28

8/10/2019 SDK FS2004

33/68

htail_pos_lon htail_pos_lon = -18.3 Longitudinal distance of the horizontal tailapex (measured at centerline of aircraft)from defined reference point (feet). Thisdistance is measured POSITIVE in theforward (out the aircraft nose) direction.

htail_pos_vert htail_pos_vert = 0.0 Vertical distance of the horizontal tail

apex (measured at centerline of aircraft)from defined reference point, (feet). Thisdistance is measured POSITIVE in theUP direction.

htail_incidence htail_incidence = 3.2 When looking at the side of an aircraftfrom the horizontal tail tip, this is the anglethe mean horizontal tail chord makes witha horizontal line parallel to the ground(degrees).

htail_sweep htail_sweep = 10.0 When looking down on top of an aircraft,this is the angle the horizontal tail leadingedge makes with a horizontal lineperpendicular to the fuselage (degrees).

vtail_area vtail_area = 18.0 Area of the surface of one side of thevertical tail (fuselage-to-tip) (ft2).

vtail_span vtail_span = 4.8 Vertical tail span is the vertical distancefrom the vertical tail-fuselage intersectionto the tip of the vertical tail (feet).

vtail_sweep vtail_sweep = 40.0 When looking at the side of the verticaltail, this is the angle the vertical tailleading edge makes with a vertical lineperpendicular to the fuselage (degrees).

vtail_pos_lon vtail_pos_lon = -16.2 Longitudinal distance of the vertical tailapex (measured at centerline of aircraft)from defined reference point, (feet). Thisdistance is measured POSITIVE in theforward (out the aircraft nose) direction.

vtail_pos_vert vtail_pos_vert = 1.5 Vertical distance of the vertical tail apex(measured at centerline of aircraft) fromdefined reference point (feet). Thisdistance is measured POSITIVE in theUP direction.

elevator_area elevator_area = 16.6 Area of the top surface of the entireelevator (tip-to-tip) (ft

2).

aileron_area aileron_area = 18.3 Area of the top surface of all the aileronson the wing (ft

2).

rudder_area rudder_area = 6.7 Area of the side surface of the entirerudder (ft

2).

elevator_up_limit elevator_up_limit = 28.0 Angular limit of the elevator when

deflected up (degrees).elevator_down_limit elevator_down_limit =

21.0Angular limit of the elevator whendeflected down (degrees).

aileron_up_limit aileron_up_limit = 20.0 Angular limit of the aileron when deflectedup (degrees).

aileron_down_limit aileron_down_limit = 15.0 Angular limit of the aileron when deflecteddown (degrees).

29

8/10/2019 SDK FS2004

34/68

rudder_limit rudder_limit = 24.0 Angular limit of the rudder deflection(degrees).

elevator_trim_limit elevator_trim_limit = 19.5 Angular limit of the elevator trim tab(degrees).

spoiler_limit spoiler_limit = 0.0 Angular limit of the wing spoilers on anaircraft, (degrees). If this limit is zero, no

spoilers exist for the aircraft.spoilerons_available spoilerons_available = 0 Boolean to indicate if the spoilers also

behave as spoilerons for roll control (ifspoilers are available): 0 = FALSE, 1 =TRUE.

aileron_to_spoileron_gain aileron_to_spoileron_gain= 0

If spoilerons are available, this value isthe constant used in determining theamount of spoiler deflection per ailerondeflection.

spoiler_handle_available spoiler_handle_available=0

Boolean that configures the airplane withmanual control of the spoiler deflections.0 = FALSE, 1 = TRUE.

min_ailerons_for_spoilero

ns

min_ailerons_for_spoilero

ns = 0

This value indicates at what aileron

deflection the spoilers are become activefor roll control, (degrees).

min_flaps_for_spoilerons min_flaps_for_spoilerons= 0

This value indicates at what minimum flaphandle position the spoilerons becomeactive.

aileron_to_rudder_scale aileron_to_rudder_scale=0

This value sets the ratio of rudder toaileron input. For example, a value of 0.4would result in 40% rudder deflection for100% aileron control input.

[flaps.n] sectionFor each flap setthat is on the aircraft, a corresponding [flaps.set] section should exist. Most generalaviation aircraft and smaller jets only have one set of flaps (trailing edge), but it is typical for the largercommercial aircraft to have a set of leading edge flaps in addition to the trailing edge flaps. The numberof flap sets are determined by the number of [flaps.n] sections contained in the aircraft.cfg file.

The following table provides a description of each term in the [flaps.0] section for the Cessna 182S:

Parameter Example Descriptiontype type = 1 Integer value that indicates if this is

a leading edge or trailing edge flapset; 1 = trailing edge, 2 = leading

edge.span-outboard span-outboard = 0.5 The percentage of half-wing span

the flap extends to (from the wing-fuselage intersection).

extending-time extending-time = 5 Time it takes for the flap set toextend to the fullest deflection anglespecified (seconds).

30

8/10/2019 SDK FS2004

35/68

flaps-position.0flaps-position.1flaps-position.2flaps-position.3

flaps-position.0 = 0flaps-position.1 = 10flaps-position.2 = 20flaps-position.3 = 30

Each element of the flaps-positionarray indicates the deflection angleto which the flaps will deflect(degrees). The largest deflectionangle will be the one used for fullflap deflection.

damaging-speed damaging-speed = 250 Speed at which the flaps begin toaccrue damage (Knots IndicatedAirspeed, KIAS).

blowout-speed blowout-speed = 300 Speed at which the flaps depart theaircraft (Knots Indicated Airspeed,KIAS).

lift_scalar lift_scalar = 1.0 The percentage of total lift due toflap deflection that this flap set isresponsible for at full deflection.

drag_scalar drag_scalar = 1.0 The percentage of total drag due toflap deflection that this flap set isresponsible for at full deflection.

pitch_scalar pitch_scalar = 1.0 The percentage of total pitch due toflap deflection that this flap set isresponsible for at full deflection.

system_type system_type = 0 Integer value that indicates whattype of system drives the flaps todeflect:0 = Electric,1 = Hydraulic,2 = Pneumatic,3 = Manual,4 = None.

tailwheel_lock tailwheel_lock=0 Boolean defining if a tailwheel lockis available (applicable only ontailwheel airplanes).0 = FALSE, 1 = TRUE.

[electrical] section

These parameters configure the characteristics of the aircraft's electrical system and its

components. Each aircraft has a battery as well as an alternator or generator for each engine.

Below is a table of [electrical]section parameters shown with typical default values (the

values Flight Simulator uses if the parameters are omitted). The default Min Voltage equals

0.7*Max Battery Voltage. The list of components also reflects all of the systems currently linkedto the electrical system. If a component is included in the list but the aircraft does not actually

have that system, the component is simply ignored.

31

8/10/2019 SDK FS2004

36/68

Parameter Example (with defaultvalues that the simulationuses if the line is omitted)

Units/format* (seenote below)

Description

max_battery_voltage max_battery_voltage =

24.0

volts The maximum voltage

to which the battery canbe charged. It is alsothe voltage availablefrom the battery whenthe aircraft is initialized.The battery voltage willdecrease from this ifthe generators oralternators are notsupplying enoughcurrent to meet thedemand of the activecomponents.

generator_alternator_voltage

generator_alternator_voltage = 28.0

volts The voltage providedby a fully functioningalternator or generator.

max_generator_alternator_amps

max_generator_alternator_amps = 60.0

amps The maximum current(amperage) provided bya fully functioningalternator or generator.

electric_always_available

electric_always_available = 0

This flag enableselectrical powerregardless of the stateof the battery or circuit.

flap_motor flap_motor = 0, 5 ,17.0

Bus type, max ampload, min voltage

See notes below.

gear_motor gear_motor = 0, 5 ,

17.0Bus type, max amp

load, min voltage

See notes below.

autopilot autopilot = 0, 5 ,17.0


See notes below.

avionics_bus avionics_bus = 0, 10,17.0


See notes below.

avionics avionics = 1, 5 ,17.0


See notes below.

pitot_heat pitot_heat = 0, 15 ,17.0


See notes below.

additional_system additional_system =0, 20, 17.0


See notes below.

marker_beacon marker_beacon = 1, 2, 17.0


See notes below.

gear_warning gear_warning = 0, 2 ,17.0


See notes below.

fuel_pump fuel_pump = 0, 5 ,17.0


See notes below.

starter1 starter1 = 0, 20,17.0


See notes below.



See notes below.

32

8/10/2019 SDK FS2004

37/68



See notes below.



See notes below.

light_nav light_nav = 0, 5 ,17.0


See notes below.

light_beacon light_beacon = 0, 5 ,17.0 Bus type, max ampload, min voltage See notes below.

light_landing light_landing = 0, 5, 17.0


See notes below.

light_taxi light_taxi = 0, 5 ,17.0


See notes below.

light_strobe light_strobe = 0, 5 ,17.0


See notes below.

light_panel light_panel = 0, 5 ,17.0


See notes below.

light_cabin light_cabin = 0, 5 ,17.0


See notes below

prop_sync prop_sync = 0, 15 ,

17.0

Bus type, max amp

load, min voltage

See notes below.

auto_feather auto_feather = 0, 15, 17.0


See notes below.

auto_brakes auto_brakes = 0, 15 ,17.0


See notes below.

standby_vacuum standby_vacuum = 0,15 , 17.0


See notes below.

hydraulic_pump hydraulic_pump = 0, 2, 17.0


See notes below.

fuel_transfer_pump fuel_transfer_pump =0, 5 , 17.0


See notes below.

propeller_deice propeller_deice = 0,5 , 17.0


See notes below.

light_recognition light_recognition =0, 5 , 17.0 Bus type, max ampload, min voltage See notes below.

light_wing light_wing = 0, 5 ,17.0


See notes below.

light_logo light_logo = 0, 5 ,17.0


See notes below.

directional_gyro directional_gyro= 0, 5 , 17.0


See notes below.

directional_gyro_slaving

directional_gyro_slaving= 0, 5 , 17.0


See notes below.

33

8/10/2019 SDK FS2004

38/68

Notes:

Bus Typespecifies which bus in the electrical system the component is connected to,

according to the following bus type codes:

BusType

Bus

0 Main Bus (most components connected here)

1 Avionics Bus

2 Battery Bus

3 Hot Battery Bus (bypasses Master switch)

4 Generator/Alternator Bus 1 (function of engine 1)




Max Amp Loadis the current required to power the component, and of course becomes

the additional load on the electrical system.

Min Voltageis the minimum voltage required from the specified bus for the componentto function.

With the following parameter, an aircraft can be configured to have a generator or alternator on

any, or all, of the engines.


engine_generator_map engine_generator_map =0,1,0

This map of Boolean flagscorresponds to the engines of the

aircraft, and defines which enginesdrive individualalternator/generators. By default,all engines have analternator/generator. In theexample, only the second engineof a 3 engine aircraft has agenerator.

[pitot_static] section

The vertical_speed_time_constantparameter can be used to tune the lag of the VerticalSpeed Indicator for the aircraft:

Increasing the time constant decreases the lag, making the gauge react more quickly.

Decreasing the time constant increases the lag, making the gauge react more slowly.

34

8/10/2019 SDK FS2004

39/68

A value of 0 effectively causes the indication to freeze. If an instantaneous indication isdesired, use an excessively large value, such as 99.

If the line is omitted, the default value is 2.0.

Parameter Example (from Bell206baircraft.cfg)

Description

vertical_speed_time_constant vertical_speed_time_constant= 2.0

Increases or decreasesthe lag of the verticalspeed indicator.

[exits] section

Parameter Example (from C182

aircraft.cfg)

Description

number_of_exits number_of_exits = 1 This value defines the number of

simulated exits, or doors, on theaircraft.

exit_rate.n exit_rate.0 = 0.4 This value defines the rate, in percentper second, at which the exitarticulates. It is equal to 1/time,where timeis time in seconds atwhich the exit moves from fully closedto fully open or vice versa.

[views] section


aircraft.cfg)

Units Description

eyepoint eyepoint= -3.95, -0.85, 2.1 Feet This value specifies, in feet,the longitudinal, lateral, andvertical position of the pilotseyepoint from the aircraftsdatum point.

[lights] section

Each special effect light has a line like the one above, where nis the index number of the light, 0,1,The first entry of the line defines which circuit, or switch, the light is connected to. See the codes below.Multiple lights may be connected to a single switch. The next three entries are the longitudinal, lateral,and vertical positions of the light in feet. The final entry is the special effect file name that is triggered(e.g., fx_navred). These files have .fx extensions and should be placed in the Effects folder in FlightSimulators root directory.

35

8/10/2019 SDK FS2004

40/68

Switches (first element of each line):1 Beacon2 Strobe3 Navigation or Position4 Cockpit5 Landing6 Taxi7 Recognition8 Wing9 Logo10 Cabin

Parameter Examples (from C182 aircraft.cfg) Units Description

light.n light.0 = 3, -3.03, -18.11, 3.58,fx_navred

Feet The switch (or circuit)code, longitudinal, lateral,and vertical position, andeffect file.

[keyboard] section

The aircraft flight controls can be manipulated by the keyboard. Because flight controls naturally becomemore sensitive as airspeed increases, it can become quite difficult to control the aircraft via the keyboardat high speeds. To solve this problem, the amount a single keypress increments a flight control isdecreased by a factor of 1/2 at the first airspeed (in knots) listed on the line for the control, and by 1/8 atthe second airspeed. The scale is interpolated between.

Heres an example using the sample lines above: if the elevator increments by one degree when theairspeed is zero, it will increment by of one degree at 50 knots, of one degree at 100 knots, 5/16 ofone degree at 140 knots, and 1/8 of one degree at 180 knots and above.

% Effect of keypress|1|*| *| *| *

1/2| *| *| *

1/8| * *|________________________________0 100 180 knots


aircraft.cfg)

Units Description

elevatoraileronrudder

elevator = 100, 180aileron = 200, 1000rudder = 200, 1000

Knots Breakpoint speeds for keypressincrements being reduced by 1/2 and 1/8respectively.

36

8/10/2019 SDK FS2004

41/68

[radios] sectionThere is (or should be) a radio section in each aircraft.cfg. This section configures the radios for eachindividual aircraft. Each of the following keywords has a flag or set of flags, define the particular radioelement is available in the aircraft. A 1 is used for true (or available), and 0 for false (or not available).


aircraft.cfg)

Description

Audio.1 Audio.1 = 1 Is there an audio panel?

Com.1 Com.1 = 1, 1 Is there a Com 1 radio, does it support astandby frequency?

Com.2 Com.2 = 1, 1 Is there a Com 2 radio, does it support astandby frequency? Note: You cannot haveCOM 2 without COM 1.

Nav.1 Nav.1 = 1, 1, 1 Is there a Nav 1 receiver, does is support astandby frequency, and does it support aglideslope indication?

Nav.2 Nav.2 = 1, 1, 0 Is there a Nav 2 receiver, does is support astandby frequency, and does it support aglideslope indication? Note: You cannot have

NAV 2 without NAV 1.Adf.1 Adf.1 = 1 Is there an ADF receiver?

Adf.2 Adf.2 = 1 Is there an ADF 2 receiver?Transponder.1 Transponder.1 = 1 Is there a transponder?

Marker.1 Marker.1 = 1 Is there a marker beacon receiver?

Special Note: Incorrectly setting the standby parameters may cause inability to tune the radios.

[smokesystem] sectionThe section describes how to configure a

SDK FS2004

Documents

Transcript of SDK FS2004