Skip to content

Documentation update for upcoming release 0.15 #12

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

Merged
merged 12 commits into from
Dec 10, 2024
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 .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ jobs:
build:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ jobs:
build:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
- name: Install dependencies
run: pip install -r requirements.txt
- name: Run REUSE lint
run: reuse lint
- uses: actions/configure-pages@v3
- uses: actions/configure-pages@v5
- name: Build
run: mkdocs build --strict
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
uses: actions/upload-pages-artifact@v3
with:
path: "site/"

Expand All @@ -41,4 +41,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
6 changes: 0 additions & 6 deletions docs/documentation/distributed.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,9 @@ As an alternative to running *swift*Core on the computer that houses your flight
In order to create a model set in such a scenario, you will need remote access (shared drive etc.) to your CSL/AI model directory.

### FSX/P3D
*swift* can use SimConnect in remote configuration: See [here](./flying/remote_simconnect.md).
This allows for connecting a remote FSX/P3D from a standalone *swift*GUI.

There are two ways to setup a distributed scenario

* **Distributed** *swift*GUI on computer 1, *swift*Core on computer 2 (with your flight simulator).
*swift*Core will be using a local SimConnect connection.
* **Standalone** *swift*GUI on computer 1, connected via "remote SimConnect" to computer 2.
**No separate *swift*Core will be needed**!

### FS9
You can use **WideFS** for a remote connection and run *swift*GUI in **standalone mode**.
Expand Down
7 changes: 0 additions & 7 deletions docs/documentation/flying/fsuipc.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs/documentation/flying/integrated_com.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
SPDX-License-Identifier: GFDL-1.3-only
-->

!!! warning

COM synchronization does not work with FS9.


- You can enable COM unit synchronization (between simulator and
*swift*) from the simulator settings

Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/flying/model_set_validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ There you can temp. disable such models.
![](./../../img/Validation_dialog.jpg){: style="width:75%"}


After you have disabled models you wold see them "in red" in the model view (might be you have to press "load set" to refresh the view).
After you have disabled models, you will see them "in red" in the model view (might be you have to press "load set" to refresh the view).

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

Expand Down
17 changes: 0 additions & 17 deletions docs/documentation/flying/p3d_64_or_32.md

This file was deleted.

40 changes: 0 additions & 40 deletions docs/documentation/flying/remote_simconnect.md

This file was deleted.

