Page MenuHomeswift

swift installation and configuration guide
Updated 9 Days AgoPublic

This section will guide you through the process to download, install and setup swift for the first time.

System Requirements

First check the System Requirements whether it matches your machine.

Download the installer

There are multiple release channels and you can select the one that fits most your needs.

Release ChannelDescriptionChangelogDownload Link
AlphaThis is the bleeding edge development content. Use at your own risk. statusDownload alpha versions from datastore
BetaMore stable than alpha and mainly for testing of new features. Not recommended for production use.N/ANot yet available
StableStable and tested content. Recommended for production use.N/ANot yet available

Run the installer

IMPORTANT: Close all running swift applications before starting the installation

The installer is pretty self-explanatory. It allows you to select the installation path, required and optional components and will allow you to launch swift initial configuration afterwards.
It is generally recommended to install swift into a versioned folder. This allows keeping several versions in parallel (one for testing, one for production for example). All installed and downloaded files are directory based and isolated for each version.

Find below the platform specific notes to run the installer

Windows
After downloading, double-click on the downloaded installer to start the installation.
You might see a warning (you need to ignore) when you start the installer. We have no official MS certification.

Mac OS
After downloading, mount the disk image and double-click on the contained installer to start the installation.

Linux
After downloading, modify the installer to be executable
chmod +x swiftinstaller-linux-64-<version>.run
and double-click on it in your favorite file browser or run it from console
./swiftinstaller-linux-64-<version>.run

Problems? Then see Troubleshooting installation and 1st start

Initial Configuration

After the installation completed, swiftlauncher will launch together with the initial configuration wizard. If you un-selected to launch swift from the installer, it is possible to run the same init mode any time later by using the command line arguments

swiftlauncher -i --bootstrapurl https://datastore.swift-project.org/shared/

The rest of the section will guide you through the different wizards.

Legal Wizard

The first wizard page deals with the necessary legal bits. It will explain in detail all the licenses involved in the swift project including 3rd party software. It also provides links to data protection policies. It is necessary to accept license and data protection policy to proceed.
This page also asks for your agreement to submit crash reports to our crash report collection server. In case any swift application crashed, a crash report will be generated with information which line of code caused it to abort. With your agreement, the report will be uploaded to our server and helps the developers to diagnose and fix the cause. This agreement can be changed anytime later in the advanced settings (link tbd).
Read more about crash reports (link tbd) and how they look like.

Data Loading Wizard

The next wizard will download all data, required by swift to be fully functional. This includes aircraft and airline ICAO data, model strings (no models itself), etc.
It is not necessary to click any of the load buttons. The download will start automatically from randomly one of the shared mirror servers in the background. The button can be used to reload in case there was an update meanwhile.
You can either wait for the download to finish (several seconds depending on your internet bandwidth) or continue, since it will continue in the background. The wizard indicates that all data finished loading by

  • The two DB LEDs flashing yellow
  • All other LEDs off (idle mode).
  • The number of entries and the timestamp of the local cache are equal to the shared cache.

Copy Models Wizard

NOTE: If you installed swift the very first time on this machine, then you can skip this part.

If you had a previous version of swift installed already, then this wizard will help you to migrate your existing model cache and model set.

  • Select the older version you want to migrate from the list.
  • Select whether you want to migrate the model set and/or model cache and for which simulators.
  • Click Start.

Read more about the meaning of model set (link tbd) and model cache (link tbd).

Copy Settings Wizard

NOTE: If you installed swift the very first time on this machine, then you can skip this part.

If you had a previous version of swift installed already, then this wizard will help you to migrate your settings.

  • Select the older version you want to migrate from the list.
  • Select which settings needs migrating
    • Grey X means that no user setting is available and the default is in use.
  • Click copy

Read more about settings (link tbd).

Simulator Wizard

This page allows you to configure which simulators you want swift to work with. If you have multiple simulators installed and use them regularly, select all of those in the first group box. swift will detect if any of those configured simulators is running and connect to it. It will ignore the ones that have not been selected.

