Release v1.1.0 compatibility fixes

Author: Hellfrosted

BetterModMenu.Tests/BetterModMenu.Tests.csproj

@@ -27,6 +27,7 @@
     <Compile Include="..\Data\ModNameStyleEditorRules.cs" Link="Data\ModNameStyleEditorRules.cs" />
     <Compile Include="..\Data\ModNameStyleRules.cs" Link="Data\ModNameStyleRules.cs" />
     <Compile Include="..\Data\ModInstallPathResolver.cs" Link="Data\ModInstallPathResolver.cs" />
+    <Compile Include="..\Data\ModAnnotationRules.cs" Link="Data\ModAnnotationRules.cs" />
     <Compile Include="..\Data\ModListExportBuilder.cs" Link="Data\ModListExportBuilder.cs" />
     <Compile Include="..\Data\ModSearchRules.cs" Link="Data\ModSearchRules.cs" />
     <Compile Include="..\Data\ModConfigProviderRules.cs" Link="Data\ModConfigProviderRules.cs" />

BetterModMenu.Tests/LogicTests.cs

@@ -264,6 +264,51 @@ public void Search_ProvidesLocalizationKeyForMatchReason()
         Assert.AreEqual("Matched author", results[0].MatchReason);
     }
 
+    [TestMethod]
+    public void Search_MatchesPersonalAliasAndNotes()
+    {
+        var documents = new[]
+        {
+            new ModSearchDocument("Example.Mod", "Example Mod")
+            {
+                Alias = "Daily run helper",
+                Notes = "Disable before multiplayer"
+            }
+        };
+
+        var aliasResults = ModSearchRules.Search(documents, "Daily run helper");
+        var noteResults = ModSearchRules.Search(documents, "multiplayer");
+
+        Assert.AreEqual(BmmText.SearchMatchAlias, aliasResults[0].MatchReasonKey);
+        Assert.AreEqual(BmmText.SearchMatchNotes, noteResults[0].MatchReasonKey);
+    }
+
+    [TestMethod]
+    public void ModAnnotations_NormalizeWhitespaceAndDiscardEmptyEntries()
+    {
+        var annotations = ModAnnotationRules.NormalizeDictionary(new Dictionary<string, ModAnnotation>
+        {
+            [" Example.Mod "] = new() { Alias = "  Helper  ", Notes = "line one\r\nline two  " },
+            ["Empty.Mod"] = new()
+        });
+
+        Assert.AreEqual(1, annotations.Count);
+        Assert.AreEqual("Helper", annotations["Example.Mod"].Alias);
+        Assert.AreEqual("line one\nline two", annotations["Example.Mod"].Notes);
+    }
+
+    [TestMethod]
+    public void ModAnnotations_LoadNormalizationPreservesFutureOrManuallyEditedLengths()
+    {
+        string longNotes = new('x', ModAnnotationRules.MaxNotesLength + 1);
+        var annotations = ModAnnotationRules.NormalizeDictionary(new Dictionary<string, ModAnnotation>
+        {
+            ["Example.Mod"] = new() { Notes = longNotes }
+        });
+
+        Assert.AreEqual(longNotes, annotations["Example.Mod"].Notes);
+    }
+
     [TestMethod]
     public void Search_ToleratesTyposAndLookalikesForLongQueries()
     {
@@ -509,6 +554,14 @@ public void GetTopBarPresentation_UsesIconOnlyActions()
         Assert.AreEqual(ModdingScreenConstants.TopBarButtonCompactWidth, wide.ButtonWidth);
     }
 
+    [TestMethod]
+    public void ShouldStackTopBar_UsesAvailableLocalizedTitleSpace()
+    {
+        Assert.IsTrue(ModdingScreenLayoutRules.ShouldStackTopBar(0f, 275f));
+        Assert.IsTrue(ModdingScreenLayoutRules.ShouldStackTopBar(274f, 275f));
+        Assert.IsFalse(ModdingScreenLayoutRules.ShouldStackTopBar(275f, 275f));
+    }
+
     [TestMethod]
     public void ShouldShowRowMoveButtons_PreservesGroupPickerOnNarrowRows()
     {
@@ -775,7 +828,11 @@ public void ProfileSaveStorage_RoundTripsCurrentSaveData()
                 CurrentProfileIndex = 0,
                 CustomGroups = new List<string> { "Bosses" },
                 ModGroups = new Dictionary<string, string> { ["mod-a"] = "Bosses" },
-                CollapsedGroups = new HashSet<string> { "Bosses" }
+                CollapsedGroups = new HashSet<string> { "Bosses" },
+                ModAnnotations = new Dictionary<string, ModAnnotation>
+                {
+                    ["mod-a"] = new() { Alias = "My boss mod", Notes = "Load after BaseLib" }
+                }
             };
 
             bool wrote = ProfileSaveStorage.TryWrite(savePath, saveData, _ => { }, out string? error);
