Add stricter filtering for hardware MSUs

Author: MattEqualsCoder

MSURandomizer/Services/MsuListService.cs

@@ -77,8 +77,24 @@ public void FilterMSUs(MsuType msuType, MsuFilter msuFilter)
             userOptions.MsuUserOptions.DefaultMsuPath;
         var rootPath = Model.HardwareMode ? "" : GetMsuTypeBasePath(msuType);
         var useAbsolutePath = string.IsNullOrWhiteSpace(rootPath);
+        
+        // Hardware MSUs are more limited in compatibility
+        List<string>? compatibleMsuNames = null;
+        if (Model.HardwareMode)
+        {
+            if (appSettingsService.MsuAppSettings.HardwareCompatibleMsuTypes.TryGetValue(msuType.DisplayName,
+                    out compatibleMsuNames))
+            {
+                compatibleMsuNames.Add(msuType.DisplayName);
+            }
+            else
+            {
+                compatibleMsuNames = [msuType.DisplayName];
+            }
+        }
+        
         var filteredMsus = Model.MsuViewModels
-            .Where(x => x.Msu.MatchesFilter(msuFilter, msuType, msuTypePath) &&
+            .Where(x => x.Msu.MatchesFilter(msuFilter, msuType, msuTypePath, compatibleMsuNames) &&
                         (x.Msu.NumUniqueTracks > x.Msu.MsuType?.RequiredTrackNumbers.Count / 5 || x.Msu.NumUniqueTracks > 10))
             .OrderBy(x => x.MsuName)
             .ToList();

MSURandomizerLibrary/Configs/Msu.cs

@@ -182,9 +182,21 @@ public Msu(MsuType? type, string name, string folderName, string fileName, strin
     /// <param name="type">The MSU type being looked for</param>
     /// <param name="path">The path being looked at</param>
     /// <returns>True if matches, false otherwise</returns>
-    public bool MatchesFilter(MsuFilter filter, MsuType type, string? path)
+    public bool MatchesFilter(MsuFilter filter, MsuType type, string? path, List<string>? compatibleMsuTypeNames = null)
     {
-        return MatchesFilterType(filter, type) && MatchesPath(path) && Tracks.Count >= 1;
+        if (MatchesFilterType(filter, type) && MatchesPath(path) && Tracks.Count >= 1)
+        {
+            if (compatibleMsuTypeNames == null || filter == MsuFilter.All)
+            {
+                return true;
+            }
+
+            return compatibleMsuTypeNames.Contains(MsuTypeName);
+        }
+        else
+        {
+            return false;
+        }
     }
 
     private bool MatchesFilterType(MsuFilter filter, MsuType type)

MSURandomizerLibrary/Configs/MsuAppSettings.cs

@@ -100,6 +100,11 @@ public class MsuAppSettings
     /// </summary>
     public bool DisableMessageSender { get; set; }
 
+    /// <summary>
+    /// For hardware MSUs, the list of compatible MSU types
+    /// </summary>
+    public Dictionary<string, List<string>> HardwareCompatibleMsuTypes { get; set; } = [];
+
     /// <summary>
     /// Default directory for misc save data
     /// </summary>

MSURandomizerLibrary/settings.yaml

@@ -24,3 +24,8 @@ MsuWindowDisplayOptionsButton: true
 MsuWindowDisplaySelectButton: false
 ForcedMsuType:
 DisableMessageSender: false
+HardwareCompatibleMsuTypes:
+  A Link to the Past:
+    - SMZ3 Combo Randomizer
+  Super Metroid:
+    - SMZ3 Classic (Metroid First)