RELEASE NOTES, SDK release 1.1.2

IMPORTANT! The SDK documentation has had a major overhaul since Microsoft Flight Simulator 2020, and as such, some sections have been moved around, merged, or even removed. The search system and index should help you find what you need.

 

SDK Changes 

Tools

[added]

  1. Blender: Export as submodel

 

 

 

Previous SDK Release Notes

Below you can find a list of the list notes for previous releases of this SDK. Simply double click the release notes you want to explore to open them:

 

SDK Release 1.1.1SDK Release 1.1.1

Developer Mode Changes

General

[fixed]

  1. Fixed "Exit devmode" option always greyed out.
  2. Fixed and improved scenery package order.
  3. Fixed layout issues in editor and tool windows when using a 4k monitor
  4. Fixed a crash that could occur when closing devmode windows from Windows (e.g. with alt+F4)

  5. Fixed texture paths returned in Package Builder messages (was returning a hash instead of the real path)

[added]

  1. VFSProjector now grants access to encrypted files that are not protected.

 

Scenery Editor

NOTE: If you already opened and saved your scenery in MSFS 2024, the conversion won't be done again and you might need to update it by yourself. If no other changes were made to that scenery, you can also re-import the package to get this done.

[fixed]

  1. Fixed material polygon not rendered.
  2. Fixed jetway link sometimes relinking to incorrect altitude when moving the jetway.
  3. Fixed light too bright on light rows without preset.
  4. Fixed secondary heightmap not flattened when vegetation exclusion is disabled on a runway.
  5. Fixed crash when generating sim object list.
  6. Fixed crash when moving an invalid world script.
  7. Fixed projected mesh flagged as marking text not drawn after other markings.
  8. Fixed scenery editor scaling to look better an higher resolutions.
  9. Fixed a conversion issue on carparking heading with packages imported from FS2020.
  10. Prevent material discontinuity on aprons.

[improved]

  1. Improved scenery list generation time by creating a scenery name list with the PackageCompressor.
  2. Clarified how polygon\'s vegetation density slider works, with an info message when graphics settings aren't high enough to see all trees.
  3. Selected all packages by default in the Objects panel.
  4. Moved the "Replace with..." buttons of scenery/sim objects/simprop containers inside a single button.

  5. Removed taxiway dirt from legacy airports archetype. There is still unwanted dirt near parkings in legacy packages.

 

SimObject Editor

[fixed]

  1. Fixed possible crash when using Save and Apply near an airport.
  2. Fixed stringlist parsing error due to unwanted space between values.
  3. Fixed hashmap parsing adding unwanted unknown param.
  4. Fixed modified state in camera cfg tab.
  5. Fixed excluded param incorrectly parsed during the merge.
  6. Fixed typo in career compatibility tab.

[added]

  1. Add live edition option for contact points position.

 

 

SDK Changes

General

[fixed]

  1. Fix limit on maximum number of terrain instances. Separate terrain from EFB/Minimap to let developers use the 9 available maps.
  2. Fixed XML gauge conditional text color not working for some expressions.
  3. Fixed scenery VFX objects not spawning their effect.
  4. Fixed WASM gauge loaded even if the aircraft referencing it is in a different package.
  5. Fixed windsock ModelBehavior template to keep wind direction no matter what the object rotation is.

 

Audio

[added]

  1. Added support for an optional "AbsoluteValue" attribute on WwiseRTPC tags in sound.xml/soundai.xml files, it expects a boolean value and tells whether to use the absolute value of the variable

 

Samples

[added]

  1. Added a new sample that shows how to mod an existing aircraft.
  2. Added a sample to show how to use new function : SimConnect_EnumerateSimObjectsAndLiveries.
  3. Added new blend scenes for DA62 sample.

 

SimConnect

[fixed]

  1. Fixed Aircraft spawning on the same parking slot when spawned with SimConnect.

[added]

  1. Added extended functions to SimConnect to specify livery when spawning a SimObject.
  2. Implemented SimConnect_EnumerateSimObjectsAndLiveries function that returns a list a spawnable simbobjects and their liveries.

[improved]

  1. Removed DoneIO popup.
    Brought SIMCONNECT_SIMOBJECT_TYPE back to its previous order and added new values at the end.

 

SimVars

[added]

  1. Added "LIVERY FOLDER" and "LIVERY NAME" SimVars for modular aircraft liveries.

[fixed]

  1. Fixed ZULU time

 

WASM API

[fixed]

  1. Fixed a bug where WASM Vars and Events APIs where not usable in standalone or airport modules

[added]

  1. Added WASM build in Release With Debug Info detection in the WASM Debug Window
  2. Added access to environment var in vars extension

 

EFB API

[improved]

  1. Updated efb_api to the latest version.

 

Tools

[fixed]

  1. Blender: Fix export lights
  2. Blender: Fix export material animations
  3. Blender: Fixed export objects
  4. Blender: Fixed set Blend Mask Texture

[added]

  1. Blender: Added Tire material
  2. Blender: Add enable/disable export meshs

[updated]

  1. Blender: Adjustments of standard shader : Rename uv2 input and Unlink AO when there are no base color texture of detail color texture set
  2. Blender: Clarify use of material_type update function
  3. Blender: Update default emissive scale

 

 

Documentation

Content Configuration

[added]

  1. New attribute for the <WwiseRtpc> element of the sound XML has been added: AbsoluteValue

 

Programming APIs

[added]

  1. New WebAssembly section dedicated to the IO API.
  2. New WebAssembly section for MSFS core: Core And Helpers
  3. New SimConnect functions documented:
    1. SimConnect_AICreateEnrouteATCAircraft_EX1
    2. SimConnect_AICreateNonATCAircraft_EX1
    3. SimConnect_AICreateParkedATCAircraft_EX1
    4. SimConnect_AICreateSimulatedObject_EX1
    5. SimConnect_EnumerateSimObjectsAndLiveries

SDK Release 1.0.1SDK Release 1.0.1

SDK Changes

Plugins

Fixed

  1. Blender: Fixed export objects
  2. Blender: Fixed set Blend Mask Texture

Added

  1. Blender: Added Tire material

 

Samples

Added

  1. New sample to show how to mod an existing modular aircraft.

 

 

Documentation

Developer Mode

Improved

  1. Debug Aircraft Flight Performance window page has been updated.

 

Content Configuration

Added

  1. New page flight_performance.cfg - Additional Information added.
  2. New [Deck.N] section added to the navigation_graph.cfg.

Improved

  1. Finalised the documentation for the flight_performance.cfg file.

 

Programming APIs

Added

  1. The SimVar GPS GSI NEEDLE has been added.
  2. New page on EFB Notifications has been added.
  3. New section in the Panel XML docs to explain the <EFB> element.

Improved

  1. The entire TCAS section of the SimVars docs has been updated.
  2. All SimVar docs pages have been updated with more obvious parameter descriptions and requirements.
  3. The main Simulation Variables page has improved description of RPN and SimVars with two parameters.

SDK Release 1.0.0SDK Release 1.0.0 (MSFS2024 initial PUBLIC release)(MSFS2024 initial PUBLIC release)

DOCUMENTATION

General

Added:

  1. Dark/Light mode has been added to the documentation to improve accessibility.
  2. New page added to give a reference for the The Colour Picker.

Improved:

  1. The structure of the SDK documentation has been improved to enable finding the information you require faster and easier, including improved search, an improved index, and related topics links on all pages.
  2. SDK Tools have been moved into their own unique section in the Table Of Contents and all relevant information consolidated under that section.
  3. Aircraft samples have been converted into the following two modular aircraft:

 

 

SDK Tools

Added:

  1. Documentation has been added to describe the new Input Application for creating custom input profiles for devices and aircraft. This includes the following pages:
    1. Global Input Profile Package Setup
      Aircraft Input Profile Package Setup
      Creating An Input Profile
      DeviceConfig XML Properties
      Input Configuration XML Properties

  2. A page has been added for The Mission Tool.

    NOTE: This tool is a temporary fix to allow developers to test certain aspects of mission creation and will be removed in future versions of the Microsoft Flight Simulator 2024 DevMode / S

 

 

Developer Mode - General

Added:

  1. A new option for Lighting Display debugging has been documented.
  2. The DevMode Toolbar has been documented.
  3. The Behaviors Debug window has been documented

Improved:

  1. The "Debug PBR" menu page has been renamed as Channel Display and has had some additional updates to cover new options.
  2. Some menus can now be "detached" so you can easily access common options. See here for more information: Detachable Menus
  3. The "Debug PBR" menu page has been renamed as Channel Display and has had some additional updates to cover new options.
  4. The Aircraft Editor section has been removed and replaced by the more general SimObject Editor.
  5. The section on using the Screenshot tool has been updated.
  6. The Developer Camera Settings section has been updated with new options.

 

 

The Project Editor

Added:

  1. The new Package States have been documented.
  2. New Package Order Hint section has been added to The Project Inspector page.

Improved:

  1. The Asset Types page has been tidied and now shows information for all relevant asset types available, including the new Airport asset group type.
  2. All references to the setup for the Marketplace have been removed from the documentation as this is now all handled on the Marketplace itself.

 

 

The Scenery Editor

