Skip to content
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.

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

Unify spelling of xswiftbus #2

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/distributed.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ As you can see in *swift*Launcher, you have 2 options:
* **model matching** is done in ***swift*Core**, therefore your **CSL/AI model sets** must be installed **on the computer that is running swiftCore**
* the GUI-part of *swift*GUI does **not** require a model set, it will use the one from *swift*Core on the remote computer
* *swift*Core is responsible for communicating with online flying services like VATSIM and other FSD-servers. This computer has to have **access to the internet**, otherwise it cannot connect to them
* *swift*Core connects to your flight simulator platform through SimConnect, //XSwiftBus// or FSUIPC
* *swift*Core and *swift*GUI exchange information with each other on the **port** set in your **DBus settings** (don't confuse this connection with the //XSwiftBus// connection)
* *swift*Core connects to your flight simulator platform through SimConnect, //xswiftbus// or FSUIPC
* *swift*Core and *swift*GUI exchange information with each other on the **port** set in your **DBus settings** (don't confuse this connection with the //xswiftbus// connection)
![](./../img/manual_distributedmode_dbusport.jpg){: style="width:50%"}
* **AFV/Audio For VATSIM** can run either through *swift*Core **or** *swift*GUI and requires **UDP port 50000** to be enabled

Expand Down
6 changes: 3 additions & 3 deletions docs/documentation/flying/settings/xswiftbus.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
see als [X-Plane driver settings](./xplane_driver.md)


When changing the connection details between *swift* and *XSwiftBus*,
When changing the connection details between *swift* and *xswiftbus*,
the modification needs to be applied in sync on both sides. Otherwise
connection issues can occur.

Expand All @@ -19,7 +19,7 @@ swift side:

## On the XPlane plugin side

Modify `xswiftbus.conf` configuration file inside the `XSwiftBus` plugin folder.
Modify `xswiftbus.conf` configuration file inside the `xswiftbus` plugin folder.
It should look like this:

```conf
Expand All @@ -34,4 +34,4 @@ dbusPort = 45001
```

Make sure to apply the same settings as on *swift* side.
**Any modification of this file will require a restart of XSwiftBus** (either by a restart of X-Plane or disabling/enabling *XSwiftBus* from the Plugin Manager).
**Any modification of this file will require a restart of xswiftbus** (either by a restart of X-Plane or disabling/enabling *xswiftbus* from the Plugin Manager).
2 changes: 1 addition & 1 deletion docs/documentation/swift_gui/settings_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ The lower section offers some general setting options

Furthermore, you can also modify settings that are specific to each flight simulator platform used.
Depending on the product, there more or less options available.
To access them you need to click on the ``[...]``-icon in the same line as the simulator plugin, in this example XSwiftBus for X-Plane 11:
To access them you need to click on the ``[...]``-icon in the same line as the simulator plugin, in this example xswiftbus for X-Plane 11:

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

Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/swift_launcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
SPDX-License-Identifier: GFDL-1.3-only
-->

*swift*Launcher can be used to access all components of *swift*, to update the client, *XSwiftBus* and the database and to change the operational mode of the pilot client.
*swift*Launcher can be used to access all components of *swift*, to update the client, *xswiftbus* and the database and to change the operational mode of the pilot client.

![](./../img/manual_swiftlauncher_overview.jpg)

Expand Down
4 changes: 2 additions & 2 deletions docs/home/checklist_first_flight.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ X-Plane has seen significant internal changes, as a consequence you have to use
Until including **X-Plane 11.41** you have to use *swift* **version 0.9.4.389**. From **X-Plane 11.50** download and install *swift* **0.9.5.x or newer**.

* use the **64bit version** of *swift*
* make sure **XSwiftBus** is installed and that its **version number is identical** with the one of *swift*GUI
* traffic plugins and other pilot clients for X-Plane will interfere with *XSwiftBus* and need to be properly deactivated or removed from the plugins folder.
* make sure **xswiftbus** is installed and that its **version number is identical** with the one of *swift*GUI
* traffic plugins and other pilot clients for X-Plane will interfere with *xswiftbus* and need to be properly deactivated or removed from the plugins folder.
[More info](./../troubleshooting/faq/xp_landing_gear/index.md)
* CSL models must be installed inside the folder of X-Plane, it is advisable to avoid spaces and special characters in the file paths.
[More information and recommendations](./models/xplane/index.md#recommended-installation-practices)
Expand Down
18 changes: 9 additions & 9 deletions docs/home/install/configure_xp.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
!!! note

This chapter is for users who have installed *swift* **for the very first time** or who are making a clean installation and do not have previous configurations to copy their settings from.
If you are an existing user and if you have copied all settings during installation of *swift* pilot client, then the only thing that you need to do in the Configuration Wizard is **[update XSwiftBus](./configure_xp.md#xswiftbus-wizard)**!
If you are an existing user and if you have copied all settings during installation of *swift* pilot client, then the only thing that you need to do in the Configuration Wizard is **[update xswiftbus](./configure_xp.md#xswiftbus-wizard)**!
All other settings can be managed through *swift*GUI.


Expand Down Expand Up @@ -168,34 +168,34 @@ Now it's time to actually search for existing models, list them as your **Stored

Believe it or not, but you just created your first model set for *swift*, well done!

## XSwiftBus Wizard
## xswiftbus Wizard

!!! warning

The **XSwiftBus plugin** is required for **X-Plane** **only**.
The **xswiftbus plugin** is required for **X-Plane** **only**.

XSwiftBus Wizard will download and install XSwiftBus for you.
xswiftbus Wizard will download and install xswiftbus for you.

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

*swiftGUI* is not a plugin for X-Plane and in order to exchange data with X-Plane and to render CSL models, a plugin called XSwiftBus is necessary.
*swiftGUI* is not a plugin for X-Plane and in order to exchange data with X-Plane and to render CSL models, a plugin called xswiftbus is necessary.
It has to be installed into your **X-Plane plugins-folder** (found at ``YourDrive:\X-Plane 11\Resources\plugins``).

*swift* will be using the X-Plane program directory that you had confirmed on the ([Simulator Wizard page](./configure_xp.md#simulator-wizard)).

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

* **Install directory:** check the correct plugins-directory of X-Plane is shown
* **Download directory:** check the folder where XSwiftBus will be downloaded to.
* **Download directory:** check the folder where xswiftbus will be downloaded to.
If you are happy with it, leave it, or change it to your preference
* **Version:** choose the **correct version** of XSwiftBus: it **has to** be the **same version number** as *swift* pilot client that you are configuring now!
For example, if you are installing *swift* 0.9.5.128, then XSwiftBus has to have the same version number 0.9.5.128
* **Version:** choose the **correct version** of xswiftbus: it **has to** be the **same version number** as *swift* pilot client that you are configuring now!
For example, if you are installing *swift* 0.9.5.128, then xswiftbus has to have the same version number 0.9.5.128
* after selecting the correct version, select ``download`` and follow the instructions to install the plugin

!!! note

in case that you do **not** have **[7zip (freeware)](https://www.7-zip.org/)** or if it isn't available for your OS at all (e.g. MacOS), *swift* will produce an error message.
You will then have to **install XSwiftBus manually** by extracting the archive to ``X-Plane 11\Resources\plugins\`` (overwriting existing xswiftbus files there).
You will then have to **install xswiftbus manually** by extracting the archive to ``X-Plane 11\Resources\plugins\`` (overwriting existing xswiftbus files there).

## Hotkey Wizard

Expand Down
2 changes: 1 addition & 1 deletion docs/home/install/install_linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Should it find one, the installer will offer you to copy those *swift*-settings
![](./../../img/swift_installation_previousconfiguration.jpg){: style="width:70%"}

> Select "Yes" to copy your settings, as this will save you from configuring *swift* again.
If you are just updating *swift* and you are using **X-Plane**, then you will have to **[update XSwiftBus](./configure_xp.md#xswiftbus-wizard)** (run the **Config Wizard**).
If you are just updating *swift* and you are using **X-Plane**, then you will have to **[update xswiftbus](./configure_xp.md#xswiftbus-wizard)** (run the **Config Wizard**).


However, if you did **not** get this message, you will have to configure *swift* before you can use it.
Expand Down
2 changes: 1 addition & 1 deletion docs/home/install/install_mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Should it find one, the installer will offer you to copy those *swift*-settings
![](./../../img/swift_installation_previousconfiguration.jpg){: style="width:70%"}

> Select "Yes" to copy your settings, as this will save you from configuring *swift* again.
If you are just updating *swift* and you are using **X-Plane**, then you will have to **[update XSwiftBus](./configure_xp.md#xswiftbus-wizard)** (run the **Config Wizard**).
If you are just updating *swift* and you are using **X-Plane**, then you will have to **[update xswiftbus](./configure_xp.md#xswiftbus-wizard)** (run the **Config Wizard**).

However, if you did **not** get this message, you will have to configure *swift* before you can use it.

Expand Down
2 changes: 1 addition & 1 deletion docs/home/install/install_windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Should it find one, the installer will offer you to copy those *swift*-settings
![](./../../img/swift_installation_previousconfiguration.jpg){: style="width:60%"}

> Select "Yes" to copy your settings, as this will save you from configuring *swift* again.
If you are just updating *swift* and you are using **X-Plane**, then you will have to **[update XSwiftBus](./configure_xp.md#xswiftbus-wizard)** (run the **Config Wizard**).
If you are just updating *swift* and you are using **X-Plane**, then you will have to **[update xswiftbus](./configure_xp.md#xswiftbus-wizard)** (run the **Config Wizard**).

However, if you did **not** get this message, you will have to configure *swift* before you can use it.

Expand Down
22 changes: 11 additions & 11 deletions docs/home/updating/update_current_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,33 +36,33 @@ The **download and installation process** for *swift*GUI *swift*Launcher **is id

If you do **NOT** use **X-Plane**, then you are done here and you can go flying!

## Updating of XSwiftBus
## Updating of xswiftbus

* *Users of X-Plane** have to **update XSwiftBus**!
* in *swift***Launcher** locate the *XSwiftBus*-section and make sure to select **exactly the same version number** as the client that you just installed.
Select ``download`` to open the download dialogue (don't allow the message **Nothing new** distract you from the fact that XSwiftBus requires updating: this message is referring to the *swift* application only)
* *Users of X-Plane** have to **update xswiftbus**!
* in *swift***Launcher** locate the *xswiftbus*-section and make sure to select **exactly the same version number** as the client that you just installed.
Select ``download`` to open the download dialogue (don't allow the message **Nothing new** distract you from the fact that xswiftbus requires updating: this message is referring to the *swift* application only)

![](./../../img/updatexswiftbus_newversion.jpg){: style="width:50%"}
* in the *XSwiftBus* dialogue you have one more chance to verify the version of the plugin.
* in the *xswiftbus* dialogue you have one more chance to verify the version of the plugin.
Click on ``download`` to actually start the download

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

* with the download finished, select ``OK`` to install *XSwiftBus*
* with the download finished, select ``OK`` to install *xswiftbus*

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

!!! note

In case that you do **not** have **[7zip (freeware)](https://www.7-zip.org/)** or if it isn't available for your OS at all (e.g. MacOS), *swift* will produce an error message.
You will then have to **install *XSwiftBus* manually** by extracting the archive to ``X-Plane 11\Resources\plugins\`` (overwriting existing *XSwiftBus* files there)
You will then have to **install *xswiftbus* manually** by extracting the archive to ``X-Plane 11\Resources\plugins\`` (overwriting existing *xswiftbus* files there)

* when done, you can either keep the archive or delete it.
Select ``**OK**`` to delete the file or ``Cancel`` to keep it

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

**You have completed updating *swift* and *XSwiftBus*, you can go flying!**
**You have completed updating *swift* and *xswiftbus*, you can go flying!**


## Updating Manually
Expand All @@ -79,10 +79,10 @@ If you do **NOT** use **X-Plane**, then you are done here and you can go flying!
![](./../../img/swift_installation_previousconfiguration.jpg){: style="width:50%"}

* if you do **not** use **X-Plane**, then you are done here and you can go flying!
* **users of X-Plane** have to **update XSwiftBus** as well!
* **users of X-Plane** have to **update xswiftbus** as well!
* either **start** *swift***Launcher** and proceed as described in the previous paragraph of this page
* or **download and install** *XSwiftBus* **manually**: from our [download page](./../install/download.md) get *XSwiftBus* with **exactly the same version number** as the client that you just installed.
* or **download and install** *xswiftbus* **manually**: from our [download page](./../install/download.md) get *xswiftbus* with **exactly the same version number** as the client that you just installed.
**Extract** the archive to ``\X-Plane 11\Resources\Plugins\`` and **overwrite old files**


* **You are now done updating *swift* and *XSwiftBus*, you can go flying!**
* **You are now done updating *swift* and *xswiftbus*, you can go flying!**
20 changes: 10 additions & 10 deletions docs/home/updating/upgrade_new_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,43 +78,43 @@ The **download and installation process** for *swift*GUI *swift*Launcher **is id

If you do **NOT** use **X-Plane**, then you are done here and you can go flying!

## Updating of XSwiftBus
**Users of X-Plane** have to **update XSwiftBus**!
## Updating of xswiftbus
**Users of X-Plane** have to **update xswiftbus**!

* in *swift* Configuration Wizard continue to the *XSwiftBus* download page and make sure to select **exactly the same version number** as the client that you just installed.
* in *swift* Configuration Wizard continue to the *xswiftbus* download page and make sure to select **exactly the same version number** as the client that you just installed.
Select ``download`` to open the download dialogue

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

* in the *XSwiftBus* dialogue you have one more chance to verify the version of the plugin.
* in the *xswiftbus* dialogue you have one more chance to verify the version of the plugin.
Click on ``download`` to actually start the download

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

* with the download finished, select ``OK`` to install *XSwiftBus*
* with the download finished, select ``OK`` to install *xswiftbus*

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

!!! note

In case that you do **not** have **[7zip (freeware)](https://www.7-zip.org/)** or if it isn't available for your OS at all (e.g. MacOS), *swift* will produce an error message.
You will then have to **install *XSwiftBus* manually** by extracting the archive to ``X-Plane 11\Resources\plugins\`` (overwriting existing *XSwiftBus* files there)
You will then have to **install *xswiftbus* manually** by extracting the archive to ``X-Plane 11\Resources\plugins\`` (overwriting existing *xswiftbus* files there)

* when done, you can either keep the archive or delete it.
Select ``OK`` to delete the file or ``Cancel`` to keep it

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

**You are now done updating *swift* and *XSwiftBus*, you can go flying!**
**You are now done updating *swift* and *xswiftbus*, you can go flying!**

## Updating Manually

* **download** the latest version of *swift* from our website: [download page](./../install/download.md)
* **run** the installer according to your operating system
* at the end of the installation process *swift*Launcher and the **Configuration Wizard** will start automatically.
**Proceed according to the instructions earlier on this page** to copy your Model set, Model cache and general *swift* settings
* **users of X-Plane** have to **update XSwiftBus** as well!
* either use the Config Wizward and proceed as described in the previous paragraph of this page or **download and install** *XSwiftBus* **manually**: from our [download page](./../install/download.md) get *XSwiftBus* with **exactly the same version number** as the client that you just installed.
* **users of X-Plane** have to **update xswiftbus** as well!
* either use the Config Wizward and proceed as described in the previous paragraph of this page or **download and install** *xswiftbus* **manually**: from our [download page](./../install/download.md) get *xswiftbus* with **exactly the same version number** as the client that you just installed.
**Extract** the archive to ``\X-Plane 11\Resources\Plugins\`` and **overwrite old files**

* **You are now done updating *swift* and *XSwiftBus*, you can go flying!**
* **You are now done updating *swift* and *xswiftbus*, you can go flying!**
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The default plugin manager of X-Plane does not prevent this from happening, it i

If you use several plugins for CSL model injection, xOrganizer may be a comfortable solution to switch between them.

XSwiftBus ON, X-IvAp OFF | XSwiftBus OFF, X-IvAp ON |
xswiftbus ON, X-IvAp OFF | xswiftbus OFF, X-IvAp ON |
|-|-|
| ![](./../../../img/xorganizer_swift_enabled.jpg) | ![](./../../../img/xorganizer_xivap_enabled.jpg) |

Expand Down
6 changes: 3 additions & 3 deletions docs/troubleshooting/faq/xp_landing_gear/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ SPDX-License-Identifier: GFDL-1.3-only

## Solution 1

**Another plugin is conflicting with XSwiftBus**
**Another plugin is conflicting with xswiftbus**

One of the functions of *XSwiftBus* is to inject CSL model data into X-Plane to render (display) the aircraft of other pilots near you, including model animation.
One of the functions of *xswiftbus* is to inject CSL model data into X-Plane to render (display) the aircraft of other pilots near you, including model animation.
If another plugin with similar functions is **active at the same time**, it will interfere with the rendering process of those CSL models their animations will be broken or you won't be seeing any models at all.

Check the plugins-directory of X-Plane for other plugins that are related to injecting CSL model data.
Plugins for X-Plane 11 are saved in ``\X-Plane 11\Resources\Plugins\``.

The following plugins are known to interfere with XSwiftBus:
The following plugins are known to interfere with xswiftbus:

* **XSquawkbox**
* **xPilot**
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/first_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ In your *swift* installation directory you will see a directory `bearer`, just r
**X-Plane specific**

- Warn of XSquawkBox/xPilot conflict
- *XSwiftBus* doesn\'t work properly if xsquawkbox or x-ivap is also installed since only one can have control of X-Plane multiplayer aircraft.
- *xswiftbus* doesn\'t work properly if xsquawkbox or x-ivap is also installed since only one can have control of X-Plane multiplayer aircraft.
*swift* will raise a warning in case another plugin is controlling the multiplayer aircraft.
- Remove or disable the conflicting plugin and restart X-Plane.
Plugins are still loaded even if they are disabled.
Expand Down
Loading