In the group box below, you are able to configure the simulator path and any additional model directories. swift will try to detect as much as possible automatically and use it as default. The default is listed in light grey.
In order to configure the directories, first select the respective simulator from the radio boxes at the bottom

  • Use the ... button to select/add more directories
  • Use the adjust button to remove redundant directories, fix file path etc.
  • Click Save

IMPORTANT: If you are using P3D and you are using models outside the SimObjects folder you can add multiple other directories here.

First Model Set Wizard

This wizard will help you to create a first model set for each of your simulators in use. A model set is a subset of the AI models installed on your machine, which are considered for model mapping and model matching. Without any model set, swift will not run properly.

  • Select your simulator (repeat the steps below if you are using multiple simulators).
  • Check the model directory and change it if necessary.
  • Reload the installed AI models if necessary. This is necessary in case the number of models does not look correct to you or if you made any changes to model directories in this or the previous wizard.
  • Optionally display and inspect the model list

  • Click on Create to create a model set.
  • Save the model set.
  • Close the dialog

Install XSwiftBus

NOTE: If you are not using X-Plane, skip this part.

swift - in contrast to other X-Plane clients - is running outside of the X-Plane process. In order to communicate with the X-Plane process and render AI aircraft, a small plugin called XSwiftBus is necessary. It needs to be installed into X-Plane/Resources/plugins. This wizard will download and install it for you.

  • Confirm the install directory is correct or change it as necessary.
  • Check and correct the temporary download folder.
  • Choose a version to install (it is strongly recommended to use the same version as swift itself).
  • Click on download.
  • Answer Ok in the dialog to extract and install the package directly into X-Plane.
  • In case 7z is not available on your machine (Mac OS users!), you will receive an error message and will have to extract it yourself.
  • It is recommended to keep the default for the connection settings.

Read more about Installing and updating XSwiftBus

Install FSX/P3D terrain probe

NOTE: If you are not using FSX/P3D, skip this part.

We use a terrain probe object to query simulator data around the AI aircraft. We recommend you install that probe when you are using the 32bit driver versions for FSX/P3D.

Further details can be found here: Installation of the FSX/P3D terrain probe

Configure Hotkeys Wizard

The last wizard allows you to configure hotkeys. Use this to configure your PTT key.

Run swift

Your swift suite is now configured and ready to go. Use the launcher to launch the different swift applications in different flavors and modes. For first time users, it is recommended to start swift in standalone mode.

  • In the core tab, select Core Mode Standalone
  • Click on the blue swift icon named GUI to start swift in standalone mode.

Congratulations, swift is now running on your machine and you are ready to setup everything else for your first connection to the network.

Something didn't work? Check our Troubleshooting page or ask for help in the usual channels.


Advanced Topics

Installing a new version

IMPORTANT: swift is just a directory install, you can simply delete the directory to uninstall if you like.
  • You can just install a new version overriding the old. Some people have reported problems with that, in such a case just delete or uninstall swift.
  • We recommend you to keep updates of your model set, as creating a model set is the most time consuming job
  • swift knows settings and caches (data files, e.g. for downloaded data). You can copy those from other swift versions after installation. See Copy swift data from other versions

swift directory concept

  • You can install as many swift versions in parallel as you like. swift is a directory based installation, no registry entries or such.
  • Each installation has its own settings and cache files (and hence is isolated).
  • From the wizard you can copy settings / caches from one swift version to another swift version (if you like)
  • You can always open your directories from the main menu
    • Windows: normally C:\Users\<username>\AppData\Local\org.swift-project
    • Menu
Last Author
kbasan
Last Edited
Fri, Oct 12, 4:41 PM

Event Timeline

