diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6f4f94e..1999e23 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -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' diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 224e588..4a0932a 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -12,8 +12,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' @@ -21,11 +21,11 @@ jobs: 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/" @@ -41,4 +41,4 @@ jobs: steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v2 + uses: actions/deploy-pages@v4 diff --git a/docs/documentation/distributed.md b/docs/documentation/distributed.md index f3f0f57..4843cda 100644 --- a/docs/documentation/distributed.md +++ b/docs/documentation/distributed.md @@ -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**. diff --git a/docs/documentation/flying/fsuipc.md b/docs/documentation/flying/fsuipc.md deleted file mode 100644 index c9e3781..0000000 --- a/docs/documentation/flying/fsuipc.md +++ /dev/null @@ -1,7 +0,0 @@ - - - * For *swift* + FS9 FSUIPC is required (mandatory) - * For *swift* + FSX/P3D is normally not needed and optional (you could use it to query XPDR state/ident), but normally the SimConnect SB4 synchronization should already work, see [this article](./settings/simconnect_sb4_offsets.md). diff --git a/docs/documentation/flying/integrated_com.md b/docs/documentation/flying/integrated_com.md index fd5930a..7e74309 100644 --- a/docs/documentation/flying/integrated_com.md +++ b/docs/documentation/flying/integrated_com.md @@ -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 diff --git a/docs/documentation/flying/model_set_validation.md b/docs/documentation/flying/model_set_validation.md index 46372b2..51af533 100644 --- a/docs/documentation/flying/model_set_validation.md +++ b/docs/documentation/flying/model_set_validation.md @@ -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%"} diff --git a/docs/documentation/flying/p3d_64_or_32.md b/docs/documentation/flying/p3d_64_or_32.md deleted file mode 100644 index f46b04d..0000000 --- a/docs/documentation/flying/p3d_64_or_32.md +++ /dev/null @@ -1,17 +0,0 @@ - - -The ideal choice for using P3D with *swift* is the 64bit version. -However, for P3D before V4.2 you need to use *swift's* 32bit version! -You can try the 64bit version, but most likely the driver will not connect. - -You can also use the 32bit version with the newer P3D versions, but then always the legacy FSX driver will be used. - -* *swift* 64bit version uses the latest P3D SimConnect API and library -* *swift* 32bit version uses the FSX SimConnect API and ``DLL`` - -In the mid and long term, the new SimConnect will use newer P3D API functions that are not available in legacy versions of SimConnect. -So far, the differences between the old and new API are minor, but they are steadily increasing. -As of P3D V4.2, *swift* has already been using newer functions and we are going to use even better functions available in 4.3 and later. diff --git a/docs/documentation/flying/remote_simconnect.md b/docs/documentation/flying/remote_simconnect.md deleted file mode 100644 index 8332124..0000000 --- a/docs/documentation/flying/remote_simconnect.md +++ /dev/null @@ -1,40 +0,0 @@ - - -!!! note - - Remote SimConnect allows you to run a "standalone" GUI connecting to a remote FSX/P3D via a "remote SimConnect" configuration. - This is something different as a distributed *swift* GUI connected with a core. - -If you want to read about remote swift UI see [this article](./../distributed.md). - -## Enable the server side (where FSX or P3D runs) - -- From the official [P3D documentation](https://www.prepar3d.com/SDKv4/sdk/simconnect_api/configuration_files/configuration_files_overview.html) -- Another remote SimConnect config [tutorial is here](https://www.fsdeveloper.com/wiki/index.php?title=Remote_connection). -- In `%APPDATA%\Lockheed Martin\Prepar3D v4` (or `Microsoft/FSX`) create a `SimConnect.xml` file -- Example: My path looks like this for FSX: - `C:\Users\[username]\AppData\Roaming\Microsoft\FSX` -- This file is only needed when remote access is required -- For me the file is identical for P3Dv4 and FSX -- In case one needs to create SimConnect log files, the .ini file is here: `C:Users\[username\]DocumentsFlight Simulator X FilesSimConnect.ini` - -Example file: TODO ADD - -## Enable the client side (where *swift* runs) - -- On the client machine, go to the `Documents` folder, something like this: `C:\Users\[username]\Documents` -- In the documents folder place a `SimConnect.cfg` file corresponding with the above server - -Example file: TODO ADD - -You can alternatively use the config option from the *swift* settings - - -![](./../../img/SimConnect_swift_config.jpg){: style="width:75%"} - -## Logging SimConnect - - diff --git a/docs/documentation/swift_gui/flightplan_page.md b/docs/documentation/swift_gui/flightplan_page.md index 3972ad1..cdef19e 100644 --- a/docs/documentation/swift_gui/flightplan_page.md +++ b/docs/documentation/swift_gui/flightplan_page.md @@ -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`` @@ -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 diff --git a/docs/home/checklist_first_flight.md b/docs/home/checklist_first_flight.md index bb44079..22fd0c5 100644 --- a/docs/home/checklist_first_flight.md +++ b/docs/home/checklist_first_flight.md @@ -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 @@ -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. diff --git a/docs/home/system_requirements.md b/docs/home/system_requirements.md index e037a18..4ada623 100644 --- a/docs/home/system_requirements.md +++ b/docs/home/system_requirements.md @@ -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 diff --git a/docs/img/SimConnect_swift_config.jpg b/docs/img/SimConnect_swift_config.jpg deleted file mode 100644 index e338076..0000000 Binary files a/docs/img/SimConnect_swift_config.jpg and /dev/null differ diff --git a/docs/img/failedtoconnect.jpg b/docs/img/failedtoconnect.jpg deleted file mode 100644 index e852efc..0000000 Binary files a/docs/img/failedtoconnect.jpg and /dev/null differ diff --git a/docs/img/failedtoconnect2.jpg b/docs/img/failedtoconnect2.jpg deleted file mode 100644 index 6f7831d..0000000 Binary files a/docs/img/failedtoconnect2.jpg and /dev/null differ diff --git a/docs/img/manual_swiftgui_flightplan.jpg b/docs/img/manual_swiftgui_flightplan.jpg deleted file mode 100644 index c7da03e..0000000 Binary files a/docs/img/manual_swiftgui_flightplan.jpg and /dev/null differ diff --git a/docs/img/manual_swiftgui_flightplan_buttons_validate.jpg b/docs/img/manual_swiftgui_flightplan_buttons_validate.jpg deleted file mode 100644 index 4a49f95..0000000 Binary files a/docs/img/manual_swiftgui_flightplan_buttons_validate.jpg and /dev/null differ diff --git a/docs/img/manual_swiftgui_flightplan_equipmentcodes01.jpg b/docs/img/manual_swiftgui_flightplan_equipmentcodes01.jpg deleted file mode 100644 index f89aabc..0000000 Binary files a/docs/img/manual_swiftgui_flightplan_equipmentcodes01.jpg and /dev/null differ diff --git a/docs/img/manual_swiftgui_flightplan_equipmentcodes02.jpg b/docs/img/manual_swiftgui_flightplan_equipmentcodes02.jpg deleted file mode 100644 index eb02867..0000000 Binary files a/docs/img/manual_swiftgui_flightplan_equipmentcodes02.jpg and /dev/null differ diff --git a/docs/troubleshooting/bootstrap.md b/docs/troubleshooting/bootstrap.md deleted file mode 100644 index 887d13b..0000000 --- a/docs/troubleshooting/bootstrap.md +++ /dev/null @@ -1,28 +0,0 @@ - - -The **bootstrap file** contains fundamental setup information for *swift*. -Without this data *swift* cannot work properly. -Normally the data is loaded/updated from the internet each time *swift* starts. -In case that no connection can be established when starting up *swift*, cached data is used. - -## The bootstrap resolution screen -If the **bootstrap file** cannot be loaded, a resolution screen is displayed. -Possible reasons why **bootstrap file** loading might fail are: - -* typo in the URL -* *swift* servers are down (please understand we keep copies of the file at multiple locations) -* network problem on user's side -* if the bootstrap file has been loaded before the locally stored (cached) version is used -* if the user provides an explicit URL (command line) only this URL is used - - -**Options to resolve the problems** - - * ignore the bootstrap URL and hence use the cached data (requires at least one successful load before that) - * use the local file copy (from the swift installer) - * use the cache file of another swift installation - -![](./../img/Bootstrap_resolution_screen.jpg){: style="width:80%"} diff --git a/docs/troubleshooting/command_line_arguments.md b/docs/troubleshooting/command_line_arguments.md index 0dc5a69..454e25d 100644 --- a/docs/troubleshooting/command_line_arguments.md +++ b/docs/troubleshooting/command_line_arguments.md @@ -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. diff --git a/docs/troubleshooting/developer_command_line_arguments.md b/docs/troubleshooting/developer_command_line_arguments.md deleted file mode 100644 index a9f642d..0000000 --- a/docs/troubleshooting/developer_command_line_arguments.md +++ /dev/null @@ -1,45 +0,0 @@ - - -see also [swift Command Line Arguments](./command_line_arguments.md) - -## Help - -Just use `--help` to see a help screen. -You can use `--help` with all executables, as launcher, core and client might have different arguments. - -![](./../img/commandlinearguments_gui.jpg){: style="width:60%"} - -## Testing as developer -Normally done like this: `--dev --bootstrapurl https://datastore.swift-project.org/shared/` - -- marking as developers provides some extra functionality -- the bootstrap location can also be changed to a test server - -Test the dump server: `--testcrashpad` - - -## Installers -Installer cmd. line: `-i --bootstrapurl https://datastore.swift-project.org/shared/` - -- bootstrap URL is mandatory -- use installer mode `-i` to launch wizard - - -## Testing pilot client with VATSIM live servers - -!!! danger - - Installer versions are automatically enabled for VATSIM productive keys. - -* Testing interpolation / aircraft parts - - use swift as "out of the box" - - any productive servers can be used - - works with our without simulator attached - - voice cannot be tested (no connection allowed) - -* Testing swift as we will ship it - - - set client id and key, cmd will look something like this: `--serverType vatsim --clientIdAndKey 0xFOO:BAR --dev --bootstrapurl - -If a connection to a single ATC station fails check if the station really supports voice control. -Some people set up a voice room but do NOT provide voice ATC. - -![](./../../img/failedtoconnect.jpg){: style="width:70%"} - -![](./../../img/failedtoconnect2.jpg){: style="width:70%"} diff --git a/docs/troubleshooting/faq/temp_disable_model.md b/docs/troubleshooting/faq/temp_disable_model.md deleted file mode 100644 index f0c0c9b..0000000 --- a/docs/troubleshooting/faq/temp_disable_model.md +++ /dev/null @@ -1,8 +0,0 @@ - - -You can temp disable a model, then remove it (or them) from the set. - -See [Model set validation](./../../documentation/flying/model_set_validation.md) for details. diff --git a/docs/troubleshooting/first_install.md b/docs/troubleshooting/first_install.md index 7001be8..c8a1dc3 100644 --- a/docs/troubleshooting/first_install.md +++ b/docs/troubleshooting/first_install.md @@ -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 @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 3349b2b..667c286 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -145,31 +145,25 @@ nav: - XPlane 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 - - swift and FSUIPC: documentation/flying/fsuipc.md - Instant mapping (create a mapping before you fly - Quick mapping wizard): documentation/flying/instant_mapping.md - swift launcher wizard: documentation/flying/swift_launcher_wizard.md - - P3D and swift - 32 or 64 bit?: documentation/flying/p3d_64_or_32.md - - P3D and FSX remote SimConnect access: documentation/flying/remote_simconnect.md - swift pilot client text message handling (disable overlay messages): documentation/flying/text_message_handling.md - Tower view for controllers with EuroScope, vStars: documentation/flying/tower_view.md - Update model data (for the client): documentation/flying/update_model_data.md - swift user data: documentation/flying/swift_user_data.md - Troubleshooting: - troubleshooting/index.md - - Bootstrap file: troubleshooting/bootstrap.md - swift does not connect with XPlane 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 - Questions and answers (aka FAQs): - - ATC failed to connect error 10061: troubleshooting/faq/atc_failed_to_connect.md - Choosing a callsign: troubleshooting/faq/choosing_callsign.md - How to fly as co-pilot?: troubleshooting/faq/fly_copilot.md - Models not accessible: troubleshooting/faq/model_not_accessable.md - I do not see other planes, no other aircraft, no other traffic: troubleshooting/faq/xp_problems.md - I see no other traffic: troubleshooting/faq/no_traffic.md - How can I restrict the number of aircraft?: troubleshooting/faq/restrict_rendered_aircrafts.md - - Temp disable a model: troubleshooting/faq/temp_disable_model.md - X-Plane landing gear missing/no animations: - troubleshooting/faq/xp_landing_gear/index.md - Deactivate plugins with xOrganizer: troubleshooting/faq/xp_landing_gear/deactivate_plugins_xorganizer.md @@ -202,7 +196,7 @@ nav: - Crash reports / enable crash dumps: troubleshooting/crash_reports.md - Creating a Windows crash dump (swift hanging): troubleshooting/windows_crash_dump.md - Disconnects due to low framerate (X-Plane): troubleshooting/xp_low_frames.md - - dot-commands (.commands), hide dot command tooltip: troubleshooting/dot_commands.md + - dot-commands (.commands): troubleshooting/dot_commands.md - Find cache and settings files (where swift stores its data): troubleshooting/cache_settings_location.md - Find swift log files, crashdump files, interpolation log. files: troubleshooting/swift_log_files.md - Connecting FS9 manually through multiplayer: troubleshooting/connect_fs9_manually.md @@ -220,7 +214,6 @@ nav: - Delete swift registry values (Windows only): troubleshooting/delete_registry_values.md - Save Window: troubleshooting/save_window.md - swift Command Line Arguments: troubleshooting/command_line_arguments.md - - swift Developer Command Lline Arguments: troubleshooting/developer_command_line_arguments.md - swift UI concepts (multiple windows, floating windows, resize views): troubleshooting/ui_concepts.md - Tracing interpolation: troubleshooting/tracing_interpolation.md - "Example: Tracing if aircraft should be on ground": troubleshooting/example_tracing.md