Skip to content

Update system requirements #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ltoenning merged 4 commits into from
Jan 24, 2026
Merged

Update system requirements #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9f6786
Add X-Plane 12
ltoenning Jan 24, 2026
4eac104
fixup! Add X-Plane 12
ltoenning Jan 24, 2026
690f615
Fix X-Plane and macOS spelling
ltoenning Jan 24, 2026
be55168
Update simulator plugin list
ltoenning Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/documentation/flying/integrated_com.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
!!! warning

If you use "synced" and you see NO (or incorrect) TX/RX values checked, it could mean your COM unit is off in the plane.
Especially in XPlane the vendors follow various concepts indicating the COM status in the datarefs.
Especially in X-Plane the vendors follow various concepts indicating the COM status in the datarefs.
If you cannot get it working with your plane, you could used the "un-synced" default values.


Expand Down Expand Up @@ -51,7 +51,7 @@
## Summary

1. if you "sync" with your cockpit, you can use `TX1` or `TX2` as set in your COM unit
2. However, especially with **XPlane** vendors use all kinds of different concepts for the `datarefs`, so it can happen this does not work properly with some planes, you have to try.
2. However, especially with **X-Plane** vendors use all kinds of different concepts for the `datarefs`, so it can happen this does not work properly with some planes, you have to try.
3. without sync. you can manually change `TX1/RX1/TX1/RX2` , this is for scenarios where cockpit sync does not work for you
4. Currently we do not permit transmitting at 2 channels at once, this is precautionary.
So with a) you can select TX1 or TX2 (if the `datarefs` are correct)
13 changes: 8 additions & 5 deletions docs/documentation/flying/settings/select_simulator_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@
## Supported driver


- FS9 (experimental)
- XPlane
- FSX + P3D v1-3 legacy simConnect
- P3D v4 64bit (new P3D simConnect linkage)
- Emulated driver (for testing and observer tasks)
<!-- - FS9 (experimental) -->
- X-Plane (for X-Plane 11 and X-Plane 12)
- MSFS 2020
- MSFS 2024
<!--- FSX + P3D v1-3 legacy simConnect -->
- P3D v4 64bit (new P3D simConnect linkage)
- Flightgear
- Emulated driver (for testing and observer tasks)

## Simulator version

Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/flying/settings/xplane_driver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The driver settings can be found here: Settings --> Simulator --> then click on


In order to display the other aircraft on TCAS *swift* uses some technical tricks.
Those can affect the stability and the performance of XPlane.
Changing requires restarting XPlane.
Those can affect the stability and the performance of X-Plane.
Changing requires restarting X-Plane.

![](./../../../img/tcassettings.jpg){: style="width:50%"}
2 changes: 1 addition & 1 deletion docs/documentation/flying/settings/xswiftbus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ swift side:

![](./../../../img/tcassettings.jpg){: style="width:50%"}

## On the XPlane plugin side
## On the X-Plane plugin side

Modify `xswiftbus.conf` configuration file inside the `xswiftbus` plugin folder.
It should look like this:
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/flying/why_validation_errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ That can mean:

