Add support for specifying multiple game installation registry lookup paths

Author: Rampastring

src/TSMapEditor/Constants.cs

@@ -30,7 +30,6 @@ public static class Constants
 
         public static string ExpectedClientExecutableName = "DTA.exe";
         public static string GameRegistryInstallPath = "SOFTWARE\\DawnOfTheTiberiumAge";
-        public static bool InstallPathAtHKLM = false;
         public static string OpenFileDialogFilter = "TS maps|*.map|All files|*.*";
 
         public static bool EnableIniInclude = false;
@@ -146,7 +145,6 @@ public static void Init()
 
             ExpectedClientExecutableName = constantsIni.GetStringValue(ConstantsSectionName, nameof(ExpectedClientExecutableName), ExpectedClientExecutableName);
             GameRegistryInstallPath = constantsIni.GetStringValue(ConstantsSectionName, nameof(GameRegistryInstallPath), GameRegistryInstallPath);
-            InstallPathAtHKLM = constantsIni.GetBooleanValue(ConstantsSectionName, nameof(InstallPathAtHKLM), InstallPathAtHKLM);
             OpenFileDialogFilter = constantsIni.GetStringValue(ConstantsSectionName, nameof(OpenFileDialogFilter), OpenFileDialogFilter);
 
             EnableIniInclude = constantsIni.GetBooleanValue(ConstantsSectionName, nameof(EnableIniInclude), EnableIniInclude);

src/TSMapEditor/UI/MainMenu.cs

@@ -259,33 +259,61 @@ private void CreateMapWindow_OnCreateNewMap(object sender, CreateNewMapEventArgs
 
         private void ReadGameInstallDirectoryFromRegistry()
         {
-            try
+            string[] pathsToLookup = Constants.GameRegistryInstallPath.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries);
+
+            if (pathsToLookup.Length == 0)
             {
-                RegistryKey key;
+                Logger.Log($"No valid paths specified in {nameof(Constants.GameRegistryInstallPath)}. Unable to read game installation path from Windows registry.");
+                return;
+            }
 
-                if (Constants.InstallPathAtHKLM)
-                {
-                    key = Registry.LocalMachine.OpenSubKey(Constants.GameRegistryInstallPath);
-                }
-                else
+            try
+            {
+                foreach (string registryInstallPath in pathsToLookup)
                 {
-                    key = Registry.CurrentUser.OpenSubKey(Constants.GameRegistryInstallPath);
-                }
+                    RegistryKey key;
 
-                object value = key.GetValue("InstallPath", string.Empty);
-                if (!(value is string valueAsString))
-                {
-                    tbGameDirectory.Text = string.Empty;
-                }
-                else
-                {
-                    if (File.Exists(valueAsString))
-                        tbGameDirectory.Text = Path.GetDirectoryName(valueAsString);
+                    const string hklmIdentifier = "HKLM:";
+
+                    // By default, try to find the key from the current user's registry.
+                    // Optionally, if the path starts with the HKLM identifier, look for the key in the local machine's registry instead.
+                    if (registryInstallPath.StartsWith(hklmIdentifier))
+                    {
+                        key = Registry.LocalMachine.OpenSubKey(registryInstallPath.Substring(hklmIdentifier.Length));
+                    }
                     else
-                        tbGameDirectory.Text = valueAsString;
-                }
+                    {
+                        key = Registry.CurrentUser.OpenSubKey(registryInstallPath);
+                    }
 
-                key.Close();
+                    bool isValid = false;
+
+                    object value = key.GetValue("InstallPath", string.Empty);
+                    if (!(value is string valueAsString))
+                    {
+                        tbGameDirectory.Text = string.Empty;
+                    }
+                    else
+                    {
+                        if (File.Exists(valueAsString))
+                        {
+                            tbGameDirectory.Text = Path.GetDirectoryName(valueAsString);
+                        }
+                        else
+                        {
+                            tbGameDirectory.Text = valueAsString;
+                        }
+
+                        if (File.Exists(Path.Combine(tbGameDirectory.Text, Constants.ExpectedClientExecutableName)))
+                            isValid = true;
+                    }
+
+                    key.Close();
+
+                    // Break when we find the first valid installation path
+                    if (isValid)
+                        break;
+                }
             }
             catch (Exception ex)
             {