# SimConnect CFG Definition<no value>

{{< callout context="caution" title="IMPORTANT!" icon="outline/alert-triangle" >}}

This section relates to a legacy process intended for use with Microsoft Flight Simulator X. It is still valid for Microsoft Flight Simulator 2024 but may be changed or even removed at some time in the future and should only be used for support of legacy add-ons.

{{< /callout >}}

The `SimConnect.cfg` file ([which you can get here](../../assets/files/simconnect/simconnectcfg/)) contains communication information for the SimConnect **client**. This file is only required if a client is going to access Microsoft Flight Simulator 2024 running on a remote machine, and should be placed in the same folder as the client application or library, on the computer the client is running on.

 

The `SimConnect.cfg` file can contain a number of configurations, identified in sections with the `[SimConnect.N]` title. The index number is used as a parameter in the `SimConnect_Open` function. This is useful for applications that communicate with a number of different machines that are runningMicrosoft Flight Simulator 2024 . The default configuration index is zero, and if there is only one configuration in the file, no index number is required.

 

The `SimConnect.CFG` should be formatted as follows:

``` xml
[SimConnect.0]
Protocol=Pipe
Port=Custom/SimConnect
Address=127.0.0.1
 
[SimConnect.1]
Protocol=Ipv6
Port=501
Address=127.0.0.1
 
; Further connections here if required
```

 

Below you can find information on the different sections used in the `SimConnect.cfg` file as well as what parameters and values are expected within them.

 

 

### [SimConnect.*N*]

This section permits you to define client options for one or more connections:

 

<table><thead><tr class="header"><th>Parameter</th><th>Description</th><th>Type</th></tr></thead><tbody><tr class="odd"><td>Protocol</td><td><p>Set's the protocol to use for the client connection. <code>Pipe</code> uses a "Named-Pipes" communcation system and the <code>IPv4</code> and <code>IPv6</code> protocols are available on computers running Windows, with <code>IPv4</code> as the default (<code>IPv6</code> has more security features and is recommended, however).</p><p>The order in which protocols are evaluated is: <code>Pipe</code>, <code>IPv6</code>, <code>IPv4</code>, <code>Pipe</code>. So, for example, if this entry is set at <code>IPv6</code>, then <code>IPv4</code> and <code>Pipe</code> will evaluated in that order and the first working protocol found will be used. The advantage of <code>Pipe</code> communication is that it avoids conflict with firewalls and virus protection software when the connection is local, which of course is not the situation if a <code>SimConnect.cfg</code> file is required.</p></td><td><p>String:</p><p>Pipe  

IPv4  

IPv6</p></td></tr><tr class="even"><td>Address</td><td>The Address of the SimConnect server should be entered in this field and will be the same value as that in the appropriate Comm section of the <code>SimConnect.xml</code> file. The address can be the name of a computer in a Domain Controller environment.</td><td>String</td></tr><tr class="odd"><td>Port</td><td>The Port of the SimConnect server should be entered in this field and will be the same value as that in the appropriate Comm section of the <code>SimConnect.xml</code> file.</td><td>String</td></tr><tr class="even"><td>MaxReceiveSize</td><td>The maximum packet size. The default is 8192. If the client receives a packet larger than this size, it will disconnect from the server.</td><td>Integer</td></tr><tr class="odd"><td>DisableNagle</td><td>Set to 1 (TRUE) to disable the Nagle packet optimization algorithms, otherwise set to 0 (FALSE).</td><td>Bool</td></tr></tbody></table>