- you have moved your model directory and not updated your model set,
[solution](./../../troubleshooting/models/create_recreate_model_set.md)
- Is your XPlane model directory within the XPlane directory?
- For XPlane it might me that you made a mistake during the
- Is your X-Plane model directory within the X-Plane directory?
- For X-Plane it might me that you made a mistake during the
installation of the vertical offsets and ended up with cascaded
directories.
Fix the offsets, then [re-create your model set](./../../troubleshooting/models/create_recreate_model_set.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/swift_data/excluded_models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Some models are marked as x **excluded** (meaning in that context here, that the model shall not be used for matching).
Typical reasons for that are:

- XPlane `.acf` models (flyable aircraft) cannot be used for matching.
- X-Plane `.acf` models (flyable aircraft) cannot be used for matching.
- Some AI models for FSX/P3D do not show valid aircraft and are therefore excluded.
- Legal reasons might lead to excluded models.
- Some models exists, but are known to be buggy/malfunctional or consume too many resources
Expand Down
10 changes: 5 additions & 5 deletions docs/home/models/xplane/csl2xsb_converter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ In the *swift* **Configuration Wizard** you can convert incompatible models with

* close the model error message pop-up ``x``
* **select any aircraft** from the model list, click on your **right** mouse button (opens context menu)
* select the top option ``Simulator`` and from there ``XPlane: run CSL2XSB on all models``, a command prompt pop-up will open
* select the top option ``Simulator`` and from there ``X-Plane: run CSL2XSB on all models``, a command prompt pop-up will open

![](./../../../img/1stmodelset_selectcsl2xsb.jpg){: style="width:70%"}

Expand All @@ -36,7 +36,7 @@ In the *swift* **Configuration Wizard** you can convert incompatible models with

* it may take a while to process all models.
In the end, the script will ask you to press ``ENTER`` to close the command prompt pop-up
* on your model list pop-up window select ``force reload XPlane`` to **load all models again**, there should be no more error messages related to the unsupported format
* on your model list pop-up window select ``force reload X-Plane`` to **load all models again**, there should be no more error messages related to the unsupported format

![](./../../../img/1stmodelset_forcereload_xp.jpg){: style="width:30%"}

Expand All @@ -49,7 +49,7 @@ In the *swift* **Mapping Tool** you can convert incompatible models in the **Sto

* close the model error message pop-up ``x``
* **select any aircraft** from the model list, click on your **right** mouse button (opens context menu)
* select the top option ``Simulator`` and from there ``XPlane: run CSL2XSB on all models``, a command prompt pop-up will open
* select the top option ``Simulator`` and from there ``X-Plane: run CSL2XSB on all models``, a command prompt pop-up will open

![](./../../../img/mappingtool_csl2xsb.jpg){: style="width:70%"}

Expand All @@ -58,7 +58,7 @@ In the *swift* **Mapping Tool** you can convert incompatible models in the **Sto
![](./../../../img/csl2xsb_commandprompt.jpg){: style="width:80%"}

* it may take a while to process all models. In the end, the script will ask you to press ``ENTER`` to close the command prompt pop-up
* on your model list pop-up window select ``force reload XPlane`` to **load all models again**, there should be no more error messages related to the unsupported format
* on your model list pop-up window select ``force reload X-Plane`` to **load all models again**, there should be no more error messages related to the unsupported format

![](./../../../img/1stmodelset_forcereload_xp.jpg){: style="width:30%"}

Expand All @@ -82,6 +82,6 @@ As a consequence you will have to convert the models manually and we show you he
![](./../../../img/csl2xsb_commandprompt.jpg){: style="width:80%"}

- **Return to Configuration Wizard / Mapping Tool**: when CSL2XSB has done its job, depending on where you came from to convert X-CSL models, return to the *swift***Configuration Wizard** or to the **Mapping Tool**
- **Force Reload models**: on your model list pop-up window select ``force reload XPlane`` to **load all models again**, there should be no more error messages related to the unsupported format
- **Force Reload models**: on your model list pop-up window select ``force reload X-Plane`` to **load all models again**, there should be no more error messages related to the unsupported format

![](./../../../img/1stmodelset_forcereload_xp.jpg){: style="width:30%"}
3 changes: 2 additions & 1 deletion docs/home/system_requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@

*swift* supports the following simulators:

- Laminar Research X-Plane 11 (Vulkan/Metal/OpenGL) (latest stable version)
- Laminar Research X-Plane 12 (latest stable version)
- Microsoft Flight Simulator 2020
- Microsoft Flight Simulator 2024
- Laminar Research X-Plane 11 (Vulkan/Metal/OpenGL)
- Lockheed Martin Prepar3D versions 4 thru 5 (64 bit only)
- FlightGear

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@

# Welcome to the home of swift pilot client!

*swift* pilot client is a **multi-platform** (Windows, macOS, Linux) and **multi-flight simulator** (X-Plane 11, MSFS2020, MSFS2024, P3D (64-bit), FlightGear) application for virtual pilots who would like to connect to **[VATSIM](https://www.vatsim.net)** or **private FSD servers**.
*swift* pilot client is a **multi-platform** (Windows, macOS, Linux) and **multi-flight simulator** (X-Plane 11, X-Plane 12, MSFS2020, MSFS2024, P3D (64-bit), FlightGear) application for virtual pilots who would like to connect to **[VATSIM](https://www.vatsim.net)** or **private FSD servers**.

We are an independent (private/non-commercial) software project creating open source software for flight simulation.

## swift pilot client signature features

- **supports** Windows, macOS, Linux
- **compatible with** X-Plane 11 (Vulkan/Metal/OpenGL) - MSFS2020 - MSFS2024 - P3D (64-bit) - Flightgear - (FSX, FS9 and P3D (32-bit) are supported only with older versions of swift)
- **compatible with** X-Plane 11 (Vulkan/Metal/OpenGL) - X-Plane 12 - MSFS2020 - MSFS2024 - P3D (64-bit) - Flightgear - (FSX, FS9 and P3D (32-bit) are supported only with older versions of swift)
- integrated **AFV - Audio For VATSIM**
- **AFV voice-volume control** through hotkeys
- **tuning and switching** of COM-radios, transponder, SELCAL
Expand Down
6 changes: 3 additions & 3 deletions docs/troubleshooting/aircraft_not_rendered.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

- All aircraft are not rendered. Something is entirely wrong.
- Have you moved your models (folder)? If so, reload the models and re-create the model set.
- For XP11, are your models located in the XPlane folder?
- For XP11, are your models located in the X-Plane folder?
- did model validation pop-up?
Then *swift* already tells you your model set is broken.
You can run the validator in the mapping tool or the *swift* pilot client, see [model set validation](./../documentation/flying/model_set_validation.md).
Expand All @@ -40,10 +40,10 @@
- Have you models in your (model) set for which no liveries/installed models exist?
- See [model set validation](./../documentation/flying/model_set_validation.md).

## XPlane specific
## X-Plane specific

- Make sure **NO OTHER pilot client plugin is present**
- XPlane models in model set, but not rendered. Solution: **CSL files need to be inside the XPlane folder.**
- X-Plane models in model set, but not rendered. Solution: **CSL files need to be inside the X-Plane folder.**
Example of a working folder structure:

![](./../img/cslfiles.jpg){: style="width:70%"}
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/example_tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Upfront:
- aircraft too high or too low is caused by scenery offsets and/or missing/wrong vertical offsets (aka CG).
- typical causes may include
- missing CG/offset
- wrong XPlane elevation
- wrong X-Plane elevation
- missing FSX terrain probe, see [FSX probe](../home/install/fsx_p3d/install_terrain_probe.md)
- wrong gnd. flag from other party

Expand Down
4 changes: 2 additions & 2 deletions docs/troubleshooting/faq/xp_problems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
SPDX-License-Identifier: GFDL-1.3-only
-->

# Top 4 XPlane problems
# Top 4 X-Plane problems

There are 4 top problems using *swift* and XPlane
There are 4 top problems using *swift* and X-Plane

* no models are shown / no other aircraft, in most of the cases the aircraft folder is in the wrong place. see [here](./../aircraft_not_rendered.md) or you did not create a model set
* landing gear not visible or always visible: conflict with other pilot client, remove any other pilot client or AI traffic plugin you have installed, e.g. XSquawkBox, X-IvAp, PilotEdge, WorldTraffic.
Expand Down
20 changes: 10 additions & 10 deletions docs/troubleshooting/first_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,19 @@ In your *swift* installation directory you will see a directory `bearer`, just r
Some people have to remove the plugins from the folder, some do not.
- Maybe you consider a 3rd party tool like [XOrganizer](./faq/xp_landing_gear/deactivate_plugins_xorganizer.md)
- **Bluebell CSL models sunken in ground** (vertical offset fix) , see TODO
- XPlane models in model set, **but not rendered**.
**Solution**: CSL files need to be inside the `XPlane` folder.
Moving the XPlane models might require to reload your swift model cache, then recreating the model set.
- *swift* cannot connect to XPlane simulator side plugin:
- Check if the settings of the *swift* side and XPlane side do match, [xswiftbus settings](./../documentation/flying/settings/xswiftbus.md).
- X-Plane models in model set, **but not rendered**.
**Solution**: CSL files need to be inside the `X-Plane` folder.
Moving the X-Plane models might require to reload your swift model cache, then recreating the model set.
- *swift* cannot connect to X-Plane simulator side plugin:
- Check if the settings of the *swift* side and X-Plane side do match, [xswiftbus settings](./../documentation/flying/settings/xswiftbus.md).
- If the simulator LED is "on" the simulator can be connected:

![](./../img/swift_LED_bar.jpg){: style="width:70%"}

- XPlane not connecting with *swift* on macOS, see [this page](./xp_on_macos.md).
- X-Plane not connecting with *swift* on macOS, see [this page](./xp_on_macos.md).
- **HINT:** Some users did have problems with spaces in their model directory paths
- **Aircraft animation** as gear down **not working**:
- There are some known conflicts with other XPlane add-ons as those keep common multiplayer animation `datarefs` (being shared between all pilot clients) locked and the *swift* dataref registration fails.
- There are some known conflicts with other X-Plane add-ons as those keep common multiplayer animation `datarefs` (being shared between all pilot clients) locked and the *swift* dataref registration fails.
- In order to resolve the problem move the conflicting plugin out of your plugin folder and restart.
The conflict is known to cause trouble with gear animations and such.
- Problems with the following plugins have been reported: all other client plugins like XSB, x-ivap, fscloud, fs2play
Expand All @@ -99,7 +99,7 @@ In your *swift* installation directory you will see a directory `bearer`, just r

**3) OS specific**

**Some issues with Mac OS**
**Some issues with macOS**

- XPlane not connecting with *swift* on macOS, see [this page](./xp_on_macos.md).
- Not validated: Installation in `Application` failed, but in XPlane directory it works.
- X-Plane not connecting with *swift* on macOS, see [this page](./xp_on_macos.md).
- Not validated: Installation in `Application` failed, but in X-Plane directory it works.
8 changes: 4 additions & 4 deletions docs/troubleshooting/mapping_matching_model_set_theory_concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

## Own stored models

If you run your simulator (XPlane, P3D, ...) you will install aircraft models to display other pilots.
In XPlane those are the BlueBell or XCSL models, in P3D/FSX the FLAI or WoAI models for instance.
If you run your simulator (X-Plane, P3D, ...) you will install aircraft models to display other pilots.
In X-Plane those are the BlueBell or XCSL models, in P3D/FSX the FLAI or WoAI models for instance.

Those models we call **"stored own models"**, and they are located on your hard drive.
Such a directory structure may look like here (FSX/XPlane examples):
Such a directory structure may look like here (FSX/X-Plane examples):

![](./../img/dirstructure1.jpg){: style="width:70%"}

Expand Down Expand Up @@ -60,7 +60,7 @@ Why do we need such metadata (and not just use the data from the aircraft files)
This is at least true for P3D/FSX models
- not all attributes (e.g. colors) are covered,
- and we can not extend those metadata for future features
- different simulators (i.e. XPlane, P3D, ...) use different concepts, namings, etc., so we need to unify
- different simulators (i.e. X-Plane, P3D, ...) use different concepts, namings, etc., so we need to unify
- there is no existing concept to structure liveries
- and maintenace is a nightmare.
If an airline changes its name, ICAO code or such, we have to modify simulator files.
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/model_mapping/mapping_hints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
See [this page](./mapping_fs9_fsx_p3d_standard_models.md)
- What are excluded models?
See [this page](./../../documentation/swift_data/excluded_models.md)
- XPlane
- X-Plane
- Why are some models excluded (`CSL` vs `.acf` models)?
See [this page](./../../documentation/swift_data/excluded_models.md)
- Do we need mappings for `ACF` models?
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/models/create_recreate_model_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

This is up to you, but maybe some hints:

- For XPlane:
- For X-Plane:
- BlueBell is a good option
- You can mix BlueBell with XCSL, use it alone, use BlueBell alone etc.
- For VATSIM and FSX/P3D FLAI is a good choice
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/simulator_connection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@

![](./../img/Plugins.jpg){: style="width:70%"}

- **XPlane specific**: Verify the [xswiftbus settings](./../documentation/flying/settings/xswiftbus.md).
- **X-Plane specific**: Verify the [xswiftbus settings](./../documentation/flying/settings/xswiftbus.md).
2 changes: 1 addition & 1 deletion docs/troubleshooting/tracing_interpolation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
There are 3 possibilities to get interpolation information:

- in an extra window of swift (since 0.8.4): [interpolation page](./../documentation/swift_gui/interpolation_page.md)
- in the message window of XPlane/FSX/P3D.
- in the message window of X-Plane/FSX/P3D.
You can send the current interpolated situation as message to the sim, which is useful if you want so see it in the simulator together with the aircraft
- or saved into a log file in HTML format which can also be read by spreadsheet programs.
(HTML table will be created from that, which also be imported by Excel and similar spreadsheet programs)
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/xp_on_macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ For some people swift only works with session bus on macOS.

Reason: UNKNOWN, if you figure it out - let us know!

Reported for: Mac OS 10.15.4
Reported for: macOS 10.15.4

Here it is shown how to switch to session bus:

Expand Down
8 changes: 4 additions & 4 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ nav:
- macOS: home/install/install_mac.md
- Linux: home/install/install_linux.md
- Configuration:
- X-Plane 11: home/install/configure_xp.md
- X-Plane 11 & X-Plane 12: home/install/configure_xp.md
- MSFS - FS2020: home/install/configure_msfs.md
- FSX & P3D v1-v3:
- home/install/fsx_p3d/index.md
Expand All @@ -32,7 +32,7 @@ nav:
- home/install/fs9/index.md
- FS9 elevation (FS9 aircraft too high/low): home/install/fs9/fs9_ground_elevation.md
- CSL models & AI aircraft:
- X-Plane 11:
- X-Plane 11 & X-Plane 12:
- home/models/xplane/index.md
- Bluebell: home/models/xplane/bluebell.md
- X-CSL: home/models/xplane/xcsl.md
Expand Down Expand Up @@ -142,7 +142,7 @@ nav:
- SimConnect SB4 offsets settings (P3D/FSX XPDR synchronization): documentation/flying/settings/simconnect_sb4_offsets.md
- Simulator messages (messages relayed to simulator): documentation/flying/settings/simulator_messages.md
- Weather settings: documentation/flying/settings/weather.md
- XPlane driver settings: documentation/flying/settings/xplane_driver.md
- X-Plane driver settings: documentation/flying/settings/xplane_driver.md
- xswiftbus settings: documentation/flying/settings/xswiftbus.md
- Hotkeys such as PTT (push to talk), Joystick hotkey not working: documentation/flying/hotkey_not_working.md
- Instant mapping (create a mapping before you fly - Quick mapping wizard): documentation/flying/instant_mapping.md
Expand All @@ -153,7 +153,7 @@ nav:
- swift user data: documentation/flying/swift_user_data.md
- Troubleshooting:
- troubleshooting/index.md
- swift does not connect with XPlane on macOS: troubleshooting/xp_on_macos.md
- swift does not connect with X-Plane on macOS: troubleshooting/xp_on_macos.md
- Troubleshoot installation and 1st start: troubleshooting/first_install.md
- Troubleshoot voice: troubleshooting/voice.md
- Linux Hotkeys are not detected: troubleshooting/linux_hotkeys.md
Expand Down