@@ -787,6 +844,8 @@ public void ProfileSaveStorage_RoundTripsCurrentSaveData()
             Assert.AreEqual("Bosses", loaded.CustomGroups[0]);
             Assert.AreEqual("Bosses", loaded.ModGroups["mod-a"]);
             Assert.IsTrue(loaded.CollapsedGroups.Contains("Bosses"));
+            Assert.AreEqual("My boss mod", loaded.ModAnnotations["mod-a"].Alias);
+            Assert.AreEqual("Load after BaseLib", loaded.ModAnnotations["mod-a"].Notes);
         }
         finally
         {
@@ -1020,8 +1079,8 @@ public void BuildCsv_EscapesExcelFriendlyModExportRows()
         });
 
         string expected = string.Join(Environment.NewLine,
-            "Mod Id,Name,Version,Enabled,Group,Workshop Link",
-            "Example.Mod,\"Example, Mod\",1.2.3,TRUE,\"QoL \"\"Core\"\"\",",
+            "Mod Id,Name,Version,Enabled,Group,Workshop Link,Alias,Notes",
+            "Example.Mod,\"Example, Mod\",1.2.3,TRUE,\"QoL \"\"Core\"\"\",,,",
             string.Empty);
 
         Assert.AreEqual(expected, csv);
@@ -1084,7 +1143,11 @@ public void BuildRows_UsesManifestInfoAndAssignedGroups()
                     }
                 },
                 new Dictionary<string, string> { ["Example.Mod"] = "Core" },
-                "Unassigned");
+                "Unassigned",
+                new Dictionary<string, ModAnnotation>
+                {
+                    ["Example.Mod"] = new() { Alias = "My helper", Notes = "Keep enabled" }
+                });
 
             Assert.AreEqual(1, rows.Count);
             Assert.AreEqual("Example.Mod", rows[0].ModId);
@@ -1093,6 +1156,8 @@ public void BuildRows_UsesManifestInfoAndAssignedGroups()
             Assert.IsFalse(rows[0].Enabled);
             Assert.AreEqual("Core", rows[0].Group);
             Assert.AreEqual("https://steamcommunity.com/sharedfiles/filedetails/?id=3456789012", rows[0].WorkshopUrl);
+            Assert.AreEqual("My helper", rows[0].Alias);
+            Assert.AreEqual("Keep enabled", rows[0].Notes);
         }
         finally
         {

BetterModMenu.Tests/ModListExportSecurityTests.cs

@@ -38,8 +38,8 @@ public void BuildCsv_NeutralizesFormulaPrefixes_when_ManifestAndGroupValuesStart
             string csv = ModListExportBuilder.BuildCsv(rows);
 
             string expected = string.Join(Environment.NewLine,
-                "Mod Id,Name,Version,Enabled,Group,Workshop Link",
-                "Formula.Mod,\"'=HYPERLINK(\"\"https://example.invalid\"\")\",'+1.2.3,TRUE,'-Injected Group,",
+                "Mod Id,Name,Version,Enabled,Group,Workshop Link,Alias,Notes",
+                "Formula.Mod,\"'=HYPERLINK(\"\"https://example.invalid\"\")\",'+1.2.3,TRUE,'-Injected Group,,,",
                 string.Empty);
             Assert.AreEqual(expected, csv);
         }
@@ -61,13 +61,15 @@ public void BuildCsv_NeutralizesFormulaPrefixes_when_RawExportRowsStartWithContr
                 Version = "1.0.0",
                 Enabled = false,
                 Group = "Safe Group",
-                WorkshopUrl = "=HYPERLINK(\"https://example.invalid\")"
+                WorkshopUrl = "=HYPERLINK(\"https://example.invalid\")",
+                Alias = "+Alias",
+                Notes = "=cmd|'/C calc'!A0\nsecond line"
             }
         });
 
         string expected = string.Join(Environment.NewLine,
-            "Mod Id,Name,Version,Enabled,Group,Workshop Link",
-            "'\tTabbed.Mod,\"'\rCarriage Mod\",1.0.0,FALSE,Safe Group,\"'=HYPERLINK(\"\"https://example.invalid\"\")\"",
+            "Mod Id,Name,Version,Enabled,Group,Workshop Link,Alias,Notes",
+            "'\tTabbed.Mod,\"'\rCarriage Mod\",1.0.0,FALSE,Safe Group,\"'=HYPERLINK(\"\"https://example.invalid\"\")\",'+Alias,\"'=cmd|'/C calc'!A0\nsecond line\"",
             string.Empty);
         Assert.AreEqual(expected, csv);
     }

