SimConnect clients are not currently thread-safe. NET languages with their rich support for objects and ease of building the UI. Out-of-process also supports managed code, and therefore applications can be written in. This is because out-of-process applications provide more stability, if they crash they typically will not crash Microsoft Flight Simulator, and they are easier to build, test and debug.
exe file) rather than in-process (a WASM module). The recommended method of writing an add-on is to build it out-of-process as an application (an.
The client then waits for the information to be received from the server, and then processes it appropriately. The client opens up communications with the server, then requests that certain events and certain object information is passed to it. The design of a SimConnect add-on involves writing a client to communicate with a server running within Microsoft Flight Simulator. An example is given with the SimvarWatcher sample.NET language add-ons, refer to the special section on Programming SimConnect Clients using Managed Code, but general procedure is: Build the application using the function calls described in this document.įor C#, or other.Link to the SimConnect.lib library, by adding the following dependencies to Additional dependencies:.Add the SimConnect the library directory ( $(MSFS_SDK)\SimConnect SDK\lib) to the Additional Library Directories:.Add the SimConnect include folder ( $(MSFS_SDK)\SimConnect SDK\include) to the Additional Includes:.$(MSFS_SDK)\SimConnect SDK\VS\SimConnectClient.propsĪlternatively, the configuration can be performed manually, by performing the following steps: Property Manager -> (select project) -> Add Existing Property SheetĪnd selecting the Property Sheet provided in the SDK: The SDK now provides Visual Studio property sheet.
The dependencies can be either configured Using the Property Manager, or via Manual Configuration.
In order to use the SimConnect functionality, it is required to include the SimConnect.h header file. Start a new MFC Application if the add-on will have a user interface. To build the project, make sure you have completed the following steps.įor out-of-process applications, start a new Console Application project if the add-on will have no user interface. To build SimConnect add-ons, the recommended Visual Studio version is Visual Studio 2019, with a minimum version of 2005. It is only required to inlcude "simconnect.h". WebAssembly modules can use SimConnect internally, provided as part of the SDK.
This section describes how to set up a working development environment for SimConnect. You can also find additional helpful information from the following pages:įinally, there are some pages relating to legacy files that could be used for configuring and debugging SimConnect client/server communications (these files can still be used, although it's not recommended any longer and the functionality may be removed or changed in the future):