Added:

  1. Airport Objects - Override Archetypes options have been added.
  2. PaintedLine Objects - New option for outlines has been added.
  3. Decal Objects - New decal object for the Scenery Editor has been documented.
  4. TaxiwayServiceStand Objects - New taxiway service stand object has been documented.
  5. Text Objects - New text object for the scenery editor has been documented.
  6. VDGS Objects - New Visual Docking Guidance System (VDGS) object for the scenery editor has been documented.
  7. SimPropContainer Object - New scenery object type has been added. See also: Modeling SimPropContainers
  8. SimPropContainer XML Properties and SimPropContainer Object Examples have been added to describe the XML used by the new SimPropContainer object.
  9. New "Apron Services" option has been documented for Airport Objects, TaxiwayParking Objects and Helipad Objects.
  10. New Navigation Graph options have been documented for The View Menu.
  11. New render options have been added to The Rendering Menu page.

Improved:

  1. Helipad Objects - Multiple new options for helipads have been documented.
  2. TaxiwayParking Objects - Multiple new options for taxiway parking objects have been documented.
  3. Information has been added to the Creating A SimObject and Creating A Scenery Object pages.
  4. Information has been added to the Scenery XML And Model CFG page.

 

 

The Material Editor

Added:

  1. New page on The Bitmap Manager has been added.

Improved:

  1. The Material Inspector page has been updated with new "extra settings" section.

 

 

The SimObject Editor (Previously the Aircraft Editor)

Added:

  1. The SimObject Editor main page has been added withinformation about the new editor
  2. The Attached Objects tab has been documented.
  3. The Attachment tab has been documented.
  4. The Navigation Graph tab has been documented.
  5. The Livery tab has been documented
  6. The Effects tab has been documented
  7. The Texture tab has been documented
  8. The Model LOD tab has been documented.
  9. The Animations tab has been documented.
  10. The Sounds tab has been documented.
  11. A dedicated page listing all SimObject Editor parameters have been added: The SimObject Editor Parameter Index
  12. The new debug window - Debug Dirt And Scratches - has been added to the documentation.
  13. The new debug window - Covers And Chocks - has been added to the documentation.
  14. The new debug window - Debug Aircraft Attachments - has been added to the documentation.

Improved:

  1. The Aircraft Data debug window docs have been updated to reflect additions to the window.

 

 

The Navigation Graph Editor

Added:

  1. New page describing The Navigation Graph Editor has been added. Tis editor is for desiging navigation graphs which are used to help objects navigate around both the world and aircraft, as well as many other things.
  2. New page describing Using The Navigation Graph Editor has been added.

 

 

The SimAttachment Editor

Added:

  1. The SimAttachment Editor has been added to the documentation. This editor is similar to the SimObject Editor, but designed for editing stand-along attachments that can then be added to your aircraft and scenery.

 

 

Models And Textures

Added:

  1. The new Texture Tool has been documented.
  2. New pages have been added for the Texture XML Properties and texture.json files.
  3. A page has been added explaining how to use the Simplygon SDK to simplify the creation of scenery object LODs: Using Simplygon To Generate LODs
  4. A page has been added to explain the updated LOD Selection System for all 3D models.
  5. The Modeling Aircraft documentation has had the following pages added:
    1. Propellers, Turbines And Blades
      Clearcoat
      Dirt And Grime
      Registration Numbers
      Covers, Chocks, And Pins
      Doors, Hatches, And Canopies
      Fuel Truck And GPU Connections

Improved:

  1. FlightSim Materials (all material documentation has been updated to the new MSFS 2024 standards)
  2. The glTF Schemas page has been updated with information on the new schemas available.
  3. The Multi-Exporter documentation has received a major update.
  4. The Modeling Aircraft documentation has had the following pages updated:
    1. File Setup
      Airframe Textures And Materials
      Windshield And Windows
      Exterior Lights
      Wheels
      Airframe Details
      Ice
      Airframe Collision Meshes
      Ambient Occlusion
      Parallax Windows
      Aircraft LODs

 

 

Content Configuration

Added:

  1. New section outlining details of the updated MSFS Avionics Framework for MSFS 2024 has been added.
  2. CFG Files General Information page has been added, and now contains updated information about the different data types, including the new table format that permits nD tables.
  3. New Simple SimObject types have been documented:
    1. Procedural Characters
      Simple Objects
  4. New pages have been added related to the setup for Modular Aircraft:
    1. Modular Aircraft Project Structure
      Modular Aircraft Merging
      Modular Aircraft XML Properties
      Modular Aircraft CFG Files
      Sim Attachments
      Included Attachments
  5. New pages have been added related to the configuration of models within the simulation:
    1. Livery XML Properties
  6. New pages have been added to describe the setup of light effects:
    1. Implementing Lights
      Light FX Properties
      effects.cfg
  7. A new section has been added for Navigation Services And Interactions:
    1. Services XML Properties
      Navigation Services XML Properties
      SimMission Navigation Services
      Interaction XML Properties
      Interaction Presets
  8. A new section has been added for Apron Services:
    1. Apron Control XML Properties
      Apron Services XML Properties
      Apron Control Mission XML Properties
      Built-In Apron Services
      Global Apron Services
  9. A new Careers section has been added outlining the setup for custom aircraft to be used in the various career missions. This section covers the following:

    1. Preflight
      Spawn Pilot (Transversal)
      Aerial Advertising
      Aerial Construction
      Aerial Firefighting
      Agricultural Aviation
      Cargo Transport
      Charter Service
      Commercial Flights And Passengers
      Ferry Flights
      Flightseeing / First Flight
      Medevac
      Scientific Research
      Search And Rescue
      Skydiving
      Using Included SimAttachments

  10. The page for the <SimMission.Calculator> has new items listed specifically for use with Navigation Services, Apron Services, and Interactions:

    1. <CabinServiceBehaviourParameter>
      <CabinServiceStateParameter>
      <CabinServiceGraphParameter>
      <ParentCabinServiceBehaviourParameter>
      <ParentCabinServiceStateParameter>
      <ApronContextParameter>
      <ApronControlMissionContext>
      <InteractivePointParameter>
      <InteractivePointUser>
      <InteractivePoint>
      <InteractivePointType>
      <InteractivePointSearchPreferences>
      <ParkingParameter>
      <ParkingName>
      <ParkingNumber>
      <ParkingSuffix>
      <StandType>
      <StandRole>
      <HelipadParameter>
      <HelipadProperty>
      <DesiredValue>
      <Units>

  11. FLT file documentation has been updated with a new page for FLT Additional Information and the following new sections:
    1. [HYDRAULICS_SYSTEM_EX1.N]
      [PNEUMATIC_SYSTEM_EX1.N]
      [Liquid Dropping System.N]
      [Gauges.N]
      [Navigation_Graph.N]
      [WEAR_AND_TEAR_SYSTEM.N]
      [CabinService.N]
      [CabinServiceObject.N]
      [Dirt.N]
  12. The FLT file documentation also has the following new parameters:
    1. [Systems.N] - GovernorTarget
      [Covers] - chock, engine, pitot, static_port, rotor, landing_gear
      [Sim.N]: Livery,
  13. New section on Changes Between MSFS 2020 And MSFS 2024
  14. The Checklist XML Properties page has the following new elements: <Link>,
  15. New page that includes a detailed overview of the new features of the MSFS 2024 audio system has been added: Audio Migration And Updating
  16. The page related to the Localization (LOC Files) has a new section outlining Supported Languages.
  17. New CFG file for dealing with navigation graphs has been documented: navigation_graph.cfg.
  18. New section in the gameplay.cfg has been documented: [WEAR_AND_TEAR_SYSTEM]
  19. The cockpit.cfg documentation has the following new section and parameters:
    1. Various new parameters have been added to customise the external HUD: [MISC].
      New section and parameters related to general cockpit information: [General].
  20. The systems.cfg file documentation has received the following additions:
    1. [HYDRAULICS_SYSTEM_EX1], Hydraulics System Setup Information, Hydraulic System Examples.
      [PNEUMATIC_SYSTEM_EX1], Pneumatic System Setup Information, Pneumatic System Examples.
      [WATER BALLAST SYSTEM]
      [Liquid Dropping System]
      [ELECTRICAL], Electric System Setup Information
      [BRAKES]: toe_brakes_pressure_increment, toe_brakes_pressure_release_delay, toe_brakes_pressure_decrease_tc. rto_min_speed_for_trigger,
      [AUTOPILOT]: auto_throttle_derivative_boundary, auto_throttle_derivative_control, auto_throttle_integrator_boundary, auto_throttle_integrator_control, auto_throttle_proportional_control,
      [LocalVars_EX1]: new section for L:1 type vars added.
  21. The ai.cfg has the following new section: [AI_INPUT]
  22. The aircraft.cfg has the following new pages, sections and parameters:
    1. The [GENERAL] section has the following new parameters: object_class,
      The [SERVICES] section has a new parameter: WINCH.
      The [PILOT] section has new parameters (and all previous parameters are now considered legacy): cabin_service, generated_copilot, copilot_behavior. hide_avatar,
      The [FLTSIM.N] section has the following new parameters: ui_powerplant_specifics, ui_instrumentation, ui_additional_information, operating_status, targeted_specializations, military, premium,
      A new page has been added to include additional information for the aircraft.cfg and sim.cfg files: Aircraft.cfg / Sim.cfg Additional Information
  23. The flight_model.cfg has the following new pages, sections and parameters:
    1. The [AERODYNAMICS] section has the following new parameters:

      1. stallalpha
        stallalpha_ff,

    2. The [WEIGHT_AND_BALANCE] section has the following new parameters:
      • max_takeoff_weight, max_landing_weight,
    3. The [AIRPLANE_GEOMETRY] section has the following new parameters:
      • cockpit_width, cockpit_height, control_aileron_forcebased, control_aileron_maxforce_student, control_aileron_minforce_student, control_aileron_maxforce_pilot, control_aileron_minforce_pilot, control_aileron_maxforce_testpilot, control_aileron_minforce_testpilot, control_aileron_still_force_at_max, control_aileron_still_force_to_move, control_aileron_dynpres_ratio_force_at_max, control_aileron_dynpres_ratio_force_to_move, control_aileron_neutral_return_force_scalar, control_elevator_forcebased, control_elevator_maxforce_student, control_elevator_minforce_student, control_elevator_maxforce_pilot, control_elevator_minforce_pilot, control_elevator_maxforce_testpilot, control_elevator_maxforce_testpilot, control_elevator_still_force_at_max, control_elevator_still_force_to_move, control_elevator_dynpres_ratio_force_at_max, control_elevator_dynpres_ratio_force_to_move, control_elevator_neutral_return_force_scalar, control_rudder_forcebased, control_rudder_maxforce_student, control_rudder_minforce_student, control_rudder_maxforce_pilot, control_rudder_minforce_pilot, control_rudder_maxforce_testpilot, control_rudder_minforce_testpilot, control_rudder_still_force_at_max, control_rudder_still_force_to_move, control_rudder_dynpres_ratio_force_at_max, control_rudder_dynpres_ratio_force_to_move, control_rudder_neutral_return_force_scalar,
    4. The [HELICOPTER] section has the following new parameters:
      • cyclic_move_rate_limit, rudder_pedals_move_rate_limit, rotor_node.n,
    5. The [MAINROTOR] and [SECONDARYROTOR] sections have the following new parameters:
      • BrakeCircuit,
    6. The [FLIGHT_TUNING] section has the following new parameters:
      • ground_new_contact_model_gear_flex, ground_new_contact_model_gear_flex_damping, ground_new_contact_model_rolling_stickyness, ground_new_contact_model_up_to_speed_lateral, ground_new_contact_model_up_to_speed_lateral_steering, ground_new_contact_model_up_to_speed_longitudinal, enable_high_accuracy_integration,
    7. The [WEIGHT_AND_BALANCE] section has had the following new parameters added:
      • max_zero_fuel_weight,
    8. The [FUEL_SYSTEM] section has been updated and expanded.
    9. A new section for [COLLISION_DAMAGE] has been added as part of the damage/wear and Tear system. Included in this addition, new parameters have been added to the [FLAPS.N] section as well:
      • FlapSurface_Left, FlapSurface_Right, FlapCable_Left, FlapCable_Right.
    10. A new section and parameters have been added for hot air balloons: [BALLOON].
    11. The point.N parameter in the [CONTACT_POINTS] section has received a new table entry to control how the gear handle will interact with the landing gear when this is extensible.
    12. A new section (with parameters) has been added that permits you to disable the standard geometric representation of certain elements of the flight model. See the [DESIGN_ACTIVATION] section for more details. To accompany this, there are also the following new sections (with parameters) that deal with custom geometries and other physical items in the simulation:
      1. [OBJ_EA1_BALLOON.N]
        [OBJ_EA1_PITOTFLAG.N]
        [OBJ_EA1_YAWSTRING.N]
        [OBJ_EA1_ROPECRATE.N]
        [OBJ_EA1_BANNER.N]
        [OBJ_EA1_SIMPLEGEAR.N]
        [OBJ_EA1_SURFACE.N]
  24. The engines.cfg has the following new pages, sections and parameters:
    1. New page containing additional information to help setup the engine CFG file has been added here: engines.cfg - Additional Information
    2. The [GENERALENGINEDATA] section has the following new parameters: smoke_protection,
    3. The [PROPELLER] section has the following new parameters:
      • number_of_propellers, prop_node.n, governor_prop_pitch_rate, feathering_prop_pitch_rate, beta_range_prop_pitch_rate, beta_forced_prop_pitch_rate, min_flight_beta_throttle_pos, rotation,
    4. The [TURBINEENGINEDATA] section has the following new parameters:
      • turbine_node.n, turbine_blades, N1_100pc_rpm, bleed_air_high_gain, bleed_air_med_gain, bleed_air_lo_gain, bleed_air_hi_bkpt, bleed_air_lo_bkpt,
  25. The following new CFG files have been documented:
    1. attached_objects.cfg
      attachment.cfg
      effects.cfg
      flight_performance.cfg
      livery.cfg
      model.cfg
      texture.cfg

 

