feat: read config json from documents dir (#478)

* feat: read config json from home dir * fix * use documents folder * fix: use correct import * fix: resources shortcut * revert unwanted change * enable temporary warning text for simbridge * fix: allow backwards compatibility * fix typo * fix: enable html rendering on addon description * fix: use old simbridge configuration automatically if new one not present * fix lint * fix typo --------- Co-authored-by: Saschl <[email protected]>
flybywiresim · Oct 14, 2024 · bf58f63 · bf58f63
1 parent 775494d
commit bf58f63
Show file tree

Hide file tree

Showing 9 changed files with 594 additions and 12 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -137,6 +137,7 @@
     "react-router-dom": "^5.2.0",
     "react-windows-controls": "^1.1.1",
     "redux": "^4.0.5",
+    "rehype-raw": "^7.0.0",
     "remark-gfm": "^2.0.0",
     "semver": "7.3.5",
     "simplebar-react": "^3.2.4",

diff --git a/src/renderer/components/AddonSection/Configure/index.tsx b/src/renderer/components/AddonSection/Configure/index.tsx
@@ -6,6 +6,7 @@ import { Track, Tracks } from './TrackSelector';
 import { ConfigurationAspectDisplay } from 'renderer/components/AddonSection/Configure/ConfigurationAspectDisplay';
 
 import './index.css';
+import rehypeRaw from 'rehype-raw';
 
 export interface ConfigureProps {
   routeAspectKey: string;
@@ -76,6 +77,7 @@ export const Configure: FC<ConfigureProps> = ({
               <ReactMarkdown
                 className="font-manrope text-xl font-light leading-relaxed text-white"
                 linkTarget={'_blank'}
+                rehypePlugins={[rehypeRaw]}
               >
                 {selectedTrack.description}
               </ReactMarkdown>

diff --git a/src/renderer/components/AddonSection/MyInstall/index.tsx b/src/renderer/components/AddonSection/MyInstall/index.tsx
@@ -49,6 +49,15 @@ export const MyInstall: FC<MyInstallProps> = ({ addon }) => {
         return Directories.inInstallPackage(addon, def.location.path);
       case 'packageCache':
         return Directories.inPackageCache(addon, def.location.path);
+      case 'documents': {
+        const documents = Directories.inDocumentsFolder(def.location.path);
+        if (fs.existsSync(documents)) {
+          return documents;
+        }
+        // fallback for simbridge installations prior to 0.6
+        // remove after transition period
+        return Directories.inInstallPackage(addon, 'resources');
+      }
     }
   };
 

diff --git a/src/renderer/components/AddonSection/index.tsx b/src/renderer/components/AddonSection/index.tsx
@@ -24,6 +24,7 @@ import { InstallManager } from 'renderer/utils/InstallManager';
 import { StateSection } from 'renderer/components/AddonSection/StateSection';
 import { ExternalApps } from 'renderer/utils/ExternalApps';
 import { MyInstall } from 'renderer/components/AddonSection/MyInstall';
+import rehypeRaw from 'rehype-raw';
 
 const abortControllers = new Array<AbortController>(20);
 abortControllers.fill(new AbortController());
@@ -464,7 +465,11 @@ const About: FC<{ addon: Addon }> = ({ addon }) => (
 
       <h2 className="text-white">{addon.aircraftName}</h2>
     </div>
-    <ReactMarkdown className="font-manrope text-xl font-light leading-relaxed text-white" linkTarget={'_blank'}>
+    <ReactMarkdown
+      className="font-manrope text-xl font-light leading-relaxed text-white"
+      linkTarget={'_blank'}
+      rehypePlugins={[rehypeRaw]}
+    >
       {addon.description}
     </ReactMarkdown>
 

diff --git a/src/renderer/components/LocalApiConfigEditUI/index.tsx b/src/renderer/components/LocalApiConfigEditUI/index.tsx
@@ -4,10 +4,12 @@ import { PromptModal, useModals } from '../Modal';
 import { Button, ButtonType } from '../Button';
 import fs from 'fs';
 import path from 'path';
-import { Directories } from 'renderer/utils/Directories';
 import { Toggle } from '../Toggle';
+import { app } from '@electron/remote';
+import { Directories } from 'renderer/utils/Directories';
 
-const SIMBRIDGE_DIRECTORY = 'flybywire-externaltools-simbridge';
+const LEGACY_SIMBRIDGE_DIRECTORY = 'flybywire-externaltools-simbridge';
+const SIMBRIDGE_DIRECTORY = '/FlyByWireSim/Simbridge';
 
 interface LocalApiConfiguration {
   server: {
@@ -36,12 +38,21 @@ const localApiDefaultConfiguration: LocalApiConfiguration = {
 };
 
 class LocalApiConfigurationHandler {
+  private static get legacySimbridgeDirectory(): string {
+    return path.join(Directories.inInstallLocation(LEGACY_SIMBRIDGE_DIRECTORY));
+  }
+
   private static get simbridgeDirectory(): string {
-    return path.join(Directories.inInstallLocation(SIMBRIDGE_DIRECTORY));
+    return path.join(app.getPath('documents'), SIMBRIDGE_DIRECTORY);
   }
 
   private static get simbridgeConfigPath(): string {
-    return path.join(this.simbridgeDirectory, 'resources', 'properties.json');
+    const configPath = path.join(this.simbridgeDirectory, 'resources', 'properties.json');
+    if (fs.existsSync(configPath)) {
+      return configPath;
+    }
+    // TODO remove this after a while once simbridge is released
+    return path.join(this.legacySimbridgeDirectory, 'resources', 'properties.json');
   }
 
   static getConfiguration(): LocalApiConfiguration {

diff --git a/src/renderer/data.ts b/src/renderer/data.ts
@@ -343,8 +343,7 @@ export const defaultConfiguration: Configuration = {
               },
               url: '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 class="text-utility-amber">&#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.</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'],
@@ -363,8 +362,8 @@ export const defaultConfiguration: Configuration = {
             directories: [
               {
                 location: {
-                  in: 'package',
-                  path: 'resources',
+                  in: 'documents',
+                  path: 'FlyByWireSim/Simbridge/resources',
                 },
                 title: 'Resources',
               },

diff --git a/src/renderer/utils/Directories.ts b/src/renderer/utils/Directories.ts
@@ -141,4 +141,8 @@ export class Directories {
       return false;
     }
   }
+
+  static inDocumentsFolder(targetDir: string): string {
+    return path.join(app.getPath('documents'), this.sanitize(targetDir));
+  }
 }
diff --git a/src/renderer/utils/InstallerConfiguration.ts b/src/renderer/utils/InstallerConfiguration.ts
@@ -8,7 +8,7 @@ export interface ExternalLink {
 
 export interface DirectoryDefinition {
   location: {
-    in: 'community' | 'packageCache' | 'package';
+    in: 'community' | 'packageCache' | 'package' | 'documents';
     path: string;
   };
 }