31 changes: 8 additions & 23 deletions docs/documentation/swift_gui/flightplan_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,20 @@
The Flightplan page allows you to send flightplans to the network you are connected to.
Flightplans can be filled in manually, loaded from files and from the **[SimBrief Dispatch System](https://www.simbrief.com/)**.

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


## Flightplan Data Fields
- **Type**: flight rules used. Currently *swift* supports:
* VFR - Visual Flight Rules
* IFR - Instrument Flight Rules
* SVFR (Special VFR)
* [DVFR](https://en.wikipedia.org/wiki/DVFR)
* VFR - Visual Flight Rules
* IFR - Instrument Flight Rules
* SVFR (Special VFR)
* [DVFR](https://en.wikipedia.org/wiki/DVFR)
- **Callsign**: this field gets filled in automatically from what you have set as callsign on the **[Connect Page](./connect/index.md)**.
Should the callsign shown on the flightplan not correspond to the one on the Connect Page, click on the blue circle icon to reload and override it.
- **Aircraft & Equipment**: this field gets filled in automatically from what you have set as callsign on the **[Connect Page](./connect/index.md)**.
You can change it manually any time.
* type code: needs to be a valid 4 letter aircraft type ICAO-code, check *swift*GUI's [Connect Page](./connect/index.md) for details
* Heavy: if the MTOM (Maximum Takeoff Mass) of your aircraft is equal or greater than 300,000 lbs or 136 tons, set a check mark
* TCAS: not really used any more
* Equipment Code: VATSIM is currently transitioning from **[FAA codes](https://en.wikipedia.org/wiki/Equipment_codes#List_of_FAA_Aircraft_Equipment_Codes_For_US_Domestic_Flights[3])** to **[ICAO codes](https://en.wikipedia.org/wiki/Equipment_codes#List_of_ICAO_Codes_(As_of_15_November_2012)[2])** in this respect.
*swift*'s flightplan form still uses and transmits FAA codes to the VATSIM flightplan interface.
If you are not sure what to do here, click on the **question mark icon** ![](./../../img/manual_swiftgui_flightplan_equipmentcodes01.jpg){: style="width:20%"} and it will take you to the ``Equipment Codes`` tab:

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

**Modern airliners will always be code L**

* Wake Turbulence Category
* NAV/COM Equipment
* SSR Equipment
- **TAS**: True Airspeed in knots (``kts``) or kilometres per hour (``km/h``)
- **Departure Airport**: ICAO code of your departure airport.
If no code is defined or if departing off-field, insert **ZZZZ** and specify **ADEP/** in the Remarks section, e.g. ``ADEP/Cairns Hospital``
Expand Down Expand Up @@ -96,10 +86,5 @@ At the bottom of the Flightplan page you will find a number of useful functions.

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

* ![](./../../img/manual_swiftgui_flightplan_buttons_save-load.jpg){: style="width:25%"} you may save and load flightplan data. Acceptable formats are vPilot, SB4 and *swift* JSON.
* ![](./../../img/manual_swiftgui_flightplan_buttons_validate.jpg){: style="width:15%"} before submitting a flightplan you can allow *swift* to validate your flightplan data.
This can be done either in a strict or in a lenient way.
Use the check mark box to control the mode.
If any field does not contain valid data, the validator will inform you about this fact so you can correct it and run the validator again
* **Prefill** fills the flight plan based on current aircraft data
* ![](./../../img/manual_swiftgui_flightplan_buttons_save-load.jpg){: style="width:25%"} you may save and load flightplan data. Acceptable formats are SB4 and *swift* JSON.
* **Reset** allows you to clear the entire flight plan to start over
6 changes: 6 additions & 0 deletions docs/home/checklist_first_flight.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ Until including **X-Plane 11.41** you have to use *swift* **version 0.9.4.389**.
* enable [Simconnect Offsets](./../documentation/flying/settings/simconnect_sb4_offsets.md) in the driver settings if you want to use ATC Transponder updates from PMDG and other aircraft
* you **cannot connect** *swift* to P3D or FSX?
If you run P3D/FSX **as Admin**, then run *swift* **as Admin** as well
* FSX and some P3D versions cannot handle all frequencies with **8.33 kHz spacing**.
Such frequencies can only be tuned through the swift UI.
In this case, your radio within the simulator might show a different frequency than selected within swift.
However, the frequency used to receive and transmit voice is always the frequency shown within swift.

### FS9

Expand All @@ -64,3 +68,5 @@ Until including **X-Plane 11.41** you have to use *swift* **version 0.9.4.389**.
* since Windows 10 Update 1909, the **automatic connect function** between *swift* and FS9 may **not** work anymore.
You will have to **[connect FS9 manually](./../troubleshooting/connect_fs9_manually.md)**
* consider the **Ground Elevation** recording: [Help Page](./install/fs9/fs9_ground_elevation.md)
* The COM frequencies selected within FS9 are **not synchronized** with swift.
You must tune the frequencies through the swift UI.
4 changes: 2 additions & 2 deletions docs/home/system_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ Our *swift* applications have been designed to work on all relevant operating sy
## Linux
* 64 bit only
* 200 MB free disk space
* *swift* is built on **Ubuntu 20.04 LTS**. Therefore it should run on any modern Linux distributions that have the following **minimum package versions** installed:
* *swift* is built on **Ubuntu 22.04 LTS**. Therefore it should run on any modern Linux distributions that have the following **minimum package versions** installed:
* glibc 2.31 or higher
* glibcxx 3.4.28 or higher
* OpenSSL 1.1
(OpenSSL 3 is **not** yet supported for official swift versions because Qt on Ubuntu 20.04 is built with OpenSSL 1.1.
Not installing OpenSSL 1.1 leads to warning messages like ``QSslSocket: cannot call unresolved function ...``)
* libxcb-xinerama0
* libxcb-cursor0
* libspeexdsp
* libopus

Expand Down
Binary file removed docs/img/SimConnect_swift_config.jpg
Binary file not shown.
Binary file removed docs/img/failedtoconnect.jpg
Binary file not shown.
Binary file removed docs/img/failedtoconnect2.jpg
Binary file not shown.
Binary file removed docs/img/manual_swiftgui_flightplan.jpg
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
28 changes: 0 additions & 28 deletions docs/troubleshooting/bootstrap.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/troubleshooting/command_line_arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
SPDX-License-Identifier: GFDL-1.3-only
-->

!!! note

see also [Developer Command Line Arguments](./developer_command_line_arguments.md)

You can start all *swift* applications with **Command Line Arguments**, meaning that you **assign parameters** to programs that you run.


Expand Down
45 changes: 0 additions & 45 deletions docs/troubleshooting/developer_command_line_arguments.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/troubleshooting/faq/atc_failed_to_connect.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/troubleshooting/faq/temp_disable_model.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/troubleshooting/first_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@

Read this [checklist](../home/checklist_first_flight.md)

**Setup / bootstrap file trouble**

See [Bootstrap file](./bootstrap.md).

***swift* does not start / connect**

- Could be a Virus scanner/Security suite issue, maybe check if swift needs some permission there
Expand Down Expand Up @@ -55,7 +51,6 @@ In your *swift* installation directory you will see a directory `bearer`, just r
- I only see "Constellations".
Most likely you have no model set, an improper model set.
- If the simulator does NOT connect, see the configuration page for your simulator
- make sure you have the correct *swift* version, [32 bit or 64 bit](./../documentation/flying/p3d_64_or_32.md)
- If you cannot connect the simulator and *swift*: If you run P3D "as admin\", run swift "as admin"
- make sure you use the correct P3D driver version.
If this version does not (yet) exists, selected the version which comes closest.
Expand Down
Loading