BetterModMenu.json

@@ -3,7 +3,7 @@
   "name": "Better Mod Menu",
   "author": "Crunch",
   "description": "Adds profile and grouping functionality to the Slay the Spire 2 mod manager.",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "min_game_version": "0.107.1",
   "has_pck": false,
   "has_dll": true,

Data/Localization.cs

@@ -56,6 +56,8 @@ internal static class BmmText
     public const string DetailSearchMatchTooltip = "DETAIL.SEARCH_MATCH.TOOLTIP";
     public const string DetailGameplayBadge = "DETAIL.GAMEPLAY.BADGE";
     public const string DetailNoMatchingMods = "DETAIL.NO_MATCHING_MODS";
+    public const string DetailAnnotation = "DETAIL.ANNOTATION";
+    public const string DetailAnnotationTooltip = "DETAIL.ANNOTATION.TOOLTIP";
     public const string SearchMatchModId = "SEARCH.MATCH.MOD_ID";
     public const string SearchMatchModName = "SEARCH.MATCH.MOD_NAME";
     public const string SearchMatchAuthor = "SEARCH.MATCH.AUTHOR";
@@ -66,6 +68,8 @@ internal static class BmmText
     public const string SearchMatchWorkshopLink = "SEARCH.MATCH.WORKSHOP_LINK";
     public const string SearchMatchDescription = "SEARCH.MATCH.DESCRIPTION";
     public const string SearchMatchDependency = "SEARCH.MATCH.DEPENDENCY";
+    public const string SearchMatchAlias = "SEARCH.MATCH.ALIAS";
+    public const string SearchMatchNotes = "SEARCH.MATCH.NOTES";
     public const string DialogLoadBackupTitle = "DIALOG.LOAD_BACKUP.TITLE";
     public const string DialogLoadBackupBody = "DIALOG.LOAD_BACKUP.BODY";
     public const string DialogLoadBackupBodyManyFormat = "DIALOG.LOAD_BACKUP.BODY_MANY_FORMAT";
@@ -76,6 +80,14 @@ internal static class BmmText
     public const string DialogRenameGroupHelp = "DIALOG.RENAME_GROUP.HELP";
     public const string DialogRenameProfileTitle = "DIALOG.RENAME_PROFILE.TITLE";
     public const string DialogRenameProfileHelp = "DIALOG.RENAME_PROFILE.HELP";
+    public const string DialogAnnotationTitleFormat = "DIALOG.ANNOTATION.TITLE_FORMAT";
+    public const string DialogAnnotationAlias = "DIALOG.ANNOTATION.ALIAS";
+    public const string DialogAnnotationAliasPlaceholder = "DIALOG.ANNOTATION.ALIAS_PLACEHOLDER";
+    public const string DialogAnnotationNotes = "DIALOG.ANNOTATION.NOTES";
+    public const string DialogAnnotationNotesPlaceholder = "DIALOG.ANNOTATION.NOTES_PLACEHOLDER";
+    public const string DialogAnnotationHelp = "DIALOG.ANNOTATION.HELP";
+    public const string AnnotationSaveFailedTitle = "ANNOTATION.SAVE_FAILED.TITLE";
+    public const string AnnotationSaveFailedMessageFormat = "ANNOTATION.SAVE_FAILED.MESSAGE_FORMAT";
     public const string DialogCloudFolderTitle = "DIALOG.CLOUD_FOLDER.TITLE";
     public const string DialogCloudFolderHelp = "DIALOG.CLOUD_FOLDER.HELP";
     public const string LogCopyAll = "LOG.COPY_ALL";

Data/ModAnnotationRules.cs

