Documentation
Complete reference for the SimConnect Go SDK.
Manager
Client / Engine
Getting Started
Install the library and write your first Microsoft Flight Simulator connection.
Engine/Client Configuration
Configuration options for the SimConnect engine client.
Engine/Client Usage
Complete API reference for direct simulator communication.
Using Datasets
Pre-built dataset constructors for aircraft, environment, simulator, navigation, objects, and traffic data.
Client Data Areas
Using SimConnect Client Data Areas for inter-add-on shared memory communication.
Engine AI Objects
Create, remove and release AI aircraft and simulated objects with the Engine client's raw AICreate* API.
Facility Data
Query airports, VORs, NDBs, and waypoints using the facility data API.
Input Events
Enumerate, read, write, and subscribe to MSFS 2024 Input Events via the SimConnect API.
nav
Airways, Waypoints & Navaids
Crawl the enroute airway network from the facility API with pkg/nav, cache it as JSON and route between fixes.
Weather, Runway in Use & ATIS
Read the weather with pkg/nav, choose the runway in use from the wind and broadcast an ICAO style ATIS.
Flight Plans
Plan an IFR flight with pkg/nav: runways in use, SID, airways, STAR and approach, cruise level, time and fuel, and write it as an MSFS .pln file.
packages
SimVar CLI
Interactive CLI tool for reading, writing, and streaming MSFS SimVars from the command line
SimVar Registry
pkg/registry — cross-platform typed SimVar metadata catalogue
Installed Add-ons
Find the simulator's packages folder, list Community and streamed packages, find the package of the loaded aircraft, fingerprint the set and list running processes with pkg/addons.
Radios and Transponder
Set the user aircraft's COM frequencies, swap them and set the squawk with pkg/avionics.
Aircraft Systems Profiles
Read the user aircraft's power, radios, engines, lights, doors, transponder, flaps and gear with pkg/systems: standard SimVars, per-model profiles as data, local overrides.
Flight Recording
Record how an aircraft flies, the user's or AI, every sim frame with pkg/flight: a versioned Track of position, attitude, speeds, gear, flaps, spoilers, control surfaces, lights, engines and autopilot, written as JSON lines and interpolated at any time.
GSX and L:vars
Read GSX Pro's state and write L:vars of your own for other add-ons.
Checklists
The aircraft's normal checklists as data with pkg/checklist: a default per family and per-model sets, a local override file, a runner that steps through a list with the roles of the moment and checks each item against systems.State, and checklist findings for flight.Assess.
L:vars
Write local variables (L:vars) on the user aircraft with pkg/lvars, to signal other add-ons or set the ones they document as settable.
Pilot Flying
pkg/pilot flies the user aircraft as the copilot, pilot flying on the autopilot: the speed schedule, flaps and gear asked of the player as pilot monitoring, the approach armed when cleared, the controls handed back at minimums.
Hotkeys
Keys and joystick buttons the player presses in the simulator, bound to an add-on's actions with pkg/hotkeys over SimConnect input groups: bind by name, rebind from a settings file, mapped again after a reconnect.
Geodesy and Unit Conversion
pkg/calc for distances, bearings, tracks, wind and Dubins paths; pkg/convert for units, local offsets, angles and ICAO codes.
Dictionaries
Replace the library's embedded tables at runtime with pkg/dict: airlines, aircraft types, wake, performance, airport names and limits, ATC units, GA types, systems profiles.
traffic
Traffic Guide
Create and manage AI aircraft using the pkg/traffic package.
Departure Taxi
Spawn an AI aircraft at a stand, push it back and taxi it to a runway with the pkg/traffic TaxiController.
Arrivals & Parking
Land an AI aircraft, roll out to a runway exit and taxi it to a stand with the pkg/traffic ArrivalController: MSFS AI, hybrid or fully injected.
Injected Ground Movement
Drive AI aircraft on the ground by position injection: smooth turns, realistic speed changes and lights that stay as set.
ATC Commands
Every clearance and command for injected departures and arrivals: when it applies, what the aircraft does and the events it reports.
ATC Game
Work ground and tower at an MSFS airport with the airport map: arrivals on STARs, departures on SIDs, every clearance yours, scored.
Aircraft Profiles and Telemetry
One profile per aircraft type for injected traffic: airframe, taxi, take-off, approach, rollout, flaps and stand stop; refined from SimVars and tuned from recorded movements.
Traffic Picture
All traffic around a centre of the world — fixed or following the user's aircraft — with phases, airports in range, and the ground and stand feeds for the controllers.
Traffic Schedules
Scheduled flights for the airports around the centre of the world: airlines, fleets, routes and time-of-day waves, and overflights crossing the area; deterministic for a seed.
Traffic Manager
Turn a schedule into traffic: departures board and push on time, arrivals fly their STAR, aircraft turn around, and a situation checker adjusts to what is happening — including traffic that is not ours.
Airborne Separation
Airborne ATC: wake separation, spacing on final by the weather, the landing sequence, losing a delay, holding, the runway controller, go-arounds, conflicts ahead and working the approach.
Radio
What ATC says, as structured transmissions: positions, intents and parameters with the text as said, for a log, a UI or a voice library.
Phraseology
ICAO and FAA radiotelephony phraseology side by side for the gate-to-gate IFR airline flow, with sources, readbacks and differences.
Camera
The MSFS 2024 add-on camera: bindings, poses, drone moves, a director that plays shots, and scripted scenes on the airport map.
Traffic Decisions
How the traffic decides, with the numbers from the code: pushback choice, ground give-way, taxi routing, the runway, sequencing, delays, holds and conflicts — to check a decision seen on the map.
VFR Traffic
v0.19 VFR traffic: light aircraft, circuits round a runway (configurable per airport), reporting points, and how VFR traffic joins and leaves.
Traffic World
The airport map's traffic engine as a package: scheduled traffic with its ATC, run on its own simulator connection or a host's, with its HTTP API, a snapshot and hooks for the host's voice.
Traffic Smoothness
Why our traffic must move without a hitch, how to measure it live and in benchmarks, what made it stutter and the rules that keep it smooth.