Improved:

  1. The SimObj documentation has been split into two sections given the changes to aircraft SimObj. There is now a section for Simple SimObjects and another for Modular Aircraft SimObjects.
  2. The mission documentation has been updated with a new section detailing the mission XML elements for navigation services: SimMission Navigation Services
  3. The following updates and additions have also been made to various Model Behaviour XML files:
    1. The <Parameters> element has a new available value for the Process attribute: "Macro".
      The <MouseFlags> element has two new flags available: Enter, Exit.
      The <CompileBehaviors> element has been documented.
      Changes to the <Binding> element have been documented.
      Changes to the <EmissiveFactor> element have been documented.
      New attributes for the <Condition> element have been documented.
      Input event name restrictions have been documented (alpha-numeric with the "-"and "_" symbols only are permitted).
  4. The entire section dedicated to creating Checklists has been updated.
  5. The following scenery XML pages have been updated:
    1. General Environment XML Properties
      1. <Vertex /> has been updated.
      2. <Ndb> / <Vor> / <Dme /> have all been added.
    2. Airport XML Properties
      1. <Airport> / <Apron> have been updated.
      2. <AirportArchetype> /<ParamOverride /> / <ApronControl> have all been added.
    3. Taxiway XML Properties
      1. <TaxiwayParking /> has been updated.
      2. <TaxiwayServiceStand /> has been added.
    4. Scenery Editor Object XML Properties
      1. <Decal /> has been added.
  6. The information relating to setting up aircraft audio has been updated.
  7. There has been a general update to all the pages related to Model Behaviors to bring them in line with the MSFS 2024 standards. It is worth noting that the following pages are either new or have received a complete rewrite:
    1. Important Templates
      Using Model Behaviors
      Model Behaviors Parameters
      Model Behaviors Inputs
      Creating Cockpit Interactions (previously called "Creating Interactions With Input Events")
      Creating Interaction Tooltips
  8. The following parameters across various CFG files have been changed and no longer require a list, and instead take a hash-map: lightdef.N, point.N, interactive_point.N,

 

 

Programming APIs