@@ -0,0 +1,61 @@
+namespace BetterModMenu.Data;
+
+internal static class ModAnnotationRules
+{
+    public const int MaxAliasLength = 120;
+    public const int MaxNotesLength = 4000;
+
+    public static bool TryNormalize(string? alias, string? notes, out ModAnnotation annotation, out string? error)
+    {
+        string normalizedAlias = (alias ?? string.Empty).Trim();
+        string normalizedNotes = (notes ?? string.Empty)
+            .Replace("\r\n", "\n", StringComparison.Ordinal)
+            .Replace('\r', '\n')
+            .Trim();
+
+        if (normalizedAlias.Length > MaxAliasLength)
+        {
+            annotation = new ModAnnotation();
+            error = $"Alias must be {MaxAliasLength} characters or fewer.";
+            return false;
+        }
+
+        if (normalizedNotes.Length > MaxNotesLength)
+        {
+            annotation = new ModAnnotation();
+            error = $"Notes must be {MaxNotesLength} characters or fewer.";
+            return false;
+        }
+
+        annotation = new ModAnnotation { Alias = normalizedAlias, Notes = normalizedNotes };
+        error = null;
+        return true;
+    }
+
+    public static Dictionary<string, ModAnnotation> NormalizeDictionary(Dictionary<string, ModAnnotation>? annotations)
+    {
+        var normalized = new Dictionary<string, ModAnnotation>(StringComparer.Ordinal);
+        if (annotations == null)
+            return normalized;
+
+        foreach ((string modId, ModAnnotation? annotation) in annotations)
+        {
+            if (string.IsNullOrWhiteSpace(modId) || annotation == null)
+                continue;
+
+            var value = new ModAnnotation
+            {
+                Alias = (annotation.Alias ?? string.Empty).Trim(),
+                Notes = (annotation.Notes ?? string.Empty)
+                    .Replace("\r\n", "\n", StringComparison.Ordinal)
+                    .Replace('\r', '\n')
+                    .Trim()
+            };
+
+            if (!string.IsNullOrEmpty(value.Alias) || !string.IsNullOrEmpty(value.Notes))
+                normalized[modId.Trim()] = value;
+        }
+
+        return normalized;
+    }
+}

Data/ModListExportBuilder.cs

@@ -18,21 +18,24 @@ internal sealed class ModListExportRow
     public bool Enabled { get; init; }
     public string Group { get; init; } = string.Empty;
     public string WorkshopUrl { get; init; } = string.Empty;
+    public string Alias { get; init; } = string.Empty;
+    public string Notes { get; init; } = string.Empty;
 }
 
 internal static class ModListExportBuilder
 {
     public const string ErrorNoExportDirectory = "No export directory was provided.";
 
-    private static readonly string[] Header = ["Mod Id", "Name", "Version", "Enabled", "Group", "Workshop Link"];
+    private static readonly string[] Header = ["Mod Id", "Name", "Version", "Enabled", "Group", "Workshop Link", "Alias", "Notes"];
 
     public static List<ModListExportRow> BuildRows(
         IEnumerable<InstalledModExportInput> mods,
         IReadOnlyDictionary<string, string> assignedGroups,
-        string unassignedGroup)
+        string unassignedGroup,
+        IReadOnlyDictionary<string, ModAnnotation>? annotations = null)
     {
         return mods
-            .Select(mod => BuildRow(mod, assignedGroups, unassignedGroup))
+            .Select(mod => BuildRow(mod, assignedGroups, unassignedGroup, annotations))
             .OrderBy(row => row.Group, StringComparer.OrdinalIgnoreCase)
             .ThenBy(row => string.IsNullOrWhiteSpace(row.Name) ? row.ModId : row.Name, StringComparer.OrdinalIgnoreCase)
             .ToList();
@@ -51,7 +54,9 @@ public static string BuildCsv(IEnumerable<ModListExportRow> rows)
                 row.Version,
                 row.Enabled ? "TRUE" : "FALSE",
                 row.Group,
-                row.WorkshopUrl);
+                row.WorkshopUrl,
+                row.Alias,
+                row.Notes);
         }
 
         return builder.ToString();
