Merge branch 'develop' into stable

Author: Pathoschild

build/common.targets

@@ -7,7 +7,7 @@ repo. It imports the other MSBuild files as needed.
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <!--set general build properties -->
-    <Version>4.1.10</Version>
+    <Version>4.2.0</Version>
     <Product>SMAPI</Product>
     <LangVersion>latest</LangVersion>
     <AssemblySearchPaths>$(AssemblySearchPaths);{GAC}</AssemblySearchPaths>

docs/release-notes.md

@@ -1,6 +1,32 @@
 ← [README](README.md)
 
 # Release notes
+## 4.2.0
+Released 24 March 2025 for Stardew Valley 1.6.14 or later. See [release highlights](https://www.patreon.com/posts/125017679).
+
+* For players:
+  * Fixed `log_context` command not disabling the extra logs when run again.
+  * Fixed update alerts when using an unofficial port of SMAPI with a four-part version number.
+  * Fixed installer on Linux not always opening a terminal as intended (thanks to HoodedDeath!).
+  * Updated compatibility list.
+
+* For mod authors:
+  * Mod events are now raised on the shipping menu (except when it's actually saving).
+  * Added translation API methods to query translation keys (`ContainsKey` and `GetKeys`).
+  * Fixed the game's `Data/ChairTiles` logic not handling unique string IDs like `Maps/Author.ModName` correctly.
+  * Fixed exception thrown if `modRegistry.GetApi<T>` can't proxy the API to the given interface. It now logs an error and returns null as intended.
+
+* For external tools:
+  * Added toolkit method to read the compatibility list from a local copy of its Git repo.
+
+* For the web UI:
+  * You can now link to a mod in the compatibility list by its unique ID, like [smapi.io/mods#Pathoschild.ContentPatcher](https://smapi.io/mods#Pathoschild.ContentPatcher).
+  * Fixed search engines able to index uploaded logs and JSON files via the raw download option.
+  * Improved Content Patcher JSON schema:
+    * Updated for Content Patcher 2.5.0.
+    * Added format validation for token names.
+    * Fixed incorrect error when setting a config default to a boolean or number.
+
 ## 4.1.10
 Released 18 December 2024 for Stardew Valley 1.6.14 or later.
 

src/SMAPI.Installer/InteractiveInstaller.cs

@@ -27,10 +27,7 @@ internal class InteractiveInstaller
     private readonly string BundlePath;
 
     /// <summary>The mod IDs which the installer should allow as bundled mods.</summary>
-    private readonly string[] BundledModIDs = {
-        "SMAPI.SaveBackup",
-        "SMAPI.ConsoleCommands"
-    };
+    private readonly string[] BundledModIds = ["SMAPI.SaveBackup", "SMAPI.ConsoleCommands"];
 
     /// <summary>Get the absolute file or folder paths to remove when uninstalling SMAPI.</summary>
     /// <param name="installDir">The folder for Stardew Valley and SMAPI.</param>
@@ -207,7 +204,7 @@ public void Run(string[] args)
             Console.WriteLine();
 
             // handle choice
-            string choice = this.InteractivelyChoose("Type 1 or 2, then press enter.", new[] { "1", "2" }, printLine: Console.WriteLine);
+            string choice = this.InteractivelyChoose("Type 1 or 2, then press enter.", ["1", "2"], printLine: Console.WriteLine);
             switch (choice)
             {
                 case "1":
@@ -298,7 +295,7 @@ public void Run(string[] args)
                 this.PrintInfo("[2] Uninstall SMAPI.");
                 Console.WriteLine();
 
-                string choice = this.InteractivelyChoose("Type 1 or 2, then press enter.", new[] { "1", "2" });
+                string choice = this.InteractivelyChoose("Type 1 or 2, then press enter.", ["1", "2"]);
                 switch (choice)
                 {
                     case "1":
@@ -447,7 +444,7 @@ public void Run(string[] args)
                             this.PrintWarning($"   ignored invalid bundled mod {sourceMod.DisplayName}: {sourceMod.ManifestParseError}");
                             continue;
                         }
-                        if (!this.BundledModIDs.Contains(sourceMod.Manifest.UniqueID))
+                        if (!this.BundledModIds.Contains(sourceMod.Manifest.UniqueID))
                         {
                             this.PrintWarning($"   ignored unknown '{sourceMod.DisplayName}' mod in the installer folder. To add mods, put them here instead: {paths.ModsPath}");
                             continue;
@@ -709,7 +706,7 @@ private string InteractivelyChoose(string message, string[] options, string inde
         }
 
         // get valid install paths & log invalid ones
-        List<DirectoryInfo> defaultPaths = new();
+        List<DirectoryInfo> defaultPaths = [];
         foreach ((DirectoryInfo dir, GameFolderType type) in this.DetectGameFolders(toolkit, context))
         {
             if (type is GameFolderType.Valid)
@@ -799,7 +796,7 @@ private string InteractivelyChoose(string message, string[] options, string inde
     /// <param name="context">The installer context.</param>
     private IEnumerable<(DirectoryInfo, GameFolderType)> DetectGameFolders(ModToolkit toolkit, InstallerContext context)
     {
-        HashSet<string> foundPaths = new HashSet<string>();
+        HashSet<string> foundPaths = [];
 
         // game folder which contains the installer, if any
         {
@@ -830,28 +827,28 @@ private string[] GetInvalidFolderWarning(GameFolderType type)
         switch (type)
         {
             case GameFolderType.Valid:
-                return new[] { "OK!" }; // should never happen
+                return ["OK!"]; // should never happen
 
             case GameFolderType.LegacyVersion:
-                return new[]
-                {
+                return
+                [
                     "That directory seems to have Stardew Valley 1.5.6 or earlier.",
                     "Please update your game to the latest version to use SMAPI."
-                };
+                ];
 
             case GameFolderType.LegacyCompatibilityBranch:
-                return new[]
-                {
+                return
+                [
                     "That directory seems to have the Stardew Valley legacy 'compatibility' branch.",
                     "Unfortunately SMAPI is only compatible with the modern version of the game.",
                     "Please update your game to the main branch to use SMAPI."
-                };
+                ];
 
             case GameFolderType.NoGameFound:
-                return new[] { "That directory doesn't contain a Stardew Valley executable." };
+                return ["That directory doesn't contain a Stardew Valley executable."];
 
             default:
-                return new[] { "That directory doesn't seem to contain a valid game install." };
+                return ["That directory doesn't seem to contain a valid game install."];
         }
     }
 

src/SMAPI.Installer/assets/install on Linux.sh

@@ -1,13 +1,13 @@
 #!/usr/bin/env bash
 
 function open_in_terminal { # Checks for a few different terminal emulators to launch the installer through
-    if which konsole 2&>1 >/dev/null; then # KDE Konsole
+    if which konsole 2>&1 >/dev/null; then # KDE Konsole
         konsole -e $1
-    elif which alacritty 2&>1 >/dev/null; then # Alacritty
+    elif which alacritty 2>&1 >/dev/null; then # Alacritty
         alacritty -e $1
-    elif which gnome-terminal 2&>1 >/dev/null; then # GNOME Terminal
+    elif which gnome-terminal 2>&1 >/dev/null; then # GNOME Terminal
         gnome-terminal -- $1
-    elif which xterm 2&>1 >/dev/null; then # Xterm
+    elif which xterm 2>&1 >/dev/null; then # Xterm
         xterm -e $1
     else # Use notify-send to send a message that none of these terminals were found installed and instruct the user to manually invoke this script through a terminal
         notify-send --app-name="SMAPI Installer" --urgency=critical "Failed to find a terminal to open installer with. Please use a terminal program to open the 'install on Linux.sh' script"

src/SMAPI.Internal/ConsoleWriting/ColorfulConsoleWriter.cs

@@ -126,18 +126,18 @@ private bool TestColorSupport()
     private IDictionary<ConsoleLogLevel, ConsoleColor> GetConsoleColorScheme(Platform platform, ColorSchemeConfig colorConfig)
     {
         // get color scheme ID
-        MonitorColorScheme schemeID = colorConfig.UseScheme;
-        if (schemeID == MonitorColorScheme.AutoDetect)
+        MonitorColorScheme schemeId = colorConfig.UseScheme;
+        if (schemeId == MonitorColorScheme.AutoDetect)
         {
-            schemeID = platform == Platform.Mac
+            schemeId = platform == Platform.Mac
                 ? MonitorColorScheme.LightBackground // macOS doesn't provide console background color info, but it's usually white.
                 : ColorfulConsoleWriter.IsDark(Console.BackgroundColor) ? MonitorColorScheme.DarkBackground : MonitorColorScheme.LightBackground;
         }
 
         // get colors for scheme
-        return colorConfig.Schemes.TryGetValue(schemeID, out IDictionary<ConsoleLogLevel, ConsoleColor>? scheme)
+        return colorConfig.Schemes.TryGetValue(schemeId, out IDictionary<ConsoleLogLevel, ConsoleColor>? scheme)
             ? scheme
-            : throw new NotSupportedException($"Unknown color scheme '{schemeID}'.");
+            : throw new NotSupportedException($"Unknown color scheme '{schemeId}'.");
     }
 
     /// <summary>Get whether a console color should be considered dark, which is subjectively defined as 'white looks better than black on this text'.</summary>

src/SMAPI.ModBuildConfig.Analyzer.Tests/Mock/Netcode/NetCollection.cs

@@ -4,4 +4,4 @@
 namespace Netcode;
 
 /// <summary>A simplified version of Stardew Valley's <c>Netcode.NetCollection</c> for unit testing.</summary>
-public class NetCollection<T> : Collection<T> { }
+public class NetCollection<T> : Collection<T>;

src/SMAPI.ModBuildConfig.Analyzer.Tests/Mock/Netcode/NetInt.cs

@@ -2,4 +2,4 @@
 namespace Netcode;
 
 /// <summary>A simplified version of Stardew Valley's <c>Netcode.NetInt</c> for unit testing.</summary>
-public class NetInt : NetFieldBase<int, NetInt> { }
+public class NetInt : NetFieldBase<int, NetInt>;

src/SMAPI.ModBuildConfig.Analyzer.Tests/Mock/Netcode/NetList.cs

@@ -4,4 +4,4 @@
 namespace Netcode;
 
 /// <summary>A simplified version of Stardew Valley's <c>Netcode.NetObjectList</c> for unit testing.</summary>
-public class NetList<T> : List<T> { }
+public class NetList<T> : List<T>;

src/SMAPI.ModBuildConfig.Analyzer.Tests/Mock/Netcode/NetObjectList.cs

@@ -2,4 +2,4 @@
 namespace Netcode;
 
 /// <summary>A simplified version of Stardew Valley's <c>Netcode.NetObjectList</c> for unit testing.</summary>
-public class NetObjectList<T> : NetList<T> { }
+public class NetObjectList<T> : NetList<T>;

src/SMAPI.ModBuildConfig.Analyzer.Tests/Mock/Netcode/NetRef.cs

@@ -2,4 +2,4 @@
 namespace Netcode;
 
 /// <summary>A simplified version of Stardew Valley's <c>Netcode.NetRef</c> for unit testing.</summary>
-public class NetRef<T> : NetFieldBase<T, NetRef<T>> where T : class { }
+public class NetRef<T> : NetFieldBase<T, NetRef<T>> where T : class;

src/SMAPI.ModBuildConfig.Analyzer.Tests/Mock/StardewValley/Item.cs

@@ -23,11 +23,11 @@ public class Item
     public NetRef<object> netRefProperty { get; } = new();
 
     /// <summary>A sample net list.</summary>
-    public readonly NetList<int> netList = new();
+    public readonly NetList<int> netList = [];
 
     /// <summary>A sample net object list.</summary>
-    public readonly NetObjectList<int> netObjectList = new();
+    public readonly NetObjectList<int> netObjectList = [];
 
     /// <summary>A sample net collection.</summary>
-    public readonly NetCollection<int> netCollection = new();
+    public readonly NetCollection<int> netCollection = [];
 }

src/SMAPI.ModBuildConfig.Analyzer.Tests/NetFieldAnalyzerTests.cs

@@ -88,7 +88,7 @@ public void AvoidNetFields_RaisesDiagnostic(string codeText, int column, string
             Id = "AvoidNetField",
             Message = $"'{expression}' is a {netType} field; consider using the {suggestedProperty} property instead. See https://smapi.io/package/avoid-net-field for details.",
             Severity = DiagnosticSeverity.Warning,
-            Locations = new[] { new DiagnosticResultLocation("Test0.cs", NetFieldAnalyzerTests.SampleCodeLine, NetFieldAnalyzerTests.SampleCodeColumn + column) }
+            Locations = [new DiagnosticResultLocation("Test0.cs", NetFieldAnalyzerTests.SampleCodeLine, NetFieldAnalyzerTests.SampleCodeColumn + column)]
         };
 
         // assert

src/SMAPI.ModBuildConfig.Analyzer.Tests/ObsoleteFieldAnalyzerTests.cs

@@ -69,7 +69,7 @@ public void AvoidObsoleteField_RaisesDiagnostic(string codeText, int column, str
             Id = "AvoidObsoleteField",
             Message = $"The '{oldName}' field is obsolete and should be replaced with '{newName}'. See https://smapi.io/package/avoid-obsolete-field for details.",
             Severity = DiagnosticSeverity.Warning,
-            Locations = new[] { new DiagnosticResultLocation("Test0.cs", ObsoleteFieldAnalyzerTests.SampleCodeLine, ObsoleteFieldAnalyzerTests.SampleCodeColumn + column) }
+            Locations = [new DiagnosticResultLocation("Test0.cs", ObsoleteFieldAnalyzerTests.SampleCodeLine, ObsoleteFieldAnalyzerTests.SampleCodeColumn + column)]
         };
 
         // assert

src/SMAPI.ModBuildConfig.Analyzer/NetFieldAnalyzer.cs

@@ -154,7 +154,7 @@ public class NetFieldAnalyzer : DiagnosticAnalyzer
     /// <summary>Construct an instance.</summary>
     public NetFieldAnalyzer()
     {
-        this.SupportedDiagnostics = ImmutableArray.Create(this.AvoidNetFieldRule);
+        this.SupportedDiagnostics = [this.AvoidNetFieldRule];
     }
 
     /// <summary>Called once at session start to register actions in the analysis context.</summary>

src/SMAPI.ModBuildConfig.Analyzer/ObsoleteFieldAnalyzer.cs

@@ -49,7 +49,7 @@ public class ObsoleteFieldAnalyzer : DiagnosticAnalyzer
     /// <summary>Construct an instance.</summary>
     public ObsoleteFieldAnalyzer()
     {
-        this.SupportedDiagnostics = ImmutableArray.CreateRange(this.Rules.Values);
+        this.SupportedDiagnostics = [.. this.Rules.Values];
     }
 
     /// <summary>Called once at session start to register actions in the analysis context.</summary>

src/SMAPI.ModBuildConfig/Framework/ContentPackFileManager.cs

@@ -39,7 +39,7 @@ internal class ContentPackFileManager : IModFileManager
     public ContentPackFileManager(string projectDir, string contentPackDir, string version, string[] ignoreFilePaths, Regex[] ignoreFilePatterns, bool validateManifest)
     {
         // get folders
-        DirectoryInfo projectDirInfo = new DirectoryInfo(Path.Combine(projectDir, contentPackDir));
+        DirectoryInfo projectDirInfo = new(Path.Combine(projectDir, contentPackDir));
         if (!projectDirInfo.Exists)
             throw GetError($"that folder doesn't exist at {projectDirInfo.FullName}");
 

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Other/ApplySaveFixCommand.cs

@@ -68,7 +68,7 @@ public override void Handle(IMonitor monitor, string command, ArgumentParser arg
     /// <summary>Get all item instances in the world.</summary>
     private List<Item> GetLoadedItems()
     {
-        List<Item> loadedItems = new();
+        List<Item> loadedItems = [];
         Utility.ForEachItem(item =>
         {
             loadedItems.Add(item);

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Other/LogContextCommand.cs

@@ -20,7 +20,7 @@ public LogContextCommand()
     /// <param name="args">The command arguments.</param>
     public override void Handle(IMonitor monitor, string command, ArgumentParser args)
     {
-        Monitor.ForceLogContext = true;
+        Monitor.ForceLogContext = !Monitor.ForceLogContext;
 
         monitor.Log(
             Monitor.ForceLogContext ? "OK, logging contextual info until you run this command again." : "OK, no longer logging contextual info.",

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Other/RegenerateBundles.cs

@@ -50,7 +50,7 @@ public override void Handle(IMonitor monitor, string command, ArgumentParser arg
         {
             monitor.Log($"WARNING: this may have unintended consequences (type 'help {command}' for details). Are you sure?", LogLevel.Warn);
 
-            string[] newArgs = args.Concat(new[] { "confirm" }).ToArray();
+            string[] newArgs = args.Concat(["confirm"]).ToArray();
             monitor.Log($"To confirm, enter this command: '{command} {string.Join(" ", newArgs)}'.", LogLevel.Info);
             return;
         }

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Player/AddCommand.cs

@@ -41,7 +41,7 @@ public override void Handle(IMonitor monitor, string command, ArgumentParser arg
 
         // find matching item
         SearchableItem? match = id != null
-            ? this.FindItemByID(monitor, id)
+            ? this.FindItemById(monitor, id)
             : this.FindItemByName(monitor, name);
         if (match == null)
             return;
@@ -119,7 +119,7 @@ private bool TryReadArguments(ArgumentParser args, out string? id, out string? n
     /// <summary>Get a matching item by its ID.</summary>
     /// <param name="monitor">Writes messages to the console and log file.</param>
     /// <param name="id">The qualified item ID.</param>
-    private SearchableItem? FindItemByID(IMonitor monitor, string id)
+    private SearchableItem? FindItemById(IMonitor monitor, string id)
     {
         SearchableItem? item = this.Items
             .GetAll()
@@ -156,8 +156,8 @@ private bool TryReadArguments(ArgumentParser args, out string? id, out string? n
         // handle ambiguous results
         string options = this.GetTableString(
             data: matches,
-            header: new[] { "type", "name", "command" },
-            getRow: item => new[] { item.Type.ToString(), item.DisplayName, $"player_add {item.QualifiedItemId}" }
+            header: ["type", "name", "command"],
+            getRow: item => [item.Type.ToString(), item.DisplayName, $"player_add {item.QualifiedItemId}"]
         );
         monitor.Log($"Multiple items have a name containing '{name}'. Do you mean one of these?\n\n{options}", LogLevel.Info);
         return null;

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Player/ListItemsCommand.cs

@@ -40,13 +40,13 @@ public override void Handle(IMonitor monitor, string command, ArgumentParser arg
         SearchableItem[] matches =
             (
                 from item in this.GetItems(args.ToArray())
-                orderby item.Type.ToString(), item.Name
+                orderby item.Type, item.Name
                 select item
             )
             .ToArray();
         string summary = "Searching...\n";
         if (matches.Any())
-            monitor.Log(summary + this.GetTableString(matches, new[] { "name", "id" }, val => new[] { val.Name, val.QualifiedItemId }), LogLevel.Info);
+            monitor.Log(summary + this.GetTableString(matches, ["name", "id"], val => [val.Name, val.QualifiedItemId]), LogLevel.Info);
         else
             monitor.Log(summary + "No items found", LogLevel.Info);
     }

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Player/SetColorCommand.cs

@@ -22,7 +22,7 @@ public SetColorCommand()
     public override void Handle(IMonitor monitor, string command, ArgumentParser args)
     {
         // parse arguments
-        if (!args.TryGet(0, "target", out string? target, oneOf: new[] { "hair", "eyes", "pants" }))
+        if (!args.TryGet(0, "target", out string? target, oneOf: ["hair", "eyes", "pants"]))
             return;
         if (!args.TryGet(1, "color", out string? rawColor))
             return;

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Player/SetNameCommand.cs

@@ -21,7 +21,7 @@ public SetNameCommand()
     public override void Handle(IMonitor monitor, string command, ArgumentParser args)
     {
         // parse arguments
-        if (!args.TryGet(0, "target", out string? target, oneOf: new[] { "player", "farm" }))
+        if (!args.TryGet(0, "target", out string? target, oneOf: ["player", "farm"]))
             return;
         args.TryGet(1, "name", out string? name, required: false);
 

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Player/SetStyleCommand.cs

@@ -21,14 +21,14 @@ public SetStyleCommand()
     public override void Handle(IMonitor monitor, string command, ArgumentParser args)
     {
         // parse arguments
-        if (!args.TryGet(0, "target", out string? target, oneOf: new[] { "hair", "shirt", "acc", "skin", "shoe", "swim", "gender" }))
+        if (!args.TryGet(0, "target", out string? target, oneOf: ["hair", "shirt", "acc", "skin", "shoe", "swim", "gender"]))
             return;
-        if (!args.TryGet(1, "style ID", out string? styleID))
+        if (!args.TryGet(1, "style ID", out string? styleId))
             return;
 
         bool AssertIntStyle(out int id)
         {
-            if (int.TryParse(styleID, out id))
+            if (int.TryParse(styleId, out id))
                 return true;
 
             monitor.Log($"The style ID must be a numeric integer for the '{target}' target.", LogLevel.Error);
@@ -47,7 +47,7 @@ bool AssertIntStyle(out int id)
                 break;
 
             case "shirt":
-                Game1.player.changeShirt(styleID);
+                Game1.player.changeShirt(styleId);
                 monitor.Log("OK, your shirt style is updated.", LogLevel.Info);
                 break;
 
@@ -68,7 +68,7 @@ bool AssertIntStyle(out int id)
                 break;
 
             case "shoe":
-                Game1.player.changeShoeColor(styleID);
+                Game1.player.changeShoeColor(styleId);
                 monitor.Log("OK, your shoe style is updated.", LogLevel.Info);
                 break;