Added:

  1. SimVar Documentation has been updated with multiple new sections:
    1. Pneumatics
      Hydraulics
      Water Ballast
      Liquid Dropping System
      Aircraft Wear And Tear States
  2. New SimVars added in the following sections:
    1. Aircraft System Variables
      • LIQUID DROPPING DOOR FLOW VOLUME, LIQUID DROPPING SCOOP FLOW VOLUME, LIQUID DROPPING TANK CAPACITY VOLUME, LIQUID DROPPING TANK CURRENT VOLUME, LIQUID DROPPING TANK TOTAL CAPACITY VOLUME, LIQUID DROPPING TANK TOTAL CURRENT VOLUME, LIQUID DROPPING TOTAL DROPPED FLOW VOLUME, LIQUID DROPPING TOTAL SCOOPED FLOW VOLUME.
    2. Aircraft Engine Variables
      • RECIP ENG BRAKE POWER PCT,
    3. Aircraft Electrics Variables:
      • CIRCUIT CABIN SIGNAL GO, CIRCUIT CABIN SIGNAL STANDBY, CIRCUIT CABIN SIGNAL STOP, ELECTRICAL CIRCUIT EXISTS, ELECTRICAL GENERATOR ACTIVE, ELECTRICAL GENERATOR AMPS, ELECTRICAL GENERATOR VOLTAGE, ELECTRICAL GENERATOR SWITCH, ELECTRICAL CIRCUIT AMPS, ELECTRICAL CIRCUIT VOLTAGE, ELECTRICAL EXTERNAL POWER AMPS, ELECTRICAL EXTERNAL POWER VOLTAGE,
    4. Aircraft Control Variables:
      • ELEVATOR TRIM MIN, ELEVATOR TRIM MAX, ELEVATOR TRIM PCT EX1, RUDDER TRIM MIN, RUDDER TRIM MAX, RUDDER TRIM PCT EX1, AILERON TRIM MIN, AILERON TRIM MAX, AILERON TRIM PCT EX1, FLAPS CURRENT SPEED LIMITATION,
    5. Aircraft Flight Model Variables:
      • REFERENCE SPEED MAX IAS, REFERENCE SPEED MAX IAS GEAR DOWN, MAX LANDING WEIGHT, MAX TAKEOFF WEIGHT,
    6. Helicopter Variables:
      • HOVER INDUCED VELOCITY, ROTOR GOV TARGET PCT, ROTOR GOV ENGINE TRIM,
    7. Aircraft Misc. Variables:

      • BALLOON GAS DENSITY, BALLOON GAS TEMPERATURE, BALLOON VENT OPEN VALUE, BURNER HEATING POWER, BURNER PILOT LIGHT ON, BURNER VALVE OPEN VALUE,

    8. Miscellaneous Variables:

      • AMBIENT IN SMOKE, ENV CLOUD DENSITY, ENV SMOKE DENSITY, SEA LEVEL AMBIENT TEMPERATURE, HIDE AVATAR IN AIRCRAFT,

  3. New section explaining Convenience SimVars.
  4. New section for the Electronic Flight Bag API has been added.
  5. New page added to the Key Event ID documentation:
    • Aircraft General Systems Events

      • New key events for liquid dropping system added:

        LIQUID_DROPPING_SYSTEM_DOOR_CLOSE
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_CLOSE
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_OPEN
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_SET
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_TOGGLE
        LIQUID_DROPPING_SYSTEM_DOOR_OPEN
        LIQUID_DROPPING_SYSTEM_DOOR_SET
        LIQUID_DROPPING_SYSTEM_DOOR_TOGGLE
        LIQUID_DROPPING_SYSTEM_SCOOP_CLOSE
        LIQUID_DROPPING_SYSTEM_SCOOP_OPEN
        LIQUID_DROPPING_SYSTEM_SCOOP_SET
        LIQUID_DROPPINGSYSTEM_SCOOP_TOGGLE

      • New key events for the pnuematics system added:

        PNEUMATICS_AREA_TEMPERATURE_DEC
        PNEUMATICS_AREA_TEMPERATURE_INC
        PNEUMATICS_AREA_TEMPERATURE_SET
        PNEUMATICS_FAN_SET
        PNEUMATICS_JUNCTION_LINE_OPENING_STATUS_SET
        PNEUMATICS_PACK_FLOW_AUTO_OFF
        PNEUMATICS_PACK_FLOW_AUTO_ON
        PNEUMATICS_PACK_FLOW_AUTO_SET
        PNEUMATICS_PACK_FLOW_MODE_HIGH
        PNEUMATICS_PACK_FLOW_MODE_LOW
        PNEUMATICS_PACK_FLOW_MODE_NORM
        PNEUMATICS_PACK_FLOW_MODE_SET
        PNEUMATICS_PACK_OFF
        PNEUMATICS_PACK_ON
        PNEUMATICS_PACK_SET
        PNEUMATICS_PACK_TOGGLE
        PNEUMATICS_PACKS_FLOW_DEC
        PNEUMATICS_PACKS_FLOW_INC
        PNEUMATICS_PACKS_FLOW_SET
        PNEUMATICS_TARGET_CABIN_ALTITUDE_DEC
        PNEUMATICS_TARGET_CABIN_ALTITUDE_INC
        PNEUMATICS_TARGET_CABIN_ALTITUDE_SET
        PNEUMATICS_VALVE_CLOSE
        PNEUMATICS_VALVE_MODE_AUTO
        PNEUMATICS_VALVE_MODE_CLOSED
        PNEUMATICS_VALVE_MODE_OPEN
        PNEUMATICS_VALVE_MODE_SET
        PNEUMATICS_VALVE_OPEN
        PNEUMATICS_VALVE_SET
        PNEUMATICS_VALVE_TOGGLE

      • New key events for the hydraulics system added:

        HYDRAULIC_SWITCH_TOGGLE
        HYDRAULIC_VALVE_CLOSE
        HYDRAULIC_VALVE_OPEN
        HYDRAULIC_VALVE_SET
        HYDRAULIC_VALVE_TOGGLE

  6. New page added to the Key Event ID documentation:
    • Balloon Specific Events
      • New key events for balloon burner systems have been added:

        AXIS_BURNER_PITCH_SET
        AXIS_BURNER_ROLL_SET
        BURNER_PITCH_DEC
        BURNER_PITCH_INC
        BURNER_ROLL_DEC
        BURNER_ROLL_INC
        BURNER_VALVE_CLOSE
        BURNER_VALVE_OPEN
        BURNER_VALVE_SET
        BURNER_VAL

      • New key events for balloon envelopes have been added:

        BALLOON_VENT_CLOSE
        BALLOON_VENT_OPEN
        BALLOON_VENT_SET
        BALLOON_VENT_TOGGLE

Improved:

  1. SimVar Documentation has been updated with information explaining that many of the aircraft system SimVars can now take a name (a string) instead of the usual index value when addressing specific components. Each of the sections where where this is applicable explain the setup at the top.
  2. Reverse Polish Notation documentation updated to include the following:
    1. New events added to the Mouse Variables: Enter, Exit,
      New vector operators: xyz, pbh, agl, &,
      New string operators: slen,
      New L:1 variable type added.

Developer Mode Changes

General

Fixed

  1. Fixed Aircraft Selector/Configurator Variation/Livery handling for MSFS 2020 packages
  2. Adaptive detail LOD factor does not affect User aircraft anymore

Added

  1. New Content Creator Testing Tool has been added to permit registered partners to test streamed packages.

 

Scenery Editor

Fixed

  1. Fixed projected mesh size not taken into account for mip streaming causing blurry projected meshes.

 

SimObject Editor

Improved

  1. Changed the way tailwheel is computed in the Career Compatibility Tab

Added

  1. target_specializations as a constraint which is shown in the output of the Career Compatibility Tab

 

 

SDK Changes

General

Fixed

  1. Fixed XML gauges not working after first flight.
  2. Fixed bitmaps not working anymore in XML gauges

Improved

  1. Hide avatar in aircraft if it's not edited for SR pilot system
  2. The Wear&Tear system is now deactivated on 2020 aircraft

 

SimVars

Fixed

  1. Fixed "SIMULATION TIME" environment variable returning inconsistent values when switching from/to avatar mode

 

Tools

Fixed

  1. 3dsmax: Fixed flags in texture tool
  2. Blender: Fixed reload lods for collections

Improved

  1. Blender: Added flags edition to texture
  2. Blender: Update texturelib generation

 

 

Documentation

General

Improved

  1. All references to textures being compiled to DDS have been changed to KTX2 to reflect changes in the render engine between MSFS 2020 and MSFS 2024.

 

Developer Mode

Added

  1. The Content Creator Testing Tool has been documented. 

Improved

  1. The ProjectedMesh Objects page has updated information related to the Surface Type option.
  2. The SimObject Debug Menu docs have been improved with updated information on the Weight and Tracking debug windows.

Fixed

  1. Page describing experimental features within the simulation has been removed as no longer relevant.

 

Model And Textures

Improved

  1. The page on Liveries has been completed.
  2. The page on Static Liveries has been completed.
  3. The page on Dynamic Liveries has been completed.

 

Content Configuration

Added

  1. New page describing the EFB flight plan file format: EFB Flight Plan XML (PLN File) Properties
  2. New helicopter cyclic control variables added to the flight_model.cfg file: cyclic_roll_control_scalar_negative, cyclic_pitch_control_scalar_negative.
  3. New page describing how to Use Included SimAttachments has been added to the career documentation

Improved

  1. The page covering Liveries setup has received a polish and an update.
  2. The interactive points section of the FLT File Properties page has been flagged as "coming soon", since it's currently not available in Microsoft Flight Simulator 2024.
  3. The light documentation in the systems.cfg file has been updated to remove obsolete enum values and correctly label "interior only" lights.
  4. Note related to setting up tailwheels has been added to the flight_model.cfg info page: Notes On Tailwheels
  5. The following career pages have been updated with mentions of the available included SimAttachments they can use: Aerial Advertising, Aerial Firefighting, Medevac, Scientific Research

 

Programming APIs

Added

  1. New environment variables documented: IS IN RTC, IS AVATAR, IS AIRCRAFT, EFB_BRIGHTNESS, SWITCH USER ALWAYS ALLOWED
  2. New helicopter autopilot parameters added into the systems.cfg file:

    pitch_attitude_hold_i
    pitch_attitude_hold_p
    pitch_attitude_hold_d
    pitch_attitude_hold_vel
    bank_attitude_hold_i
    bank_attitude_hold_p
    bank_attitude_hold_d
    bank_attitude_hold_vel
    heading_hold_rate
    heading_hold_rate_max
    heading_hold_bank_ang_max
    heading_hold_i
    heading_hold_p
    heading_hold_d
    altitude_hold_rate
    altitude_hold_max
    altitude_hold_pitch_ang_max
    vs_hold_pitch_i
    vs_hold_pitch_p
    vs_hold_pitch_d
    pa_collective_offset
    vs_hold_collective_i
    vs_hold_collective_p
    vs_hold_collective_d
    attitude_hold_off_speed
    attitude_hold_on_speed
    pedal_assist_off_speed
    pedal_assist_on_speed
    pedal_assist_heading_max_angle
    pedal_assist_heading_angle_scalar
    speed_hold_pitch_i
    speed_hold_pitch_p
    speed_hold_pitch_d
    speed_hold_pitch_ang_max
    speed_hold_bank_i
    speed_hold_bank_p
    speed_hold_bank_d
    speed_hold_bank_ang_max
    speed_hold_collective_i
    speed_hold_collective_p
    speed_hold_collective_d
    auto_hover_vertical_i
    auto_hover_vertical_imax
    auto_hover_vertical_p
    auto_hover_vertical_pmax

 