@@ -88,13 +93,17 @@ public static string BuildExportFileName(DateTimeOffset timestamp)
     private static ModListExportRow BuildRow(
         InstalledModExportInput mod,
         IReadOnlyDictionary<string, string> assignedGroups,
-        string unassignedGroup)
+        string unassignedGroup,
+        IReadOnlyDictionary<string, ModAnnotation>? annotations)
     {
         ModManifestInfo manifestInfo = new();
         if (!string.IsNullOrWhiteSpace(mod.ManifestPath) && File.Exists(mod.ManifestPath))
             ManifestScanner.TryReadManifestInfo(mod.ManifestPath, mod.ModId, out manifestInfo);
 
         string modId = string.IsNullOrWhiteSpace(manifestInfo.Id) ? mod.ModId : manifestInfo.Id;
+        ModAnnotation annotation = annotations != null && annotations.TryGetValue(modId, out ModAnnotation? value)
+            ? value
+            : new ModAnnotation();
         return new ModListExportRow
         {
             ModId = modId,
@@ -104,7 +113,9 @@ private static ModListExportRow BuildRow(
             Group = assignedGroups.TryGetValue(modId, out string? group) && !string.IsNullOrWhiteSpace(group)
                 ? group
                 : unassignedGroup,
-            WorkshopUrl = mod.WorkshopUrl
+            WorkshopUrl = mod.WorkshopUrl,
+            Alias = annotation.Alias,
+            Notes = annotation.Notes
         };
     }
 

Data/ModSearchRules.cs

@@ -9,6 +9,8 @@ internal sealed class ModSearchDocument(string modId, string name)
     public string Name { get; } = name;
     public string Author { get; init; } = string.Empty;
     public string Description { get; init; } = string.Empty;
+    public string Alias { get; init; } = string.Empty;
+    public string Notes { get; init; } = string.Empty;
     public string Version { get; init; } = string.Empty;
     public IReadOnlyList<string> Dependencies { get; init; } = Array.Empty<string>();
     public string Group { get; init; } = string.Empty;
@@ -99,13 +101,15 @@ private static IReadOnlyList<SearchField> BuildFields(ModSearchDocument document
         {
             new("id", document.ModId, ExactIdOrNameScore, PrefixIdOrNameScore, FuzzyIdScore, IncludeContainsForShortQuery: true),
             new("name", document.Name, ExactIdOrNameScore, PrefixIdOrNameScore, FuzzyNameScore, IncludeContainsForShortQuery: true),
+            new("alias", document.Alias, ExactIdOrNameScore, PrefixIdOrNameScore, FuzzyNameScore, IncludeContainsForShortQuery: true),
             new("author", document.Author, MetadataScore, MetadataScore - 40, MetadataScore - 90, IncludeContainsForShortQuery: false),
             new("version", document.Version, MetadataScore, MetadataScore - 40, 0, IncludeContainsForShortQuery: false),
             new("group", document.Group, MetadataScore, MetadataScore - 40, MetadataScore - 120, IncludeContainsForShortQuery: false),
             new("state", document.Enabled ? "enabled" : "disabled", MetadataScore, MetadataScore - 40, 0, IncludeContainsForShortQuery: false),
             new("Steam Workshop id", document.WorkshopId, WorkshopScore, WorkshopScore - 40, 0, IncludeContainsForShortQuery: true),
             new("Steam Workshop link", document.WorkshopUrl, WorkshopScore - 80, WorkshopScore - 100, 0, IncludeContainsForShortQuery: true),
-            new("description", document.Description, DescriptionScore, DescriptionScore - 40, DescriptionScore - 80, IncludeContainsForShortQuery: false)
+            new("description", document.Description, DescriptionScore, DescriptionScore - 40, DescriptionScore - 80, IncludeContainsForShortQuery: false),
+            new("notes", document.Notes, DescriptionScore, DescriptionScore - 40, DescriptionScore - 80, IncludeContainsForShortQuery: false)
         };
 
         foreach (string dependency in document.Dependencies)
@@ -225,13 +229,15 @@ private static SearchReason BuildReason(SearchField field)
         {
             "id" => new SearchReason(BmmText.SearchMatchModId, "Matched mod id"),
             "name" => new SearchReason(BmmText.SearchMatchModName, "Matched mod name"),
+            "alias" => new SearchReason(BmmText.SearchMatchAlias, "Matched alias"),
             "author" => new SearchReason(BmmText.SearchMatchAuthor, "Matched author"),
             "version" => new SearchReason(BmmText.SearchMatchVersion, "Matched version"),
             "group" => new SearchReason(BmmText.SearchMatchGroup, "Matched group"),
             "state" => new SearchReason(BmmText.SearchMatchState, "Matched state"),
             "Steam Workshop id" => new SearchReason(BmmText.SearchMatchWorkshopId, "Matched Steam Workshop id"),
             "Steam Workshop link" => new SearchReason(BmmText.SearchMatchWorkshopLink, "Matched Steam Workshop link"),
             "description" => new SearchReason(BmmText.SearchMatchDescription, "Matched description"),
+            "notes" => new SearchReason(BmmText.SearchMatchNotes, "Matched notes"),
             "dependency" => new SearchReason(BmmText.SearchMatchDependency, "Matched dependency"),
             _ => new SearchReason(string.Empty, "Matched " + field.Name)
         };