feat: multi-sim support (#512)

* feat: add new per-sim setting variables

* feat: msfs2024 base path detection

* feat: wip managed sim selector

* feat: managedSimSelector switches variable

* feat: some fancy styling

* refactor: make prettier happy

* feat: only switch between enabled sims

* refactor: some code optimization

* refactor: more type safety

* refactor: even safer

* feat: restrict enabling and disabling simulators & autoswitch

* refactor: shorten function name

* feat: filter addons by simulator

* fix: select first available addon when switching sim

* feat: wip directory handling

* fix: error handling

* fix: error handling

* refactor: move initial msfs path setup functions to install path utils

* fix: temp handling

* refactor: simplify base path handling

* refactor: remove unused function

* refactor: safer code

* feat: indent temp path setting

* fix: remove unexpected temp location behavior

* fix: error handling of uninstalled simulators

* feat: handling of no installed simulator

* feat: use OS Temp as default temp directory

* fix: mistakes

* feat: temp location error handling

* fix: missing arguments

* refactor: remove unnecessary check

* refactor: remove import

* fix: missing arguments

* fix: handle no previously selected simulator

* fix: standardize error modal buttons

* fix: MSFS2024 SU2 changes to UserCfg.opt

* refactor: use cn to combine twMerge with clsx

* refactor: explicitly type possibleBasePaths

* refactor: acceptance of raw strings for Simulator type no longer required

* Revert "refactor: acceptance of raw strings for Simulator type no longer required"

This reverts commit 22e07e1.

* refactor: double import

* feat: use null instead of C:\ for nonexitent path

* fix: unintentional import

* refactor: ErrorModal

* refactor: ErrorModal pt.2

* fix: regex match keys that include a hyphen

* feat(local config): add A380X and SimBridge for MSFS2024

* docs: add changelog

Author: FoxtrotSierra6829

.github/CHANGELOG.yaml

@@ -9,8 +9,11 @@
 
 
 releases:
-  - name: 3.4.4
+  - name: 3.5.0
     changes:
+      - title: Add multi-simulator support (MSFS2020 and MSFS2024)
+        categories: [Core]
+        authors: [FoxtotSierra]
       - title: Added reload-button to developer configuration
         categories: [Core]
         authors: [Revyn112]
@@ -23,9 +26,6 @@ releases:
       - title: Reset-to-default button for developer configuration
         categories: [Core]
         authors: [Gaudv]
-      - title: fix move people to new installer config url
-        categories: [Core]
-        authors: [FoxtrotSierra]
   - name: 3.4.3
     changes:
       - title: Change installer configuration to Cloudflare

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "fbw-installer",
   "productName": "FlyByWire Installer",
-  "version": "3.4.3-dev.1",
+  "version": "3.5.0-dev.1",
   "description": "Desktop application to install and customize FlyByWire addons",
   "configUrls": {
     "production": "https://flybywirecdn.com/installer/config/production.json",
@@ -114,6 +114,7 @@
     "@types/winreg": "^1.2.31",
     "@types/ws": "^8.5.3",
     "check-disk-space": "^3.3.1",
+    "clsx": "^2.1.1",
     "config-ini-parser": "~1.5.9",
     "dateformat": "^5.0.1",
     "electron-store": "^8.0.1",

package.json

@@ -1,7 +1,76 @@
-import settings, { msStoreBasePath, steamBasePath } from 'renderer/rendererSettings';
+import * as fs from 'fs';
+import walk from 'walkdir';
+import * as path from 'path';
+import * as os from 'os';
+import settings from 'renderer/rendererSettings';
 import { Directories } from 'renderer/utils/Directories';
 import { dialog } from '@electron/remote';
-import fs from 'fs';
+import { managedSim, TypeOfSimulator } from 'renderer/utils/SimManager';
+
+const possibleBasePaths: Record<TypeOfSimulator, { store: string; steam: string }> = {
+  msfs2020: {
+    store: path.join(Directories.localAppData(), '\\Packages\\Microsoft.FlightSimulator_8wekyb3d8bbwe\\LocalCache\\'),
+    steam: path.join(Directories.appData(), '\\Microsoft Flight Simulator\\'),
+  },
+  msfs2024: {
+    store: path.join(Directories.localAppData(), '\\Packages\\Microsoft.Limitless_8wekyb3d8bbwe\\LocalCache\\'),
+    steam: path.join(Directories.appData(), '\\Microsoft Flight Simulator 2024\\'),
+  },
+};
+
+export const msfsBasePath = (sim: TypeOfSimulator): string | null => {
+  if (os.platform().toString() === 'linux') {
+    return null;
+  }
+
+  // Ensure proper functionality in main- and renderer-process
+  let msfsConfigPath = null;
+
+  const steamPath = path.join(possibleBasePaths[sim].steam, 'UserCfg.opt');
+  const storePath = path.join(possibleBasePaths[sim].store, 'UserCfg.opt');
+  if (fs.existsSync(steamPath) && fs.existsSync(storePath)) return null;
+  if (fs.existsSync(steamPath)) {
+    msfsConfigPath = steamPath;
+  } else if (fs.existsSync(storePath)) {
+    msfsConfigPath = storePath;
+  } else {
+    walk(Directories.localAppData(), (path) => {
+      if (path.includes('Flight') && path.includes('UserCfg.opt')) {
+        msfsConfigPath = path;
+      }
+    });
+  }
+
+  if (!msfsConfigPath) {
+    return null;
+  }
+
+  return path.dirname(msfsConfigPath);
+};
+
+export const defaultCommunityDir = (msfsBase: string | null): string | null => {
+  if (!msfsBase) {
+    return null;
+  }
+  const msfsConfigPath = path.join(msfsBase, 'UserCfg.opt');
+  if (!fs.existsSync(msfsConfigPath)) {
+    return null;
+  }
+
+  try {
+    const msfsConfig = fs.readFileSync(msfsConfigPath).toString();
+    const msfsConfigLines = msfsConfig.split(/\r?\n/);
+    // Intentional space after InstalledPackagesPath to ensure not matching the InstalledPackagesPathNextBoot property added in MSFS2024 SU2.
+    const packagesPathLine = msfsConfigLines.find((line) => line.includes('InstalledPackagesPath '));
+    const communityDir = path.join(packagesPathLine.split(' ').slice(1).join(' ').replaceAll('"', ''), '\\Community');
+
+    return fs.existsSync(communityDir) ? communityDir : null;
+  } catch (e) {
+    console.warn('Could not parse community dir from file', msfsConfigPath);
+    console.error(e);
+    return null;
+  }
+};
 
 const selectPath = async (currentPath: string, dialogTitle: string, setting: string): Promise<string> => {
   const path = await dialog.showOpenDialog({
@@ -18,14 +87,14 @@ const selectPath = async (currentPath: string, dialogTitle: string, setting: str
   }
 };
 
-export const setupMsfsBasePath = async (): Promise<string> => {
-  const currentPath = Directories.msfsBasePath();
+export const setupSimulatorBasePath = async (sim: TypeOfSimulator): Promise<string> => {
+  const currentPath = Directories.simulatorBasePath(sim);
 
   const availablePaths: string[] = [];
-  if (fs.existsSync(msStoreBasePath)) {
+  if (fs.existsSync(possibleBasePaths[sim].store)) {
     availablePaths.push('Microsoft Store Edition');
   }
-  if (fs.existsSync(steamBasePath)) {
+  if (fs.existsSync(possibleBasePaths[sim].steam)) {
     availablePaths.push('Steam Edition');
   }
 
@@ -34,41 +103,53 @@ export const setupMsfsBasePath = async (): Promise<string> => {
 
     const { response } = await dialog.showMessageBox({
       title: 'FlyByWire Installer',
-      message: 'We found a possible MSFS installation.',
+      message: `We found a possible MSFS ${sim.slice(-4)} installation.`,
       type: 'warning',
       buttons: availablePaths,
     });
 
     const selection = availablePaths[response];
     switch (selection) {
       case 'Microsoft Store Edition':
-        settings.set('mainSettings.msfsBasePath', msStoreBasePath);
-        return msStoreBasePath;
+        settings.set(`mainSettings.simulator.${sim}.basePath`, possibleBasePaths[sim].store);
+        return possibleBasePaths[sim].store;
       case 'Steam Edition':
-        settings.set('mainSettings.msfsBasePath', steamBasePath);
-        return steamBasePath;
+        settings.set(`mainSettings.simulator.${sim}.basePath`, possibleBasePaths[sim].steam);
+        return possibleBasePaths[sim].steam;
       case 'Custom Directory':
         break;
     }
   }
 
-  return await selectPath(currentPath, 'Select your MSFS base directory', 'mainSettings.msfsBasePath');
+  return await selectPath(
+    currentPath,
+    `Select your MSFS ${sim.slice(-4)} base directory`,
+    `mainSettings.simulator.${sim}.basePath`,
+  );
 };
 
-export const setupMsfsCommunityPath = async (): Promise<string> => {
-  const currentPath = Directories.installLocation();
+export const setupMsfsCommunityPath = async (sim: TypeOfSimulator): Promise<string> => {
+  const currentPath = Directories.installLocation(sim);
 
-  return await selectPath(currentPath, 'Select your MSFS community directory', 'mainSettings.msfsCommunityPath');
+  return await selectPath(
+    currentPath,
+    `Select your MSFS ${sim.slice(-4)} community directory`,
+    `mainSettings.simulator.${sim}.communityPath`,
+  );
 };
 
-export const setupInstallPath = async (): Promise<string> => {
-  const currentPath = Directories.installLocation();
+export const setupInstallPath = async (sim: TypeOfSimulator): Promise<string> => {
+  const currentPath = Directories.installLocation(sim);
 
-  return await selectPath(currentPath, 'Select your install directory', 'mainSettings.installPath');
+  return await selectPath(
+    currentPath,
+    `Select your MSFS ${sim.slice(-4)} install directory`,
+    `mainSettings.simulator.${sim}.installPath`,
+  );
 };
 
 export const setupTempLocation = async (): Promise<string> => {
-  const currentPath = Directories.tempLocation();
+  const currentPath = Directories.tempLocation(managedSim());
 
   return await selectPath(currentPath, 'Select a location for temporary folders', 'mainSettings.tempLocation');
 };

src/renderer/actions/install-path.utils.tsx

@@ -3,9 +3,8 @@ import { useSelector } from 'react-redux';
 import { InstallerStore } from 'renderer/redux/store';
 import { Check } from 'tabler-icons-react';
 import { Addon, AddonTrack } from 'renderer/utils/InstallerConfiguration';
-
+import cn from 'renderer/utils/cn';
 import '../index.css';
-import { twMerge } from 'tailwind-merge';
 
 export const Tracks: React.FC = ({ children }) => (
   <div className="flex flex-row items-stretch justify-start gap-3">{children}</div>
@@ -27,8 +26,8 @@ export const Track: React.FC<TrackProps> = ({ isSelected, isInstalled, handleSel
 
   return (
     <div
-      className={twMerge(
-        `flex w-60 h-24 cursor-pointer flex-col rounded-sm-md border-2 border-transparent bg-navy-dark text-white transition-all duration-200 hover:border-navy-lightest hover:text-gray-300`,
+      className={cn(
+        'flex w-60 h-24 cursor-pointer flex-col rounded-sm-md border-2 border-transparent bg-navy-dark text-white transition-all duration-200 hover:border-navy-lightest hover:text-gray-300',
         isSelected && 'border-2 border-cyan text-cyan',
       )}
       onClick={() => handleSelected(track)}

src/renderer/assets/msfs2020.png

@@ -44,7 +44,7 @@ export const MyInstall: FC<MyInstallProps> = ({ addon }) => {
   const fulldirectory = (def: DirectoryDefinition) => {
     switch (def.location.in) {
       case 'community':
-        return Directories.inInstallLocation(def.location.path);
+        return Directories.inInstallLocation(addon.simulator, def.location.path);
       case 'package':
         return Directories.inInstallPackage(addon, def.location.path);
       case 'packageCache':

src/renderer/assets/msfs2024.png

@@ -1,5 +1,4 @@
 import React, { FC, useCallback, useEffect, useState } from 'react';
-import { setupInstallPath } from 'renderer/actions/install-path.utils';
 import { DownloadItem } from 'renderer/redux/types';
 import { useSelector } from 'react-redux';
 import { InstallerStore, useAppDispatch, useAppSelector } from '../../redux/store';
@@ -25,6 +24,7 @@ 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';
+import { Simulators } from 'renderer/utils/SimManager';
 
 const abortControllers = new Array<AbortController>(20);
 abortControllers.fill(new AbortController());
@@ -70,6 +70,7 @@ export interface AircraftSectionURLParams {
 export const AddonSection = (): JSX.Element => {
   const dispatch = useAppDispatch();
   const history = useHistory();
+  const [managedSim] = useSetting<Simulators>('cache.main.managedSim');
 
   const { publisherName } = useParams<AircraftSectionURLParams>();
   const publisherData = useAppSelector((state) =>
@@ -108,7 +109,9 @@ export const AddonSection = (): JSX.Element => {
   }, [history, publisherData.addons, publisherName, selectedAddon]);
 
   useEffect(() => {
-    const firstAvailableAddon = publisherData.addons.find((addon) => addon.enabled);
+    const firstAvailableAddon = publisherData.addons
+      .filter((addon) => addon.simulator === managedSim)
+      .find((addon) => addon.enabled);
 
     if (!firstAvailableAddon) {
       history.push(`/addon-section/${publisherName}/no-available-addons`);
@@ -117,11 +120,13 @@ export const AddonSection = (): JSX.Element => {
 
     const lastSeenAddonKey = settings.get('cache.main.lastShownAddonKey');
     const addonToSelect =
-      publisherData.addons.find((addon) => addon.key === lastSeenAddonKey) ||
+      publisherData.addons
+        .filter((addon) => addon.simulator === managedSim)
+        .find((addon) => addon.key === lastSeenAddonKey) ||
       publisherData.addons.find((addon) => addon.key === firstAvailableAddon.key);
 
     setSelectedAddon(addonToSelect);
-  }, [history, publisherData.addons, publisherName]);
+  }, [history, publisherData.addons, publisherName, managedSim]);
 
   const installedTrack = (installedTracks[selectedAddon.key] as AddonTrack) ?? null;
 
@@ -227,11 +232,7 @@ export const AddonSection = (): JSX.Element => {
   };
 
   const handleInstall = async () => {
-    if (settings.has('mainSettings.installPath')) {
-      await InstallManager.installAddon(selectedAddon, publisherData, showModalAsync);
-    } else {
-      await setupInstallPath();
-    }
+    await InstallManager.installAddon(selectedAddon, publisherData, showModalAsync);
   };
 
   const handleCancel = useCallback(() => {
@@ -276,6 +277,7 @@ export const AddonSection = (): JSX.Element => {
           <AddonBar>
             <div className="flex flex-col gap-y-4">
               {publisherData.addons
+                .filter((it) => it.simulator === managedSim)
                 .filter((it) => !it.category)
                 .map((addon) => (
                   <AddonBarItem
@@ -296,9 +298,9 @@ export const AddonSection = (): JSX.Element => {
               {publisherData.defs
                 ?.filter((it) => it.kind === 'addonCategory')
                 .map((category: AddonCategoryDefinition) => {
-                  const categoryAddons = publisherData.addons.filter(
-                    (it) => it.category?.substring(1) === category.key,
-                  );
+                  const categoryAddons = publisherData.addons
+                    .filter((it) => it.simulator === managedSim)
+                    .filter((it) => it.category?.substring(1) === category.key);
 
                   if (categoryAddons.length === 0) {
                     return null;
@@ -315,6 +317,7 @@ export const AddonSection = (): JSX.Element => {
 
                       <div className="flex flex-col gap-y-4">
                         {publisherData.addons
+                          .filter((it) => it.simulator === managedSim)
                           .filter((it) => it.category?.substring(1) === category.key)
                           .map((addon) => (
                             <AddonBarItem