From 3af8d13deabaf37dbd1fb8f84ba3e2d5976bd318 Mon Sep 17 00:00:00 2001 From: Frank Kopp Date: Sun, 17 Nov 2024 19:05:53 +0100 Subject: [PATCH] fix: updated default config data (#497) * small formatting fix * updated default config data * fixed text and links --- README.md | 7 +- src/renderer/data.ts | 284 ++++++++++++++++++++----------------------- 2 files changed, 138 insertions(+), 153 deletions(-) diff --git a/README.md b/README.md index 2ac4d6d6..005c8773 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ This repository contains the installer for FlyByWire Simulations projects such a ## How to contribute -The installer is built as an [Electron Application](https://www.electronjs.org/) for Windows using [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/). +The installer is built as an [Electron Application](https://www.electronjs.org/) for Windows +using [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/). ### Requirements @@ -36,4 +37,6 @@ To build the package as .exe, run npm run package ``` -Packaged applications will automatically update if there is a newer version available (compared to build version in package.json), this does also apply to development versions (ending on -devXX), which are updated via a separate stream. Updates are distributed once the build version is changed and a tag has been added. +Packaged applications will automatically update if there is a newer version available (compared to build version in package.json), this does +also apply to development versions (ending on -devXX), which are updated via a separate stream. Updates are distributed once the build +version is changed and a tag has been added. diff --git a/src/renderer/data.ts b/src/renderer/data.ts index 4a875116..6e40192e 100644 --- a/src/renderer/data.ts +++ b/src/renderer/data.ts @@ -6,7 +6,7 @@ export const defaultConfiguration: Configuration = { { name: 'FlyByWire Simulations', key: 'flybywiresim', - logoUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/publisher-icons/flybywiresim/0.svg', + logoUrl: 'https://flybywirecdn.com/installer/media-assets/publisher-icons/flybywiresim/0.svg', defs: [ { kind: 'addonCategory', @@ -55,12 +55,11 @@ export const defaultConfiguration: Configuration = { repoName: 'aircraft', category: '@aircraft', aircraftName: 'A320-251N', - titleImageUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fbw-a32nx/dark.svg', - titleImageUrlSelected: - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fbw-a32nx/light.svg', + titleImageUrl: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fbw-a32nx/dark.svg', + titleImageUrlSelected: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fbw-a32nx/light.svg', enabled: true, // TODO: Change this - backgroundImageUrls: ['https://flybywiresim.b-cdn.net/installer/media-assets/addon-headers/fbw-a32nx/1.png'], + backgroundImageUrls: ['https://flybywirecdn.com/installer/media-assets/addon-headers/fbw-a32nx/1.png'], shortDescription: 'Airbus A320neo Series', description: 'The A320neo (new engine option) is one of many upgrades introduced by Airbus to help maintain ' + @@ -96,7 +95,7 @@ export const defaultConfiguration: Configuration = { 'with each major patch from MSFS.', isExperimental: false, releaseModel: { - type: 'githubRelease', + type: 'fragmenter', }, }, { @@ -118,12 +117,11 @@ export const defaultConfiguration: Configuration = { ], description: 'Development will have the latest features that will end up in the next stable. ' + - "Bugs are to be expected. It updates whenever something is added to the 'master' " + + "Although every change is QA-tested, bugs are a little more likely. It updates whenever something is added to the 'master' " + 'branch on Github. Please visit our discord for support.', isExperimental: false, releaseModel: { - type: 'githubBranch', - branch: 'master', + type: 'fragmenter', }, }, ], @@ -140,111 +138,11 @@ export const defaultConfiguration: Configuration = { // creator: the exact creator as it appears in the manifest.json // packageVersion syntax follows: https://www.npmjs.com/package/semver // description: a short description of why the addon is incompatible - { - title: 'FlightFlow | IMPROVED TEXTURES MOD', - creator: 'FlightFlow', - description: - 'It is recommended to remove this add-on/mod before installing and using the A32NX. This add-on/mod is known to override A32NX components and cause unexpected behavior and issues when flying the A32NX.', - }, - { - title: 'Horizon Simulations A319ceo', - packageVersion: '<0.6.1', - description: - 'It is recommended to upgrade to the latest version (0.6.1 or later) or to remove this add-on before installing and using the A32NX. The older versions of this add-on are known to override A32NX components and to break the A32NX.', - }, - { - title: 'Horizon Simulations A321neo', - // packageVersion: '<0.4.0', see https://discord.com/channels/738864299392630914/785976111875751956/1055617417189011546 - description: - 'It is recommended to remove this add-on before installing and using the A32NX. This add-on is known to override A32NX components and cause unexpected behavior and issues when flying the A32NX.', - }, - { - title: 'LVFR A321neo FBW A32NX Compatibility Mod', - description: - 'It is recommended to remove this add-on before installing and using the A32NX. This add-on is known to override A32NX components and to break the A32NX.', - }, - { - title: 'LVFR A321neo Extreme', - description: - 'It is recommended to remove this add-on before installing and using the A32NX. This add-on is known to override A32NX components and cause unexpected behavior and issues when flying the A32NX.', - }, - { - title: 'lvfr-airbus-a319-fbw-standalone', - packageVersion: '<0.6.1', - description: - 'It is recommended to upgrade to the latest version (0.6.1 or later) or to remove this add-on before installing and using the A32NX. The older versions of this add-on are known to override A32NX components and to break the A32NX.', - }, - { - title: 'lvfr-airbus-a319-ceo-fbw-compatibility', - // creator: 'FlyByWire Simulations, karuchie', - // packageVersion: '<0.6.1', - description: - 'It is recommended to remove this add-on before installing and using the A32NX. This add-on is known to override A32NX components and cause unexpected behavior and issues when flying the A32NX.', - }, - { - title: '[MOD] Mugz FBW A32NX Dev', - description: - 'It is required to remove this add-on before installing and using the A32NX. This add-on overrides A32NX components and renders the A32NX unusable.', - }, - { - title: '[MOD] Mugz FBW A32NX Stable', - description: - 'It is required to remove this add-on before installing and using the A32NX. This add-on overrides A32NX components and renders the A32NX unusable.', - }, - { - title: 'Toolbar Pushback', - creator: 'AmbitiousPilots', - description: - 'This add-on sometimes causes performance issues and also sometimes prevents the A32NX from taxiing. Consider removing it if you experience these issues.', - }, - { - title: 'Asobo_A320_A (A32NX Converted)', - creator: 'UnitDeath', - description: - 'It is required to remove this livery before installing and using the A32NX as it breaks the A32NX', - }, - { - title: 'xeffect-320', - creator: 'swingbird', - // packageVersion: '<0.1.2', (the mod does provide accurate version info in manifest.json) - description: - 'It is recommended to remove this add-on before installing and using the A32NX. It is known known to override A32NX files and to break the A32NX.', - }, - { - title: 'z-Newlight-settinglight-FBW-A320NX-dev', - creator: 'Nicottine', - description: - 'It is required to remove this add-on before installing and using the A32NX. This add-on overrides A32NX components and renders the A32NX unusable.', - }, - { - title: 'z-Newlight-settinglight-FBW-A320NX-stable', - creator: 'Nicottine', - description: - 'It is required to remove this add-on before installing and using the A32NX. This add-on overrides A32NX components and renders the A32NX unusable.', - }, - { - title: 'z-Newlight-settinglight-FBW-A320NX-EXP', - creator: 'Nicottine', - description: - 'It is required to remove this add-on before installing and using the A32NX. This add-on overrides A32NX components and renders the A32NX unusable.', - }, - { - title: 'FBW A32NX Weather Radar Mod', - creator: '', - description: - 'It is required to remove this add-on before installing and using the A32NX. This add-on overrides A32NX components and may render the A32NX unusable.', - }, - { - title: 'China Eastern', - creator: 'JasonC68', - description: - 'It is recommended to remove this add-on before installing and using the A32NX. This add-on is known to override A32NX components and cause unexpected behavior and issues when flying the A32NX.', - }, ], myInstallPage: { links: [ { - url: 'https://docs.flybywiresim.com/fbw-a32nx/', + url: 'https://docs.flybywiresim.com/', title: 'Documentation', }, ], @@ -267,17 +165,104 @@ export const defaultConfiguration: Configuration = { repoName: 'aircraft', category: '@aircraft', aircraftName: 'A380-842', - titleImageUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fbw-a380x/dark.svg', - titleImageUrlSelected: - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fbw-a380x/light.svg', - enabled: false, - backgroundImageUrls: [ - 'https://nyc3.digitaloceanspaces.com/fselite/2020/11/123263426_126778999193686_7966913238295950901_o.png', - ], + titleImageUrl: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fbw-a380x/dark.svg', + titleImageUrlSelected: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fbw-a380x/light.svg', + enabled: true, + backgroundImageUrls: ['https://flybywirecdn.com/installer/media-assets/addon-headers/fbw-a380x/a380x.png'], shortDescription: 'Airbus A380-800', description: '', - targetDirectory: 'A380', - tracks: [], + techSpecs: [ + { + name: 'Engines', + value: 'RR Trent 972B-84', + }, + { + name: 'APU', + value: 'PW980', + }, + ], + targetDirectory: 'flybywire-aircraft-a380-842', + alternativeNames: ['A380X', 'a380x'], + tracks: [ + { + name: 'Stable (4K)', + key: 'a380x-stable-4k', + url: 'https://flybywirecdn.com/addons/a380x/stable-4k', + alternativeUrls: [], + description: + 'Includes our 4K downscaled cabin, cockpit and exterior textures. Choose this option for reduced ' + + 'stutters, better performance, with HIGH or lower texture resolution. Especially, if you intend to use the ' + + 'following:\n\n' + + '* Use frame generation \n\n' + + '* Virtual Reality (VR) \n\n' + + '* DX12 beta \n\n' + + '* or are otherwise limited by your graphics card VRAM amount. ' + + '[System Requirements](https://docs.flybywiresim.com/aircraft/install/installation/#estimated-system-requirements-for-a380x)', + isExperimental: false, + releaseModel: { + type: 'fragmenter', + }, + }, + { + name: 'Stable (8K)', + key: 'a380x-stable-8k', + url: 'https://flybywirecdn.com/addons/a380x/stable-8k', + alternativeUrls: [], + description: + 'Includes our 8K full resolution cabin, cockpit and exterior textures. This is the full fidelity ' + + 'experience and our recommendation if your system is powerful enough to support it. Realistic and in high ' + + 'detail.\n\n' + + '* DX11 recommended \n\n' + + '* HIGH or lower texture resolution setting recommended \n\n', + isExperimental: false, + releaseModel: { + type: 'fragmenter', + }, + }, + { + name: 'Development (4K)', + key: 'a380x-dev-4k', + url: 'https://flybywirecdn.com/addons/a380x/master-4k', + alternativeUrls: [], + description: + 'Development will have the latest features that will end up in the next stable. ' + + 'Although every change is QA-tested, bugs are a little more likely. It updates whenever something is added to ' + + "the 'master' branch on Github. Please visit our discord for support. \n\n" + + 'Includes our 4K downscaled cabin, cockpit and exterior textures. Choose this option for reduced ' + + 'stutters, better performance, with HIGH or lower texture resolution. Especially, if you intend to use the ' + + 'following:\n\n' + + '* Use frame generation \n\n' + + '* Virtual Reality (VR) \n\n' + + '* DX12 beta \n\n' + + '* or are otherwise limited by your graphics card VRAM amount. ', + isExperimental: false, + releaseModel: { + type: 'fragmenter', + }, + }, + { + name: 'Development (8K)', + key: 'a380x-dev-8k', + url: 'https://flybywirecdn.com/addons/a380x/master-8k', + alternativeUrls: [], + description: + 'Development will have the latest features that will end up in the next stable. ' + + 'Although every change is QA-tested, bugs are a little more likely. It updates whenever something is added to ' + + "the 'master' branch on Github. Please visit our discord for support. \n\n" + + '* DX11 recommended \n\n' + + '* HIGH or lower texture resolution setting recommended \n\n', + isExperimental: false, + releaseModel: { + type: 'fragmenter', + }, + }, + ], + incompatibleAddons: [ + // title: the exact title as it appears in the manifest.json + // creator: the exact creator as it appears in the manifest.json + // packageVersion syntax follows: https://www.npmjs.com/package/semver + // description: a short description of why the addon is incompatible + ], disallowedRunningExternalApps: ['@/msfs'], }, { @@ -287,10 +272,9 @@ export const defaultConfiguration: Configuration = { aircraftName: 'FBW Headquarters', enabled: true, overrideAddonWhileHidden: 'A380X', - backgroundImageUrls: ['https://flybywiresim.b-cdn.net/installer/media-assets/addon-headers/fbw-kfbw/0.png'], - titleImageUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fbw-kfbw/dark.svg', - titleImageUrlSelected: - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fbw-kfbw/light.svg', + backgroundImageUrls: ['https://flybywirecdn.com/installer/media-assets/addon-headers/fbw-kfbw/0.png'], + titleImageUrl: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fbw-kfbw/dark.svg', + titleImageUrlSelected: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fbw-kfbw/light.svg', shortDescription: 'FlyByWire Headquarters', description: 'Welcome to KFBW! \n\n' + @@ -306,6 +290,10 @@ export const defaultConfiguration: Configuration = { name: 'Release', key: 'kfbw-release', url: 'https://flybywirecdn.com/addons/kfbw/release/', + alternativeUrls: [ + // move Bunny CDN users to Cloudflare + 'https://cdn.flybywiresim.com/addons/kfbw/release/', + ], isExperimental: false, releaseModel: { type: 'CDN', @@ -322,17 +310,13 @@ export const defaultConfiguration: Configuration = { repoOwner: 'flybywiresim', repoName: 'simbridge', aircraftName: 'FBW SimBridge', - titleImageUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fbw-simbridge/dark.svg', - titleImageUrlSelected: - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fbw-simbridge/light.svg', + titleImageUrl: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fbw-simbridge/dark.svg', + titleImageUrlSelected: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fbw-simbridge/light.svg', enabled: true, - backgroundImageUrls: [ - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-headers/fbw-simbridge/0.png', - ], + backgroundImageUrls: ['https://flybywirecdn.com/installer/media-assets/addon-headers/fbw-simbridge/0.png'], backgroundImageShadow: false, shortDescription: 'Airbus A380-800', - description: - 'SimBridge is an external application which allows FBW aircraft to communicate with components located outside the simulator. SimBridge will be used for a number of features requiring external data (such as TAWS terrain display), as well as for functionality providing remote access to aircraft systems or data.', + description: `⚠ Important: Starting with version 0.6.0, custom resources such as PDF Charts and Company Routes must be stored in the Documents folder (typically located at \`C:\\Users\\\\Documents\\FlyByWireSim\\Simbridge\\resources)\`.
Please ensure you back up your files before updating. After the update, transfer your files to this new location to keep them safe from future updates. You can also use the Resources button in the About section of the installer to locate the folder. \n\nSimBridge is an external app that enables FlyByWire Simulations aircraft to communicate outside your simulator. From remote displays to external terrain display rendering, it is used for a variety of optional features.`, targetDirectory: 'flybywire-externaltools-simbridge', tracks: [ { @@ -342,8 +326,12 @@ export const defaultConfiguration: Configuration = { type: 'githubRelease', }, url: 'https://flybywirecdn.com/addons/simbridge/release/', + alternativeUrls: [ + // move Bunny CDN users to Cloudflare + 'https://cdn.flybywiresim.com/addons/simbridge/release/', + ], isExperimental: false, - description: `⚠ Note: Starting with version 0.6.0 custom resources like PDF Charts and Company Routes need to be located inside the Documents folder. Please refer to the documentation. \n\n SimBridge is an external app that enables FlyByWire Simulations aircraft to communicate outside your simulator. From remote displays to external terrain display rendering, it is used for a variety of optional features.`, + description: `⚠ Important: Starting with version 0.6.0, custom resources such as PDF Charts and Company Routes must be stored in the Documents folder (typically located at \`C:\\Users\\\\Documents\\FlyByWireSim\\Simbridge\\resources)\`.
Please ensure you back up your files before updating. After the update, transfer your files to this new location to keep them safe from future updates. You can also use the Resources button in the About section of the installer to locate the folder. \n\nSimBridge is an external app that enables FlyByWire Simulations aircraft to communicate outside your simulator. From remote displays to external terrain display rendering, it is used for a variety of optional features.`, }, ], disallowedRunningExternalApps: ['@/simbridge-app'], @@ -355,7 +343,7 @@ export const defaultConfiguration: Configuration = { myInstallPage: { links: [ { - url: 'https://docs.flybywiresim.com/simbridge/', + url: 'https://docs.flybywiresim.com/tools/simbridge/', title: 'Documentation', }, ], @@ -398,7 +386,7 @@ export const defaultConfiguration: Configuration = { { name: 'Salty Simulations', key: 'salty', - logoUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/publisher-icons/salty/0.svg', + logoUrl: 'https://flybywirecdn.com/installer/media-assets/publisher-icons/salty/0.svg', defs: [ { kind: 'addonCategory', @@ -414,9 +402,8 @@ export const defaultConfiguration: Configuration = { repoName: 'salty-747', category: '@aircraft', aircraftName: 'B747-8I', - titleImageUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/salty-74S/dark.svg', - titleImageUrlSelected: - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/salty-74S/light.svg', + titleImageUrl: 'https://flybywirecdn.com/installer/media-assets/addon-titles/salty-74S/dark.svg', + titleImageUrlSelected: 'https://flybywirecdn.com/installer/media-assets/addon-titles/salty-74S/light.svg', enabled: true, backgroundImageUrls: [ 'https://raw.githubusercontent.com/saltysimulations/branding/main/png/salty_banner.png', @@ -481,7 +468,7 @@ export const defaultConfiguration: Configuration = { { name: 'FSLTL', key: 'fsltl', - logoUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/publisher-icons/fsltl/fsltl-test-2.png', + logoUrl: 'https://flybywirecdn.com/installer/media-assets/publisher-icons/fsltl/0.png', logoSize: 36, defs: [ { @@ -506,14 +493,11 @@ export const defaultConfiguration: Configuration = { key: 'traffic-base-models', name: 'FSLTL Traffic', aircraftName: 'FSLTL Traffic', - titleImageUrl: - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fsltl/base-models/dark.svg', + titleImageUrl: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fsltl/base-models/dark.svg', titleImageUrlSelected: - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fsltl/base-models/light.svg', + 'https://flybywirecdn.com/installer/media-assets/addon-titles/fsltl/base-models/light.svg', enabled: true, - backgroundImageUrls: [ - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-headers/fsltl/traffic/0.png', - ], + backgroundImageUrls: ['https://flybywirecdn.com/installer/media-assets/addon-headers/fsltl/traffic/0.png'], shortDescription: 'FSLTL Traffic Base Models', description: 'FSLTL is a free standalone real-time online traffic overhaul and VATSIM model-matching solution for MSFS.\n\n' + @@ -542,13 +526,11 @@ export const defaultConfiguration: Configuration = { key: 'traffic-injector', name: 'FSLTL Injector', aircraftName: 'FSLTL Traffic', - titleImageUrl: 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fsltl/injector/dark.svg', + titleImageUrl: 'https://flybywirecdn.com/installer/media-assets/addon-titles/fsltl/injector/dark.svg', titleImageUrlSelected: - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-titles/fsltl/injector/light.svg', + 'https://flybywirecdn.com/installer/media-assets/addon-titles/fsltl/injector/light.svg', enabled: true, - backgroundImageUrls: [ - 'https://flybywiresim.b-cdn.net/installer/media-assets/addon-headers/fsltl/traffic/0.png', - ], + backgroundImageUrls: ['https://flybywirecdn.com/installer/media-assets/addon-headers/fsltl/traffic/0.png'], shortDescription: 'FSLTL Traffic Injector Software', description: 'FSLTL Live Traffic Injector - giving you a more immersive experience at airports globally!\n\n' + @@ -563,7 +545,7 @@ export const defaultConfiguration: Configuration = { url: 'https://github.com/FSLiveTrafficLiveries/FSLTL_Injector_Releases/releases/latest/download/', isExperimental: false, releaseModel: { - type: 'CDN', + type: 'fragmenter', }, description: 'Stable version of the FSLTL Traffic Injector for use on stable versions of MSFS.\n\n' + @@ -577,7 +559,7 @@ export const defaultConfiguration: Configuration = { warningContent: 'No support is offered for this release, it is a preview of features that may be included in future releases.', releaseModel: { - type: 'CDN', + type: 'fragmenter', }, description: 'Experimental Release that includes features that are not yet ready for stable release.\n\n' +