SDK SDK ReleaseRelease 0.10.1 0.10.1

Developer Mode Changes

General

Fixed

  1. Fixed Aircraft Selector/Configurator Variation/Livery handling for MSFS 2020 packages
  2. Adaptive detail LOD factor does not affect User aircraft anymore

Added

  1. New Content Creator Testing Tool has been added to permit registered partners to test streamed packages.

 

Scenery Editor

Fixed

  1. Fixed projected mesh size not taken into account for mip streaming causing blurry projected meshes.

 

SimObject Editor

Improved

  1. Changed the way tailwheel is computed in the Career Compatibility Tab

Added

  1. target_specializations as a constraint which is shown in the output of the Career Compatibility Tab

 

 

SDK Changes

General

Fixed

  1. Fixed XML gauges not working after first flight.
  2. Fixed bitmaps not working anymore in XML gauges

Improved

  1. Hide avatar in aircraft if it's not edited for SR pilot system
  2. The Wear&Tear system is now deactivated on 2020 aircraft

 

SimVars

Fixed

  1. Fixed "SIMULATION TIME" environment variable returning inconsistent values when switching from/to avatar mode

 

Tools

Fixed

  1. 3dsmax: Fixed flags in texture tool
  2. Blender: Fixed reload lods for collections

Improved

  1. Blender: Added flags edition to texture
  2. Blender: Update texturelib generation

 

 

Documentation

General

Improved

  1. All references to textures being compiled to DDS have been changed to KTX2 to reflect changes in the render engine between MSFS 2020 and MSFS 2024.

 

Developer Mode

Added

  1. The Content Creator Testing Tool has been documented. 

Improved

  1. The ProjectedMesh Objects page has updated information related to the Surface Type option.
  2. The SimObject Debug Menu docs have been improved with updated information on the Weight and Tracking debug windows.

Fixed

  1. Page describing experimental features within the simulation has been removed as no longer relevant.

 

Model And Textures

Improved

  1. The page on Liveries has been completed.
  2. The page on Static Liveries has been completed.
  3. The page on Dynamic Liveries has been completed.

 

Content Configuration

Added

  1. New page describing the EFB flight plan file format: EFB Flight Plan XML (PLN File) Properties
  2. New helicopter cyclic control variables added to the flight_model.cfg file: cyclic_roll_control_scalar_negative, cyclic_pitch_control_scalar_negative.
  3. New page describing how to Use Included SimAttachments has been added to the career documentation

Improved

  1. The page covering Liveries setup has received a polish and an update.
  2. The interactive points section of the FLT File Properties page has been flagged as "coming soon", since it's currently not available in Microsoft Flight Simulator 2024.
  3. The light documentation in the systems.cfg file has been updated to remove obsolete enum values and correctly label "interior only" lights.
  4. Note related to setting up tailwheels has been added to the flight_model.cfg info page: Notes On Tailwheels
  5. The following career pages have been updated with mentions of the available included SimAttachments they can use: Aerial Advertising, Aerial Firefighting, Medevac, Scientific Research

 

Programming APIs

Added

  1. New environment variables documented: IS IN RTC, IS AVATAR, IS AIRCRAFT, EFB_BRIGHTNESS, SWITCH USER ALWAYS ALLOWED
  2. New helicopter autopilot parameters added into the systems.cfg file:

    pitch_attitude_hold_i
    pitch_attitude_hold_p
    pitch_attitude_hold_d
    pitch_attitude_hold_vel
    bank_attitude_hold_i
    bank_attitude_hold_p
    bank_attitude_hold_d
    bank_attitude_hold_vel
    heading_hold_rate
    heading_hold_rate_max
    heading_hold_bank_ang_max
    heading_hold_i
    heading_hold_p
    heading_hold_d
    altitude_hold_rate
    altitude_hold_max
    altitude_hold_pitch_ang_max
    vs_hold_pitch_i
    vs_hold_pitch_p
    vs_hold_pitch_d
    pa_collective_offset
    vs_hold_collective_i
    vs_hold_collective_p
    vs_hold_collective_d
    attitude_hold_off_speed
    attitude_hold_on_speed
    pedal_assist_off_speed
    pedal_assist_on_speed
    pedal_assist_heading_max_angle
    pedal_assist_heading_angle_scalar
    speed_hold_pitch_i
    speed_hold_pitch_p
    speed_hold_pitch_d
    speed_hold_pitch_ang_max
    speed_hold_bank_i
    speed_hold_bank_p
    speed_hold_bank_d
    speed_hold_bank_ang_max
    speed_hold_collective_i
    speed_hold_collective_p
    speed_hold_collective_d
    auto_hover_vertical_i
    auto_hover_vertical_imax
    auto_hover_vertical_p
    auto_hover_vertical_pmax

 

Developer Mode Changes

Scenery Editor

Fixed

  1. Fixed a crash when editing several decals in SPC
  2. Fixed scenery objects (decals/scenery/simobjects/etc) multi edit not working properly
  3. Fixed no reload of scenery objects when editing several at once.

 

SimObject Editor

Fixed

  1. Fixed some bugs about Career Compatibility tab
  2. Fixed parameters reported as missing, even when manually added to cfg
  3. Fixed resync done before save when showing the validation error dialog

  4. Tag count in navigation graph were wrongly computed if the node was in a subgraph referenced by name

Improved

  1. Removed unwanted required condition in flight model
  2. Some constraints are now longer whitespace dependent

 

 

SDK Changes

General

Fixed

  1. Fixed not working text and .png images for XML Gauges


SimConnect

Fixed

  1. Fixed a crash while requesting unknown navigation data

 

Tools

Fixed

  1. 3dsmax: Write textures by copying them and fix gltf after exporting them
  2. Blender:
    1. Fix write textures
      Fix export Detail map
      Fix reload LODs removing the old group lods when needed
      Fix "images is None"
      Fix force set detail normal scale
      Fix Unlink/link blendmask texture
  3. Simplygon bugfixes and presets adjustments.

 

 

Documentation

Developer Mode

Added

  1. New page to describe The Career Tool, which is designed to help developers test their aircraft in the various activity scenarios.

 

Model And Textures

Improved

  1. Minor update to the section on Sky Portals to fix an error in one of the images.
  2. The 3DS Max plugin supported versions have been updated to mention that currently 2025 is not supported.
  3. New section on aircraft liveries has been added: Modeling Aircraft Liveries, Static Liveries, Dynamic Liveries
  4. New page added to help explain how to generate aircraft Thumbnails correctly.

 

Content Configuration

Added

  1. New pages related to livery setup and creation (WIP):
    1. Liveries
    2. Livery XML Properties
    3. Livery XML Examples
    4. Dynamic Library (LBL) Files
      • liveries.lbl
        material.lbl
        palette.lbl
        text.lbl
        texture.lbl
  2. New Wear And Tear parameters have been added to the [COLLISION_DAMAGE] section: FlapsLeft, FlapsLeftCable, FlapsRight, FlapsRightCable, EngineOilTank.X.
  3. New [WASM_SYSTEM.N] section added to the systems.cfg with the following parameters: ModulePath, SystemName, ParameterString.

 

Programming APIs

Added

  1. The Helicopter Variables page has been updated with the following new SimVars: NUMBER_OF_MAIN_ROTORS,
  2. The WASM API pages have been updated with the following:
    • Creating A WASM Project
    • Creating WASM Systems
  3. New JS Listener page added: JS_LISTENER_PLANNEDROUTE
  4. New JS Events added: AvionicsRouteRequested, AvionicsRouteSync
  5. New Coherent calls added: GET_EFB_ROUTE, REPLY_TO_AVIONICS_ROUTE_REQUEST
  6. New WebAssumbly API documented: Planned Route API

Improved

  1. The GPS Variables pages have been flagged as Legacy and information added to the main index page about what to do in MSFS2024.

SDK Release 0.9.3SDK Release 0.9.3

Documentation

Developer Mode

Added

  1. New page documenting the Report An Issue feature has been added.

Improved

  1. The SDK Contents page has been updated to reflect changes to the SDK install (Shared Assets, ModelBehaviourDefs, etc...)
  2. The page documenting the Virtual File System has been updated, and a new section describing the VFS Projector has been added.
  3. The page documenting The Aircraft Capture Tool has been updated to reflect changes in the tool and workflow.

 

 

SDK Tools

Fixed

  1. Updated SDK Tools page to accurately reflect the current tools available

Added

  1. New page added explaining how to update to the MSFS 2024 version of the 3DS Max plugin: Updating The 3DS Max Plugin And Projects

Improved

  1. The The 3DS Max Plugin documentation has been updated to bring it in line with MSFS 2024 standards (ongoing WIP).

 

 

Model And Textures

Improved

  1. The Propellers, Turbines And Blades art documentation has been updated with additional information related to blade pitch and feathering.

 

 

Content Configuration