kbasan created this document.Apr 11 2017, 8:32 PM
kbasan edited the content of this document. (Show Details)
kbasan added a project: Restricted Project.
kbasan edited the content of this document. (Show Details)Apr 11 2017, 8:35 PM
kbasan edited the content of this document. (Show Details)
kbasan edited the content of this document. (Show Details)Apr 11 2017, 8:50 PM
kbasan edited the content of this document. (Show Details)Apr 11 2017, 11:52 PM
kbasan edited the content of this document. (Show Details)
kbasan edited the content of this document. (Show Details)Apr 12 2017, 2:16 PM
rrossgotterer edited the content of this document. (Show Details)Apr 27 2017, 1:43 PM
kbasan edited the content of this document. (Show Details)May 6 2017, 3:17 PM
kbasan edited the content of this document. (Show Details)May 6 2017, 3:27 PM
kbasan edited the content of this document. (Show Details)
kbasan edited the content of this document. (Show Details)May 7 2017, 12:33 PM
kbasan edited the content of this document. (Show Details)May 7 2017, 1:18 PM
kbasan edited the content of this document. (Show Details)May 7 2017, 1:23 PM
kbasan edited the content of this document. (Show Details)May 7 2017, 1:31 PM
kbasan edited the content of this document. (Show Details)May 7 2017, 1:42 PM
kbasan edited the content of this document. (Show Details)May 7 2017, 1:46 PM
kbasan edited the content of this document. (Show Details)May 7 2017, 6:43 PM
kbasan edited the content of this document. (Show Details)May 7 2017, 6:52 PM
kbasan edited the content of this document. (Show Details)May 9 2017, 8:03 PM
kbasan edited the content of this document. (Show Details)Aug 14 2017, 10:02 AM
kbasan edited the content of this document. (Show Details)Aug 14 2017, 9:25 PM
kbasan edited the content of this document. (Show Details)Aug 16 2017, 2:03 PM
kbasan changed the title from swift installation to swift download and installation.Jan 16 2018, 10:33 PM
kbasan edited the content of this document. (Show Details)Jan 24 2018, 5:12 PM
kbasan edited the content of this document. (Show Details)
kbasan edited the content of this document. (Show Details)
kbasan edited the content of this document. (Show Details)Feb 5 2018, 8:47 AM
kbasan edited the content of this document. (Show Details)May 23 2018, 9:38 PM
kbasan edited the content of this document. (Show Details)
kbasan edited the content of this document. (Show Details)May 23 2018, 9:47 PM
kbasan edited the content of this document. (Show Details)
kbasan edited the content of this document. (Show Details)Jun 2 2018, 2:33 PM
rrossgotterer edited the content of this document. (Show Details)Aug 28 2018, 2:59 PM
rrossgotterer edited the content of this document. (Show Details)Aug 28 2018, 3:09 PM
rrossgotterer changed the title from swift download and installation to swift Installation Guide.Aug 29 2018, 6:57 AM
rrossgotterer edited the content of this document. (Show Details)
rrossgotterer edited the content of this document. (Show Details)Aug 29 2018, 7:14 AM
rrossgotterer edited the content of this document. (Show Details)Aug 29 2018, 7:23 AM
rrossgotterer edited the content of this document. (Show Details)Aug 29 2018, 7:31 AM
rrossgotterer edited the content of this document. (Show Details)Aug 29 2018, 7:50 AM
rrossgotterer edited the content of this document. (Show Details)Aug 29 2018, 8:18 AM
rrossgotterer edited the content of this document. (Show Details)
rrossgotterer edited the content of this document. (Show Details)Aug 29 2018, 8:26 AM
rrossgotterer edited the content of this document. (Show Details)Aug 29 2018, 8:39 AM
kbasan edited the content of this document. (Show Details)Aug 29 2018, 11:53 PM
kbasan changed the title from swift Installation Guide to swift installation and configuration guide.Aug 30 2018, 11:02 PM
kbasan edited the content of this document. (Show Details)Sep 17 2018, 2:10 PM
kbasan edited the content of this document. (Show Details)Sep 17 2018, 2:16 PM
kbasan edited the content of this document. (Show Details)Fri, Oct 12, 4:40 PM
kbasan edited the content of this document. (Show Details)