From cdb9c6bef9c3097c98c989ba61c300f96157adb0 Mon Sep 17 00:00:00 2001 From: Valastiri Date: Sat, 19 Aug 2023 09:58:24 +0800 Subject: [PATCH 1/7] feat: add top level installer section + pages --- docs/.pages | 1 + docs/installer/.pages | 8 ++++++++ docs/installer/index.md | 22 ++++++++++++++++++++++ 3 files changed, 31 insertions(+) create mode 100644 docs/installer/.pages create mode 100644 docs/installer/index.md diff --git a/docs/.pages b/docs/.pages index ef1618b0b..deb426f80 100644 --- a/docs/.pages +++ b/docs/.pages @@ -4,4 +4,5 @@ nav: - pilots-corner - dev-corner - simbridge + - installer - release-notes diff --git a/docs/installer/.pages b/docs/installer/.pages new file mode 100644 index 000000000..583b7c9ef --- /dev/null +++ b/docs/installer/.pages @@ -0,0 +1,8 @@ +# Edit this page to get: +# - Title for the whole directory +# - Titles for specific pages or subdirectories +# - Order of pages (otherwise alphabetical order) + +title: FlyByWire Installer +nav: + - Overview: index.md \ No newline at end of file diff --git a/docs/installer/index.md b/docs/installer/index.md new file mode 100644 index 000000000..1d807ca64 --- /dev/null +++ b/docs/installer/index.md @@ -0,0 +1,22 @@ +--- +title: FBW Installer - Overview +description: Section dedicated to documenting the setup and use of the FlyByWire Installer. +--- + + + +# FBW Installer + +The FlyByWire Installer is a tool that allows you to install and update the FlyByWire aircraft and its dependencies such as SimBridge. It is a standalone application that is +separate from the aircraft itself. + +## 3rd Party Aircraft and Tools + +Specific 3rd party aircraft and tools we have collaborated with are also available in the installer. These are not developed by FlyByWire, but we have worked with the +developers in various capacities in the spirit of open source collaboration. You can find a list below: + +| Team | Product | Status | +|:-------------------------------------------------------------------------------|:-------------------------------------------------|:---------------:| +| Salty Simulations - [Discord](https://discord.com/invite/S4PJDwk) | Aircraft - 74S (Boeing 747-8I) | Released | +| [FSLTL](https://www.fslivetrafficliveries.com/) | Standalone Real-Time traffic and livery matching | Released | +| [Synaptic Simulations](https://www.synapticsim.com/) | Aircraft - A22X (Airbus A220neo) | *Not Available* | From b68cc78dbf5b4b8eef70d6528f0dc9d2f056e595 Mon Sep 17 00:00:00 2001 From: Valastiri Date: Thu, 5 Oct 2023 19:42:17 +0800 Subject: [PATCH 2/7] add target=new to installer links --- docs/installer/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/installer/index.md b/docs/installer/index.md index 1d807ca64..98b06f50b 100644 --- a/docs/installer/index.md +++ b/docs/installer/index.md @@ -15,8 +15,8 @@ separate from the aircraft itself. Specific 3rd party aircraft and tools we have collaborated with are also available in the installer. These are not developed by FlyByWire, but we have worked with the developers in various capacities in the spirit of open source collaboration. You can find a list below: -| Team | Product | Status | -|:-------------------------------------------------------------------------------|:-------------------------------------------------|:---------------:| -| Salty Simulations - [Discord](https://discord.com/invite/S4PJDwk) | Aircraft - 74S (Boeing 747-8I) | Released | -| [FSLTL](https://www.fslivetrafficliveries.com/) | Standalone Real-Time traffic and livery matching | Released | -| [Synaptic Simulations](https://www.synapticsim.com/) | Aircraft - A22X (Airbus A220neo) | *Not Available* | +| Team | Product | Status | +|:----------------------------------------------------------------------------|:-------------------------------------------------|:---------------:| +| Salty Simulations [Discord](https://discord.com/invite/S4PJDwk){target=new} | Aircraft - 74S (Boeing 747-8i) | Released | +| [FSLTL](https://www.fslivetrafficliveries.com/){target=new} | Standalone Real-Time traffic and livery matching | Released | +| [Synaptic Simulations](https://www.synapticsim.com/){target=new} | Aircraft - A22X (Airbus A220neo) | *Not Available* | From c9238b6d8819e7c4c1679a56c6615bda2593e7e8 Mon Sep 17 00:00:00 2001 From: Valastiri Date: Sun, 8 Oct 2023 13:45:55 +0800 Subject: [PATCH 3/7] create installer reported-issues.md --- docs/installer/reported-issues.md | 150 ++++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 docs/installer/reported-issues.md diff --git a/docs/installer/reported-issues.md b/docs/installer/reported-issues.md new file mode 100644 index 000000000..0df708225 --- /dev/null +++ b/docs/installer/reported-issues.md @@ -0,0 +1,150 @@ +# Reported Issues + + +!!! danger "STOP - Read this First" + + Please try removing all other mods/liveries from the community folder and test our add-on again. This will help rule out conflicts. + + *Most reported issues are caused by conflicts with other mods and liveries. If this does not resolve your issue, please continue below.* + + **Throttle Calibration is Required** - [Guide Here](../feature-guides/flypados3/throttle-calibration.md) + + --- + + Development Version + + FBW Installer - [Download Here](https://api.flybywiresim.com/installer){target=new} / *Latest Sim Version: 1.34.16.0* + +!!! warning "Read our Support Guide" + + 1. [Learn how to fly an A32NX](index.md#1-learn-how-to-fly-the-a32nx) + 2. [Troubleshoot](index.md#2-how-to-troubleshoot) + 3. [Research Known Issues](index.md#3-research-known-issues) + 4. [Report Issue on Discord](index.md#4-report-issue-on-discord) + 5. [Report Issue on the FBW Aircraft GitHub](index.md#5-report-issue-on-the-a32nx-github) + 6. [Collecting Support Information](index.md#collecting-support-information) + + --- + + Due to the complex nature of our custom autopilot, please visit the dedicated ^^Custom Autopilot / Fly-By-Wire^^ page for more information: + + - [**Main Page**](../feature-guides/autopilot-fbw.md) + - [**Typical Issues + Solutions**](../feature-guides/autopilot-fbw.md#typical-issues-and-how-to-solve-them) + - [**Known Issues**](../feature-guides/autopilot-fbw.md#known-issues) + + --- + + Please visit the ^^Dedicated Custom Flight Management System^^ page for more information: + + - [**Features + Issues**](../feature-guides/cFMS.md) + - [**Special Notes**](../feature-guides/cFMS.md#special-notes) + + --- + + If you're having issues with ^^SimBridge^^, please follow our dedicated guide for it: + + - [**SimBridge Troubleshooting Guide**](../../simbridge/troubleshooting.md) + + --- + + Do this before reporting bugs. +--- + + + +## Index + +| Quick Links | +|:---------------------------------------------------------------------------------------| +| [Commonly Reported Issues](#commonly-reported-issues) | +| [Solutions to Commonly Reported Issues](#solutions-to-commonly-reported-issues) | +| [FBW Installer Issues](#fbw-installer-issues) | +| [Incompatible and Problematic Add-ons/Mods](#incompatible-and-problematic-add-onsmods) | + +## Use the Browser's Search Function + +On Desktop, press ++ctrl+'F'++ to search for an issue within the current page. + +## Legend + +!!! bug "Breaking Issue / Bug" +!!! warning "Non-Breaking Issue / Inconvenience" +!!! tip "Config Issue / Usage Issue" + +## Commonly Reported Issues +The following list of issues are commonly reported on our Discord support channel. Please check these before reporting any other issue on Discord. + +*Last Update: {{git_revision_date_localized}}* + +## FBW Installer Issues + +??? bug "Download Issues - FBW Products" +### Download Issues - FBW Products + + ^^Description^^ + + In certain situations, your ISP may block our CDN (Content Distribution Network) served by Cloudflare. Cloudflare allows us to save costs when users download our aircraft from our installer to + provide a seamless installation process for a variety of our products. + + Additionally, any disturbance to the stability of your connection may cause any downloads to fail and may need to be retried when you have a more stable connection. + + ^^Common Error Codes^^ + + - ECONNRESET + - ETIMEDOUT + - ENOTFOUND + - HTTP 403 + + ^^Possible Solution or Workaround^^ + + We recommend one of the following actions: + + 1. TEMPORARY Solution: Try a VPN - a great free one that's reliable is [ProtonVPN](https://protonvpn.com/). + - Please do your own due diligence and research when utilizing a VPN, even with our recommended one above. + 2. Download a full build from our website [here]() - Please ensure you follow our [manual installation instructions](../installation.md#manual-installation). + 3. Contact your ISP to check with them if there are any existing issues utilizing Cloudflare on their network. + + ^^Additional Information^^ + + Below is a list of countries that are possibly affected by this issue. Please note that it may not be *every* ISP in the country. + + - Brazil + - China + - Iberia + - Portugal + - Saudi Arabia + - Spain + +??? bug "Installer Permission Problems" +### Installer Permission Problems + + ^^Description^^ + + During installation of a product a "Windows Permission Error" with the error code EPERM shows up and the installation is aborted. + + ^^Root Cause^^ + + Sometimes the permissions of the community folder are set to not allow the current user to install addons in it. + This might be set since the installation of MSFS or MSFS might have changed it at some point. + + ^^Possible Solution or Workaround^^ + + One of the following solutions usually lets the desired addon be installed + + * Check the permissions of the community folder and correct them. + * Rename the current community folder, create a new one with the same name and move your installed addons into the new community folder. + * Start the installer with admin permissions. From 2eee79c4c7148be1abb905510ca6c540bd37dc08 Mon Sep 17 00:00:00 2001 From: Valastiri Date: Tue, 10 Oct 2023 13:02:24 +0800 Subject: [PATCH 4/7] add installer reported issues --- docs/installer/.pages | 3 +- docs/installer/index.md | 2 + docs/installer/reported-issues.md | 73 +++++-------------------------- 3 files changed, 15 insertions(+), 63 deletions(-) diff --git a/docs/installer/.pages b/docs/installer/.pages index 583b7c9ef..76bb9a220 100644 --- a/docs/installer/.pages +++ b/docs/installer/.pages @@ -5,4 +5,5 @@ title: FlyByWire Installer nav: - - Overview: index.md \ No newline at end of file + - Overview: index.md + - ... \ No newline at end of file diff --git a/docs/installer/index.md b/docs/installer/index.md index 98b06f50b..31a9de172 100644 --- a/docs/installer/index.md +++ b/docs/installer/index.md @@ -10,6 +10,8 @@ description: Section dedicated to documenting the setup and use of the FlyByWire The FlyByWire Installer is a tool that allows you to install and update the FlyByWire aircraft and its dependencies such as SimBridge. It is a standalone application that is separate from the aircraft itself. +[Known Issues + Troubleshooting Here](reported-issues.md){.md-button} + ## 3rd Party Aircraft and Tools Specific 3rd party aircraft and tools we have collaborated with are also available in the installer. These are not developed by FlyByWire, but we have worked with the diff --git a/docs/installer/reported-issues.md b/docs/installer/reported-issues.md index 0df708225..8b01f0d06 100644 --- a/docs/installer/reported-issues.md +++ b/docs/installer/reported-issues.md @@ -1,53 +1,16 @@ -# Reported Issues +# Installer Reported Issues -!!! danger "STOP - Read this First" - - Please try removing all other mods/liveries from the community folder and test our add-on again. This will help rule out conflicts. - - *Most reported issues are caused by conflicts with other mods and liveries. If this does not resolve your issue, please continue below.* - - **Throttle Calibration is Required** - [Guide Here](../feature-guides/flypados3/throttle-calibration.md) - - --- - - Development Version - - FBW Installer - [Download Here](https://api.flybywiresim.com/installer){target=new} / *Latest Sim Version: 1.34.16.0* - -!!! warning "Read our Support Guide" - - 1. [Learn how to fly an A32NX](index.md#1-learn-how-to-fly-the-a32nx) - 2. [Troubleshoot](index.md#2-how-to-troubleshoot) - 3. [Research Known Issues](index.md#3-research-known-issues) - 4. [Report Issue on Discord](index.md#4-report-issue-on-discord) - 5. [Report Issue on the FBW Aircraft GitHub](index.md#5-report-issue-on-the-a32nx-github) - 6. [Collecting Support Information](index.md#collecting-support-information) - - --- - - Due to the complex nature of our custom autopilot, please visit the dedicated ^^Custom Autopilot / Fly-By-Wire^^ page for more information: - - - [**Main Page**](../feature-guides/autopilot-fbw.md) - - [**Typical Issues + Solutions**](../feature-guides/autopilot-fbw.md#typical-issues-and-how-to-solve-them) - - [**Known Issues**](../feature-guides/autopilot-fbw.md#known-issues) - - --- - - Please visit the ^^Dedicated Custom Flight Management System^^ page for more information: - - - [**Features + Issues**](../feature-guides/cFMS.md) - - [**Special Notes**](../feature-guides/cFMS.md#special-notes) - - --- +!!! tip "" + FBW Installer - [Download Here](https://api.flybywiresim.com/installer){target=new} - If you're having issues with ^^SimBridge^^, please follow our dedicated guide for it: - - - [**SimBridge Troubleshooting Guide**](../../simbridge/troubleshooting.md) +!!! info "General Issues" + If you are experiencing issues with our aircraft please visit the following pages: - --- + - [Known Issues](../fbw-a32nx/support/reported-issues.md) + - [Support Guide](../fbw-a32nx/support/index.md) + - [FAQ](../fbw-a32nx/faq.md) - Do this before reporting bugs. --- -## Index - -| Quick Links | -|:---------------------------------------------------------------------------------------| -| [Commonly Reported Issues](#commonly-reported-issues) | -| [Solutions to Commonly Reported Issues](#solutions-to-commonly-reported-issues) | -| [FBW Installer Issues](#fbw-installer-issues) | -| [Incompatible and Problematic Add-ons/Mods](#incompatible-and-problematic-add-onsmods) | - ## Use the Browser's Search Function On Desktop, press ++ctrl+'F'++ to search for an issue within the current page. @@ -85,15 +39,10 @@ On Desktop, press ++ctrl+'F'++ to search for an issue within the current page. !!! warning "Non-Breaking Issue / Inconvenience" !!! tip "Config Issue / Usage Issue" -## Commonly Reported Issues -The following list of issues are commonly reported on our Discord support channel. Please check these before reporting any other issue on Discord. - -*Last Update: {{git_revision_date_localized}}* - ## FBW Installer Issues ??? bug "Download Issues - FBW Products" -### Download Issues - FBW Products + ### Download Issues - FBW Products ^^Description^^ @@ -115,7 +64,7 @@ The following list of issues are commonly reported on our Discord support channe 1. TEMPORARY Solution: Try a VPN - a great free one that's reliable is [ProtonVPN](https://protonvpn.com/). - Please do your own due diligence and research when utilizing a VPN, even with our recommended one above. - 2. Download a full build from our website [here]() - Please ensure you follow our [manual installation instructions](../installation.md#manual-installation). + 2. Download a full build from our website [here]() - Please ensure you follow our [manual installation instructions](../fbw-a32nx/installation.md#manual-installation). 3. Contact your ISP to check with them if there are any existing issues utilizing Cloudflare on their network. ^^Additional Information^^ @@ -130,7 +79,7 @@ The following list of issues are commonly reported on our Discord support channe - Spain ??? bug "Installer Permission Problems" -### Installer Permission Problems + ### Installer Permission Problems ^^Description^^ From efcc74815c52822a188edf7def50e1e439070014 Mon Sep 17 00:00:00 2001 From: Valastiri Date: Tue, 10 Oct 2023 13:05:39 +0800 Subject: [PATCH 5/7] internal links to installer issues from reported-issues.md --- docs/fbw-a32nx/support/reported-issues.md | 65 ++--------------------- 1 file changed, 3 insertions(+), 62 deletions(-) diff --git a/docs/fbw-a32nx/support/reported-issues.md b/docs/fbw-a32nx/support/reported-issues.md index 8ba9a7374..d22f40fdb 100644 --- a/docs/fbw-a32nx/support/reported-issues.md +++ b/docs/fbw-a32nx/support/reported-issues.md @@ -7,7 +7,9 @@ *Most reported issues are caused by conflicts with other mods and liveries. If this does not resolve your issue, please continue below.* - **Throttle Calibration is Required** - [Guide Here](../feature-guides/flypados3/throttle-calibration.md) + - **Throttle Calibration is Required** - [Guide Here](../feature-guides/flypados3/throttle-calibration.md) + + - **FBW Installer Issues** - [Guide Here](../../installer/reported-issues.md) --- @@ -72,7 +74,6 @@ TEMPLATE |:---------------------------------------------------------------------------------------| | [Commonly Reported Issues](#commonly-reported-issues) | | [Solutions to Commonly Reported Issues](#solutions-to-commonly-reported-issues) | -| [FBW Installer Issues](#fbw-installer-issues) | | [Incompatible and Problematic Add-ons/Mods](#incompatible-and-problematic-add-onsmods) | ## Use the Browser's Search Function @@ -1002,66 +1003,6 @@ Please try these before reporting any other issue on Discord. This is an MSFS issue sometimes triggered by pushback tools like Toolbar Pushback Add-on and the flyPad pushback system. - -## FBW Installer Issues - -??? bug "Download Issues - FBW Products" - ### Download Issues - FBW Products - - ^^Description^^ - - In certain situations, your ISP may block our CDN (Content Distribution Network) served by Cloudflare. Cloudflare allows us to save costs when users download our aircraft from our installer to - provide a seamless installation process for a variety of our products. - - Additionally, any disturbance to the stability of your connection may cause any downloads to fail and may need to be retried when you have a more stable connection. - - ^^Common Error Codes^^ - - - ECONNRESET - - ETIMEDOUT - - ENOTFOUND - - HTTP 403 - - ^^Possible Solution or Workaround^^ - - We recommend one of the following actions: - - 1. TEMPORARY Solution: Try a VPN - a great free one that's reliable is [ProtonVPN](https://protonvpn.com/). - - Please do your own due diligence and research when utilizing a VPN, even with our recommended one above. - 2. Download a full build from our website [here]() - Please ensure you follow our [manual installation instructions](../installation.md#manual-installation). - 3. Contact your ISP to check with them if there are any existing issues utilizing Cloudflare on their network. - - ^^Additional Information^^ - - Below is a list of countries that are possibly affected by this issue. Please note that it may not be *every* ISP in the country. - - - Brazil - - China - - Iberia - - Portugal - - Saudi Arabia - - Spain - -??? bug "Installer Permission Problems" - ### Installer Permission Problems - - ^^Description^^ - - During installation of a product a "Windows Permission Error" with the error code EPERM shows up and the installation is aborted. - - ^^Root Cause^^ - - Sometimes the permissions of the community folder are set to not allow the current user to install addons in it. - This might be set since the installation of MSFS or MSFS might have changed it at some point. - - ^^Possible Solution or Workaround^^ - - One of the following solutions usually lets the desired addon be installed - - * Check the permissions of the community folder and correct them. - * Rename the current community folder, create a new one with the same name and move your installed addons into the new community folder. - * Start the installer with admin permissions. - ## Incompatible and Problematic Add-ons/Mods The following add-ons and mods are known to be incompatible and cause issues with the A32NX. We recommend you uninstall these before starting the sim and flying with the A32NX, especially if you experience issues with the aircraft. From d0b7f8c5405363a474ffc73ca13a37d3cc11c570 Mon Sep 17 00:00:00 2001 From: Valastiri Date: Tue, 10 Oct 2023 13:06:27 +0800 Subject: [PATCH 6/7] convenience redirect --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index d54c4b907..10a5433bb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,6 +82,7 @@ plugins: 'installation.md': 'fbw-a32nx/installation.md' 'throttle.md': 'fbw-a32nx/feature-guides/flypados3/throttle-calibration.md' 'reported-issues.md': 'fbw-a32nx/support/reported-issues.md' + 'installer-issues.md': 'installer/reported-issues.md' 'support.md': 'fbw-a32nx/support/index.md' 'discord-bot.md': 'dev-corner/development-projects/discord-bot.md' 'airframe.md': 'https://docs.flybywiresim.com/fbw-a32nx/installation/#simbrief-airframe' From bfe406074948010fbfa5cfaba2f87efe4ef02847 Mon Sep 17 00:00:00 2001 From: Val Date: Wed, 18 Oct 2023 11:44:36 +0800 Subject: [PATCH 7/7] slein minor change Co-authored-by: Sleinmaster <79196358+Sleinmaster@users.noreply.github.com> --- docs/installer/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installer/index.md b/docs/installer/index.md index 31a9de172..50444a1f5 100644 --- a/docs/installer/index.md +++ b/docs/installer/index.md @@ -7,7 +7,7 @@ description: Section dedicated to documenting the setup and use of the FlyByWire # FBW Installer -The FlyByWire Installer is a tool that allows you to install and update the FlyByWire aircraft and its dependencies such as SimBridge. It is a standalone application that is +The FlyByWire Installer is a tool that allows you to install and update the FlyByWire aircraft and its dependencies such as SimBridge, as well as selected 3rd party Aircraft and Tools. It is a standalone application that is separate from the aircraft itself. [Known Issues + Troubleshooting Here](reported-issues.md){.md-button}