Added

  1. New FLT section documented [Burner_System.N].
  2. New page listing obsolete parameters added: CFG Files Obsolete Parameters
  3. The electrical system has a new Circuit Type: DEICE_SYSTEM
  4. The de-icing system parameter structural_deice_type has been updated to include the new electrical setting.
  5. The panel.cfg lists new [EFB] section and parameters.
  6. The flight_model.cfg has the following new parameters:
    • In [CONTACT_POINTS]: water_longitudinal_friction_scalar, water_lateral_friction_scalar, water_steering_friction_scalar
    • In [COLLISION_DAMAGE]: Engine.N

Improved

  1. Legacy and obsolete parameters have been revised and more accurately labelled in the CFG Parameter Index and other files.
  2. The Modular SimObject Project Structure page has been improved with additional information related to thumbnails.

 

 

Programming APIs

Added:

  1. The WebAssembly documentation has been updated with information on the new Vars API and Event API, which replace the Gauge API. The Gauge API is now considered a legacy API which should no longer be used.
  2. The SimVar page for Aircraft Electrics Variables has been updated to show obsolete SimVars, and two new SimVars: ELECTRICAL BUS AMPS, ELECTRICAL BUS VOLTAGE.

  3. The Skydiving Key Event documentation has been updated with the following additions:

    SKYDIVE_DOORLIGHTS_DEC
    SKYDIVE_DOORLIGHTS_GETREADY
    SKYDIVE_DOORLIGHTS_INC
    SKYDIVE_DOORLIGHTS_JUMP
    SKYDIVE_DOORLIGHTS_OFF

  4. The Liquid Dropping System Key Event documentation has been updated with the following additions:

    SPRAY_ON
    SPRAY_TOGGLE
    SPRAY_SET

  5. The General Engine Key Event docs have the following new events documented:

    AXIS_THRUST_VECTOR_HORIZONTAL_SET
    AXIS_THRUST_VECTOR_VERTICAL_SET
    THRUST_VECTOR_HORIZONTAL_DECREASE
    THRUST_VECTOR_HORIZONTAL_INCREASE
    THRUST_VECTOR_VERTICAL_DECREASE
    THRUST_VECTOR_VERTICAL_INCREASE

 

SDK Release 0.9.0 (MSFS2024 initial ALPHA release)SDK Release 0.9.0 (MSFS2024 initial ALPHA release)

DOCUMENTATION

General

Added:

  1. Dark/Light mode has been added to the documentation to improve accessibility.
  2. New page added to give a reference for the The Colour Picker.

Improved:

  1. The structure of the SDK documentation has been improved to enable finding the information you require faster and easier, including improved search, an improved index, and related topics links on all pages.
  2. SDK Tools have been moved into their own unique section in the Table Of Contents and all relevant information consolidated under that section.
  3. Aircraft samples have been converted into the following two modular aircraft:

 

 

SDK Tools

Added:

  1. Documentation has been added to describe the new Input Application for creating custom input profiles for devices and aircraft. This includes the following pages:
    1. Global Input Profile Package Setup
      Aircraft Input Profile Package Setup
      Creating An Input Profile
      DeviceConfig XML Properties
      Input Configuration XML Properties

  2. A page has been added for The Mission Tool.

    NOTE: This tool is a temporary fix to allow developers to test certain aspects of mission creation and will be removed in future versions of the Microsoft Flight Simulator 2024 DevMode / S

 

 

Developer Mode - General

Added:

  1. A new option for Lighting Display debugging has been documented.
  2. The DevMode Toolbar has been documented.
  3. The Behaviors Debug window has been documented

Improved:

  1. The "Debug PBR" menu page has been renamed as Channel Display and has had some additional updates to cover new options.
  2. Some menus can now be "detached" so you can easily access common options. See here for more information: Detachable Menus
  3. The "Debug PBR" menu page has been renamed as Channel Display and has had some additional updates to cover new options.
  4. The Aircraft Editor section has been removed and replaced by the more general SimObject Editor.
  5. The section on using the Screenshot tool has been updated.
  6. The Developer Camera Settings section has been updated with new options.

 

 

The Project Editor

Added:

  1. The new Package States have been documented.
  2. New Package Order Hint section has been added to The Project Inspector page.

Improved:

  1. The Asset Types page has been tidied and now shows information for all relevant asset types available, including the new Airport asset group type.
  2. All references to the setup for the Marketplace have been removed from the documentation as this is now all handled on the Marketplace itself.

 

 

The Scenery Editor

Added:

  1. Airport Objects - Override Archetypes options have been added.
  2. PaintedLine Objects - New option for outlines has been added.
  3. Decal Objects - New decal object for the Scenery Editor has been documented.
  4. TaxiwayServiceStand Objects - New taxiway service stand object has been documented.
  5. Text Objects - New text object for the scenery editor has been documented.
  6. VDGS Objects - New Visual Docking Guidance System (VDGS) object for the scenery editor has been documented.
  7. SimPropContainer Object - New scenery object type has been added. See also: Modeling SimPropContainers
  8. SimPropContainer XML Properties and SimPropContainer Object Examples have been added to describe the XML used by the new SimPropContainer object.
  9. New "Apron Services" option has been documented for Airport Objects, TaxiwayParking Objects and Helipad Objects.
  10. New Navigation Graph options have been documented for The View Menu.
  11. New render options have been added to The Rendering Menu page.

Improved:

  1. Helipad Objects - Multiple new options for helipads have been documented.
  2. TaxiwayParking Objects - Multiple new options for taxiway parking objects have been documented.
  3. Information has been added to the Creating A SimObject and Creating A Scenery Object pages.
  4. Information has been added to the Scenery XML And Model CFG page.

 

 

The Material Editor

Added:

  1. New page on The Bitmap Manager has been added.

Improved:

  1. The Material Inspector page has been updated with new "extra settings" section.

 

 

The SimObject Editor (Previously the Aircraft Editor)

Added:

  1. The SimObject Editor main page has been added withinformation about the new editor
  2. The Attached Objects tab has been documented.
  3. The Attachment tab has been documented.
  4. The Navigation Graph tab has been documented.
  5. The Livery tab has been documented
  6. The Effects tab has been documented
  7. The Texture tab has been documented
  8. The Model LOD tab has been documented.
  9. The Animations tab has been documented.
  10. The Sounds tab has been documented.
  11. A dedicated page listing all SimObject Editor parameters have been added: The SimObject Editor Parameter Index
  12. The new debug window - Debug Dirt And Scratches - has been added to the documentation.
  13. The new debug window - Covers And Chocks - has been added to the documentation.
  14. The new debug window - Debug Aircraft Attachments - has been added to the documentation.

Improved:

  1. The Aircraft Data debug window docs have been updated to reflect additions to the window.

 

 

The Navigation Graph Editor

Added:

  1. New page describing The Navigation Graph Editor has been added. Tis editor is for desiging navigation graphs which are used to help objects navigate around both the world and aircraft, as well as many other things.
  2. New page describing Using The Navigation Graph Editor has been added.

 

 

The SimAttachment Editor

Added:

  1. The SimAttachment Editor has been added to the documentation. This editor is similar to the SimObject Editor, but designed for editing stand-along attachments that can then be added to your aircraft and scenery.

 

 

Models And Textures

Added:

  1. The new Texture Tool has been documented.
  2. New pages have been added for the Texture XML Properties and texture.json files.
  3. A page has been added explaining how to use the Simplygon SDK to simplify the creation of scenery object LODs: Using Simplygon To Generate LODs
  4. A page has been added to explain the updated LOD Selection System for all 3D models.
  5. The Modeling Aircraft documentation has had the following pages added:
    1. Propellers, Turbines And Blades
      Clearcoat
      Dirt And Grime
      Registration Numbers
      Covers, Chocks, And Pins
      Doors, Hatches, And Canopies
      Fuel Truck And GPU Connections

Improved:

  1. FlightSim Materials (all material documentation has been updated to the new MSFS 2024 standards)
  2. The glTF Schemas page has been updated with information on the new schemas available.
  3. The Multi-Exporter documentation has received a major update.
  4. The Modeling Aircraft documentation has had the following pages updated:
    1. File Setup
      Airframe Textures And Materials
      Windshield And Windows
      Exterior Lights
      Wheels
      Airframe Details
      Ice
      Airframe Collision Meshes
      Ambient Occlusion
      Parallax Windows
      Aircraft LODs

 

 

Content Configuration

