chore: update simbridge resources path in config (#40)

* chore: update simbridge resources path in config * test warning * revert change * Update config.ts * fix track description * fix colour * use colour directly * fix typo * fix: add legacy resources path * remove legacy folder again * fix description * format fix * fix spaces * update wording * fix syntax --------- Co-authored-by: Saschl <noreply@saschl.com>
flybywiresim · Oct 21, 2024 · 3d09c7b · 3d09c7b
1 parent 8957ee1
commit 3d09c7b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/config/config.ts b/config/config.ts
@@ -307,7 +307,7 @@ const config: Configuration = {
                     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: `<b><span style="color: rgb(255, 106, 0);">&#9888; 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 and use the provided links in the "About" section to backup your files.</span></b> \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.`,                    
                     targetDirectory: 'flybywire-externaltools-simbridge',
                     tracks: [
                         {
@@ -322,7 +322,7 @@ const config: Configuration = {
                                 'https://cdn.flybywiresim.com/addons/simbridge/release/',
                             ],
                             isExperimental: false,
-                            description: '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: `<b><span style="color: rgb(255, 106, 0);">&#9888; 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 and use the provided links in the "About" section to backup your files before updating.</span></b> \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.`,
                         },
                     ],
                     disallowedRunningExternalApps: ['@/simbridge-app'],
@@ -341,8 +341,8 @@ const config: Configuration = {
                         directories: [
                             {
                                 location: {
-                                    in: 'package',
-                                    path: 'resources',
+                                    in: 'documents',
+                                    path: 'FlyByWireSim/Simbridge/resources',
                                 },
                                 title: 'Resources',
                             },

diff --git a/lib.d.ts b/lib.d.ts
@@ -5,7 +5,7 @@ export interface ExternalLink {
 
 export interface DirectoryDefinition {
     location: {
-        in: 'community' | 'packageCache' | 'package',
+        in: 'community' | 'packageCache' | 'package' | 'documents',
         path: string,
     },
 }