Added:

  1. New section outlining details of the updated MSFS Avionics Framework for MSFS 2024 has been added.
  2. CFG Files General Information page has been added, and now contains updated information about the different data types, including the new table format that permits nD tables.
  3. New Simple SimObject types have been documented:
    1. Procedural Characters
      Simple Objects
  4. New pages have been added related to the setup for Modular Aircraft:
    1. Modular Aircraft Project Structure
      Modular Aircraft Merging
      Modular Aircraft XML Properties
      Modular Aircraft CFG Files
      Sim Attachments
      Included Attachments
  5. New pages have been added related to the configuration of models within the simulation:
    1. Livery XML Properties
  6. New pages have been added to describe the setup of light effects:
    1. Implementing Lights
      Light FX Properties
      effects.cfg
  7. A new section has been added for Navigation Services And Interactions:
    1. Services XML Properties
      Navigation Services XML Properties
      SimMission Navigation Services
      Interaction XML Properties
      Interaction Presets
  8. A new section has been added for Apron Services:
    1. Apron Control XML Properties
      Apron Services XML Properties
      Apron Control Mission XML Properties
      Built-In Apron Services
      Global Apron Services
  9. A new Careers section has been added outlining the setup for custom aircraft to be used in the various career missions. This section covers the following:

    1. Preflight
      Spawn Pilot (Transversal)
      Aerial Advertising
      Aerial Construction
      Aerial Firefighting
      Agricultural Aviation
      Cargo Transport
      Charter Service
      Commercial Flights And Passengers
      Ferry Flights
      Flightseeing / First Flight
      Medevac
      Scientific Research
      Search And Rescue
      Skydiving
      Using Included SimAttachments

  10. The page for the <SimMission.Calculator> has new items listed specifically for use with Navigation Services, Apron Services, and Interactions:

    1. <CabinServiceBehaviourParameter>
      <CabinServiceStateParameter>
      <CabinServiceGraphParameter>
      <ParentCabinServiceBehaviourParameter>
      <ParentCabinServiceStateParameter>
      <ApronContextParameter>
      <ApronControlMissionContext>
      <InteractivePointParameter>
      <InteractivePointUser>
      <InteractivePoint>
      <InteractivePointType>
      <InteractivePointSearchPreferences>
      <ParkingParameter>
      <ParkingName>
      <ParkingNumber>
      <ParkingSuffix>
      <StandType>
      <StandRole>
      <HelipadParameter>
      <HelipadProperty>
      <DesiredValue>
      <Units>

  11. FLT file documentation has been updated with a new page for FLT Additional Information and the following new sections:
    1. [HYDRAULICS_SYSTEM_EX1.N]
      [PNEUMATIC_SYSTEM_EX1.N]
      [Liquid Dropping System.N]
      [Gauges.N]
      [Navigation_Graph.N]
      [WEAR_AND_TEAR_SYSTEM.N]
      [CabinService.N]
      [CabinServiceObject.N]
      [Dirt.N]
  12. The FLT file documentation also has the following new parameters:
    1. [Systems.N] - GovernorTarget
      [Covers] - chock, engine, pitot, static_port, rotor, landing_gear
      [Sim.N]: Livery,
  13. New section on Changes Between MSFS 2020 And MSFS 2024
  14. The Checklist XML Properties page has the following new elements: <Link>,
  15. New page that includes a detailed overview of the new features of the MSFS 2024 audio system has been added: Audio Migration And Updating
  16. The page related to the Localization (LOC Files) has a new section outlining Supported Languages.
  17. New CFG file for dealing with navigation graphs has been documented: navigation_graph.cfg.
  18. New section in the gameplay.cfg has been documented: [WEAR_AND_TEAR_SYSTEM]
  19. The cockpit.cfg documentation has the following new section and parameters:
    1. Various new parameters have been added to customise the external HUD: [MISC].
      New section and parameters related to general cockpit information: [General].
  20. The systems.cfg file documentation has received the following additions:
    1. [HYDRAULICS_SYSTEM_EX1], Hydraulics System Setup Information, Hydraulic System Examples.
      [PNEUMATIC_SYSTEM_EX1], Pneumatic System Setup Information, Pneumatic System Examples.
      [WATER BALLAST SYSTEM]
      [Liquid Dropping System]
      [ELECTRICAL], Electric System Setup Information
      [BRAKES]: toe_brakes_pressure_increment, toe_brakes_pressure_release_delay, toe_brakes_pressure_decrease_tc. rto_min_speed_for_trigger,
      [AUTOPILOT]: auto_throttle_derivative_boundary, auto_throttle_derivative_control, auto_throttle_integrator_boundary, auto_throttle_integrator_control, auto_throttle_proportional_control,
      [LocalVars_EX1]: new section for L:1 type vars added.
  21. The ai.cfg has the following new section: [AI_INPUT]
  22. The aircraft.cfg has the following new pages, sections and parameters:
    1. The [GENERAL] section has the following new parameters: object_class,
      The [SERVICES] section has a new parameter: WINCH.
      The [PILOT] section has new parameters (and all previous parameters are now considered legacy): cabin_service, generated_copilot, copilot_behavior. hide_avatar,
      The [FLTSIM.N] section has the following new parameters: ui_powerplant_specifics, ui_instrumentation, ui_additional_information, operating_status, targeted_specializations, military, premium,
      A new page has been added to include additional information for the aircraft.cfg and sim.cfg files: Aircraft.cfg / Sim.cfg Additional Information
  23. The flight_model.cfg has the following new pages, sections and parameters:
    1. The [AERODYNAMICS] section has the following new parameters:

      1. stallalpha
        stallalpha_ff,

    2. The [WEIGHT_AND_BALANCE] section has the following new parameters:
      • max_takeoff_weight, max_landing_weight,
    3. The [AIRPLANE_GEOMETRY] section has the following new parameters:
      • cockpit_width, cockpit_height, control_aileron_forcebased, control_aileron_maxforce_student, control_aileron_minforce_student, control_aileron_maxforce_pilot, control_aileron_minforce_pilot, control_aileron_maxforce_testpilot, control_aileron_minforce_testpilot, control_aileron_still_force_at_max, control_aileron_still_force_to_move, control_aileron_dynpres_ratio_force_at_max, control_aileron_dynpres_ratio_force_to_move, control_aileron_neutral_return_force_scalar, control_elevator_forcebased, control_elevator_maxforce_student, control_elevator_minforce_student, control_elevator_maxforce_pilot, control_elevator_minforce_pilot, control_elevator_maxforce_testpilot, control_elevator_maxforce_testpilot, control_elevator_still_force_at_max, control_elevator_still_force_to_move, control_elevator_dynpres_ratio_force_at_max, control_elevator_dynpres_ratio_force_to_move, control_elevator_neutral_return_force_scalar, control_rudder_forcebased, control_rudder_maxforce_student, control_rudder_minforce_student, control_rudder_maxforce_pilot, control_rudder_minforce_pilot, control_rudder_maxforce_testpilot, control_rudder_minforce_testpilot, control_rudder_still_force_at_max, control_rudder_still_force_to_move, control_rudder_dynpres_ratio_force_at_max, control_rudder_dynpres_ratio_force_to_move, control_rudder_neutral_return_force_scalar,
    4. The [HELICOPTER] section has the following new parameters:
      • cyclic_move_rate_limit, rudder_pedals_move_rate_limit, rotor_node.n,
    5. The [MAINROTOR] and [SECONDARYROTOR] sections have the following new parameters:
      • BrakeCircuit,
    6. The [FLIGHT_TUNING] section has the following new parameters:
      • ground_new_contact_model_gear_flex, ground_new_contact_model_gear_flex_damping, ground_new_contact_model_rolling_stickyness, ground_new_contact_model_up_to_speed_lateral, ground_new_contact_model_up_to_speed_lateral_steering, ground_new_contact_model_up_to_speed_longitudinal, enable_high_accuracy_integration,
    7. The [WEIGHT_AND_BALANCE] section has had the following new parameters added:
      • max_zero_fuel_weight,
    8. The [FUEL_SYSTEM] section has been updated and expanded.
    9. A new section for [COLLISION_DAMAGE] has been added as part of the damage/wear and Tear system. Included in this addition, new parameters have been added to the [FLAPS.N] section as well:
      • FlapSurface_Left, FlapSurface_Right, FlapCable_Left, FlapCable_Right.
    10. A new section and parameters have been added for hot air balloons: [BALLOON].
    11. The point.N parameter in the [CONTACT_POINTS] section has received a new table entry to control how the gear handle will interact with the landing gear when this is extensible.
    12. A new section (with parameters) has been added that permits you to disable the standard geometric representation of certain elements of the flight model. See the [DESIGN_ACTIVATION] section for more details. To accompany this, there are also the following new sections (with parameters) that deal with custom geometries and other physical items in the simulation:
      1. [OBJ_EA1_BALLOON.N]
        [OBJ_EA1_PITOTFLAG.N]
        [OBJ_EA1_YAWSTRING.N]
        [OBJ_EA1_ROPECRATE.N]
        [OBJ_EA1_BANNER.N]
        [OBJ_EA1_SIMPLEGEAR.N]
        [OBJ_EA1_SURFACE.N]
  24. The engines.cfg has the following new pages, sections and parameters:
    1. New page containing additional information to help setup the engine CFG file has been added here: engines.cfg - Additional Information
    2. The [GENERALENGINEDATA] section has the following new parameters: smoke_protection,
    3. The [PROPELLER] section has the following new parameters:
      • number_of_propellers, prop_node.n, governor_prop_pitch_rate, feathering_prop_pitch_rate, beta_range_prop_pitch_rate, beta_forced_prop_pitch_rate, min_flight_beta_throttle_pos, rotation,
    4. The [TURBINEENGINEDATA] section has the following new parameters:
      • turbine_node.n, turbine_blades, N1_100pc_rpm, bleed_air_high_gain, bleed_air_med_gain, bleed_air_lo_gain, bleed_air_hi_bkpt, bleed_air_lo_bkpt,
  25. The following new CFG files have been documented:
    1. attached_objects.cfg
      attachment.cfg
      effects.cfg
      flight_performance.cfg
      livery.cfg
      model.cfg
      texture.cfg

 

Improved:

  1. The SimObj documentation has been split into two sections given the changes to aircraft SimObj. There is now a section for Simple SimObjects and another for Modular Aircraft SimObjects.
  2. The mission documentation has been updated with a new section detailing the mission XML elements for navigation services: SimMission Navigation Services
  3. The following updates and additions have also been made to various Model Behaviour XML files:
    1. The <Parameters> element has a new available value for the Process attribute: "Macro".
      The <MouseFlags> element has two new flags available: Enter, Exit.
      The <CompileBehaviors> element has been documented.
      Changes to the <Binding> element have been documented.
      Changes to the <EmissiveFactor> element have been documented.
      New attributes for the <Condition> element have been documented.
      Input event name restrictions have been documented (alpha-numeric with the "-"and "_" symbols only are permitted).
  4. The entire section dedicated to creating Checklists has been updated.
  5. The following scenery XML pages have been updated:
    1. General Environment XML Properties
      1. <Vertex /> has been updated.
      2. <Ndb> / <Vor> / <Dme /> have all been added.
    2. Airport XML Properties
      1. <Airport> / <Apron> have been updated.
      2. <AirportArchetype> /<ParamOverride /> / <ApronControl> have all been added.
    3. Taxiway XML Properties
      1. <TaxiwayParking /> has been updated.
      2. <TaxiwayServiceStand /> has been added.
    4. Scenery Editor Object XML Properties
      1. <Decal /> has been added.
  6. The information relating to setting up aircraft audio has been updated.
  7. There has been a general update to all the pages related to Model Behaviors to bring them in line with the MSFS 2024 standards. It is worth noting that the following pages are either new or have received a complete rewrite:
    1. Important Templates
      Using Model Behaviors
      Model Behaviors Parameters
      Model Behaviors Inputs
      Creating Cockpit Interactions (previously called "Creating Interactions With Input Events")
      Creating Interaction Tooltips
  8. The following parameters across various CFG files have been changed and no longer require a list, and instead take a hash-map: lightdef.N, point.N, interactive_point.N,

 

 

Programming APIs

Added:

  1. SimVar Documentation has been updated with multiple new sections:
    1. Pneumatics
      Hydraulics
      Water Ballast
      Liquid Dropping System
      Aircraft Wear And Tear States
  2. New SimVars added in the following sections:
    1. Aircraft System Variables
      • LIQUID DROPPING DOOR FLOW VOLUME, LIQUID DROPPING SCOOP FLOW VOLUME, LIQUID DROPPING TANK CAPACITY VOLUME, LIQUID DROPPING TANK CURRENT VOLUME, LIQUID DROPPING TANK TOTAL CAPACITY VOLUME, LIQUID DROPPING TANK TOTAL CURRENT VOLUME, LIQUID DROPPING TOTAL DROPPED FLOW VOLUME, LIQUID DROPPING TOTAL SCOOPED FLOW VOLUME.
    2. Aircraft Engine Variables
      • RECIP ENG BRAKE POWER PCT,
    3. Aircraft Electrics Variables:
      • CIRCUIT CABIN SIGNAL GO, CIRCUIT CABIN SIGNAL STANDBY, CIRCUIT CABIN SIGNAL STOP, ELECTRICAL CIRCUIT EXISTS, ELECTRICAL GENERATOR ACTIVE, ELECTRICAL GENERATOR AMPS, ELECTRICAL GENERATOR VOLTAGE, ELECTRICAL GENERATOR SWITCH, ELECTRICAL CIRCUIT AMPS, ELECTRICAL CIRCUIT VOLTAGE, ELECTRICAL EXTERNAL POWER AMPS, ELECTRICAL EXTERNAL POWER VOLTAGE,
    4. Aircraft Control Variables:
      • ELEVATOR TRIM MIN, ELEVATOR TRIM MAX, ELEVATOR TRIM PCT EX1, RUDDER TRIM MIN, RUDDER TRIM MAX, RUDDER TRIM PCT EX1, AILERON TRIM MIN, AILERON TRIM MAX, AILERON TRIM PCT EX1, FLAPS CURRENT SPEED LIMITATION,
    5. Aircraft Flight Model Variables:
      • REFERENCE SPEED MAX IAS, REFERENCE SPEED MAX IAS GEAR DOWN, MAX LANDING WEIGHT, MAX TAKEOFF WEIGHT,
    6. Helicopter Variables:
      • HOVER INDUCED VELOCITY, ROTOR GOV TARGET PCT, ROTOR GOV ENGINE TRIM,
    7. Aircraft Misc. Variables:

      • BALLOON GAS DENSITY, BALLOON GAS TEMPERATURE, BALLOON VENT OPEN VALUE, BURNER HEATING POWER, BURNER PILOT LIGHT ON, BURNER VALVE OPEN VALUE,

    8. Miscellaneous Variables:

      • AMBIENT IN SMOKE, ENV CLOUD DENSITY, ENV SMOKE DENSITY, SEA LEVEL AMBIENT TEMPERATURE, HIDE AVATAR IN AIRCRAFT,

  3. New section explaining Convenience SimVars.
  4. New section for the Electronic Flight Bag API has been added.
  5. New page added to the Key Event ID documentation:
    • Aircraft General Systems Events

      • New key events for liquid dropping system added:

        LIQUID_DROPPING_SYSTEM_DOOR_CLOSE
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_CLOSE
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_OPEN
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_SET
        LIQUID_DROPPING_SYSTEM_DOOR_COMMAND_GROUP_TOGGLE
        LIQUID_DROPPING_SYSTEM_DOOR_OPEN
        LIQUID_DROPPING_SYSTEM_DOOR_SET
        LIQUID_DROPPING_SYSTEM_DOOR_TOGGLE
        LIQUID_DROPPING_SYSTEM_SCOOP_CLOSE
        LIQUID_DROPPING_SYSTEM_SCOOP_OPEN
        LIQUID_DROPPING_SYSTEM_SCOOP_SET
        LIQUID_DROPPINGSYSTEM_SCOOP_TOGGLE

      • New key events for the pnuematics system added:

        PNEUMATICS_AREA_TEMPERATURE_DEC
        PNEUMATICS_AREA_TEMPERATURE_INC
        PNEUMATICS_AREA_TEMPERATURE_SET
        PNEUMATICS_FAN_SET
        PNEUMATICS_JUNCTION_LINE_OPENING_STATUS_SET
        PNEUMATICS_PACK_FLOW_AUTO_OFF
        PNEUMATICS_PACK_FLOW_AUTO_ON
        PNEUMATICS_PACK_FLOW_AUTO_SET
        PNEUMATICS_PACK_FLOW_MODE_HIGH
        PNEUMATICS_PACK_FLOW_MODE_LOW
        PNEUMATICS_PACK_FLOW_MODE_NORM
        PNEUMATICS_PACK_FLOW_MODE_SET
        PNEUMATICS_PACK_OFF
        PNEUMATICS_PACK_ON
        PNEUMATICS_PACK_SET
        PNEUMATICS_PACK_TOGGLE
        PNEUMATICS_PACKS_FLOW_DEC
        PNEUMATICS_PACKS_FLOW_INC
        PNEUMATICS_PACKS_FLOW_SET
        PNEUMATICS_TARGET_CABIN_ALTITUDE_DEC
        PNEUMATICS_TARGET_CABIN_ALTITUDE_INC
        PNEUMATICS_TARGET_CABIN_ALTITUDE_SET
        PNEUMATICS_VALVE_CLOSE
        PNEUMATICS_VALVE_MODE_AUTO
        PNEUMATICS_VALVE_MODE_CLOSED
        PNEUMATICS_VALVE_MODE_OPEN
        PNEUMATICS_VALVE_MODE_SET
        PNEUMATICS_VALVE_OPEN
        PNEUMATICS_VALVE_SET
        PNEUMATICS_VALVE_TOGGLE

      • New key events for the hydraulics system added:

        HYDRAULIC_SWITCH_TOGGLE
        HYDRAULIC_VALVE_CLOSE
        HYDRAULIC_VALVE_OPEN
        HYDRAULIC_VALVE_SET
        HYDRAULIC_VALVE_TOGGLE

  6. New page added to the Key Event ID documentation:
    • Balloon Specific Events
      • New key events for balloon burner systems have been added:

        AXIS_BURNER_PITCH_SET
        AXIS_BURNER_ROLL_SET
        BURNER_PITCH_DEC
        BURNER_PITCH_INC
        BURNER_ROLL_DEC
        BURNER_ROLL_INC
        BURNER_VALVE_CLOSE
        BURNER_VALVE_OPEN
        BURNER_VALVE_SET
        BURNER_VAL

      • New key events for balloon envelopes have been added:

        BALLOON_VENT_CLOSE
        BALLOON_VENT_OPEN
        BALLOON_VENT_SET
        BALLOON_VENT_TOGGLE

Improved:

  1. SimVar Documentation has been updated with information explaining that many of the aircraft system SimVars can now take a name (a string) instead of the usual index value when addressing specific components. Each of the sections where where this is applicable explain the setup at the top.
  2. Reverse Polish Notation documentation updated to include the following:
    1. New events added to the Mouse Variables: Enter, Exit,
      New vector operators: xyz, pbh, agl, &,
      New string operators: slen,
      New L:1 variable type added.

 

Related Topics

  1. Introduction
  2. SDK Contents
  3. SDK Overview