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.0.3</Version>
+    <Version>4.0.4</Version>
     <Product>SMAPI</Product>
     <LangVersion>latest</LangVersion>
     <AssemblySearchPaths>$(AssemblySearchPaths);{GAC}</AssemblySearchPaths>

docs/README.md

@@ -63,6 +63,7 @@ Chinese     | ✓ [fully translated](../src/SMAPI/i18n/zh.json)
 French      | ✓ [fully translated](../src/SMAPI/i18n/fr.json)
 German      | ✓ [fully translated](../src/SMAPI/i18n/de.json)
 Hungarian   | ✓ [fully translated](../src/SMAPI/i18n/hu.json)
+Indonesian  | ✓ [fully translated](../src/SMAPI/i18n/id.json)
 Italian     | ✓ [fully translated](../src/SMAPI/i18n/it.json)
 Japanese    | ✓ [fully translated](../src/SMAPI/i18n/ja.json)
 Korean      | ✓ [fully translated](../src/SMAPI/i18n/ko.json)

docs/release-notes.md

@@ -1,6 +1,22 @@
 ← [README](README.md)
 
 # Release notes
+## 4.0.4
+Released 29 March 2024 for Stardew Valley 1.6.0 or later.
+
+* For players:
+  * Added `log_context` console command, which replaces `test_input` and logs more info like menu changes.
+  * Added [`--prefer-terminal-name` command-line argument](technical/smapi.md#command-line-arguments) to override which terminal SMAPI is launched with (thanks to test482!).
+  * Fixed some mods compiled for Stardew Valley 1.6.3+ not working in 1.6.0–1.6.2.
+  * Fixed SMAPI's "_Found warnings with X mods_" message counting hidden warnings.
+  * Improved translations. Thanks to RezaHidayatM (added Indonesian)!
+
+* For the web UI:
+  * Improved smapi.io colors for accessibility, converted PNG images to SVG, and updated Patreon logo (thanks to ishan!).
+  * Fixed JSON schema validation:
+    * Manifest `UpdateKeys` field now allows dots in the GitHub repo name.
+    * Fixed Content Patcher's `FromMapFile` and `FromFile` patterns.
+
 ## 4.0.3
 Released 27 March 2024 for Stardew Valley 1.6.0 or later.
 

docs/technical/smapi.md

@@ -42,6 +42,7 @@ argument | purpose
 -------- | -------
 `--developer-mode`<br />`--developer-mode-off` | Enable or disable features intended for mod developers. Currently this only makes `TRACE`-level messages appear in the console.
 `--no-terminal` | SMAPI won't log anything to the console. On Linux/macOS only, this will also prevent the launch script from trying to open a terminal window. (Messages will still be written to the log file.)
+`--prefer-terminal-name` | On Linux/macOS only, the terminal with which to open the SMAPI console. For example, `--prefer-terminal-name=xterm` to use xterm regardless of which terminal is the default one.
 `--use-current-shell` | On Linux/macOS only, the launch script won't try to open a terminal window. All console output will be sent to the shell running the launch script.
 `--mods-path` | The path to search for mods, if not the standard `Mods` folder. This can be a path relative to the game folder (like `--mods-path "Mods (test)"`) or an absolute path.
 
@@ -55,6 +56,7 @@ environment variable | purpose
 `SMAPI_DEVELOPER_MODE` | Equivalent to `--developer-mode` and `--developer-mode-off` above. The value must be `true` or `false`.
 `SMAPI_MODS_PATH` | Equivalent to `--mods-path` above.
 `SMAPI_NO_TERMINAL` | Equivalent to `--no-terminal` above.
+`$SMAPI_PREFER_TERMINAL_NAME` | Equivalent to `--prefer-terminal-name` above.
 `SMAPI_USE_CURRENT_SHELL` | Equivalent to `--use-current-shell` above.
 
 ### Compile flags

src/SMAPI.Installer/assets/unix-launcher.sh

@@ -13,6 +13,8 @@ SKIP_TERMINAL=false
 # Whether to avoid opening a separate terminal, but still send the usual log output to the console.
 USE_CURRENT_SHELL=false
 
+# Specify terminal name to open and output logs
+PREFER_TERMINAL_NAME=""
 
 ##########
 ## Read environment variables
@@ -23,6 +25,9 @@ fi
 if [ "$SMAPI_USE_CURRENT_SHELL" == "true" ]; then
     USE_CURRENT_SHELL=true
 fi
+if [ "$SMAPI_PREFER_TERMINAL_NAME" != "" ]; then
+    PREFER_TERMINAL_NAME=$SMAPI_PREFER_TERMINAL_NAME
+fi
 
 
 ##########
@@ -32,6 +37,7 @@ while [ "$#" -gt 0 ]; do
     case "$1" in
         --skip-terminal ) SKIP_TERMINAL=true; shift ;;
         --use-current-shell ) USE_CURRENT_SHELL=true; shift ;;
+        --prefer-terminal-name=* ) PREFER_TERMINAL_NAME="${1#*=}"; shift ;; # ${1#*=} removes everything up to the equals sign from $1
         -- ) shift; break ;;
         * ) shift ;;
     esac
@@ -92,13 +98,18 @@ else
 
     # run in terminal
     if [ "$USE_CURRENT_SHELL" == "false" ]; then
-        # select terminal (prefer xterm for best compatibility, then known supported terminals)
-        for terminal in xterm gnome-terminal kitty terminator xfce4-terminal konsole terminal termite alacritty mate-terminal x-terminal-emulator wezterm; do
-            if command -v "$terminal" 2>/dev/null; then
-                export TERMINAL_NAME=$terminal
-                break;
-            fi
-        done
+        # if user said preferred terminal
+        if [ "$PREFER_TERMINAL_NAME" != "" ]; then
+            export TERMINAL_NAME=$PREFER_TERMINAL_NAME
+        else
+            # select terminal (prefer xterm for best compatibility, then known supported terminals)
+            for terminal in xterm gnome-terminal kitty terminator xfce4-terminal konsole terminal termite alacritty mate-terminal x-terminal-emulator wezterm; do
+                if command -v "$terminal" 2>/dev/null; then
+                    export TERMINAL_NAME=$terminal
+                    break;
+                fi
+            done
+        fi
 
         # find the true shell behind x-terminal-emulator
         if [ "$TERMINAL_NAME" = "x-terminal-emulator" ]; then

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/ConsoleCommand.cs

@@ -16,9 +16,6 @@ internal abstract class ConsoleCommand : IConsoleCommand
         /// <summary>The command description.</summary>
         public string Description { get; }
 
-        /// <summary>Whether the command may need to perform logic when the player presses a button. This value shouldn't change.</summary>
-        public bool MayNeedInput { get; }
-
         /// <summary>Whether the command may need to perform logic when the game updates. This value shouldn't change.</summary>
         public bool MayNeedUpdate { get; }
 
@@ -48,13 +45,11 @@ public virtual void OnButtonPressed(IMonitor monitor, SButton button) { }
         /// <summary>Construct an instance.</summary>
         /// <param name="name">The command name the user must type.</param>
         /// <param name="description">The command description.</param>
-        /// <param name="mayNeedInput">Whether the command may need to perform logic when the player presses a button.</param>
         /// <param name="mayNeedUpdate">Whether the command may need to perform logic when the game updates.</param>
-        protected ConsoleCommand(string name, string description, bool mayNeedInput = false, bool mayNeedUpdate = false)
+        protected ConsoleCommand(string name, string description, bool mayNeedUpdate = false)
         {
             this.Name = name;
             this.Description = description;
-            this.MayNeedInput = mayNeedInput;
             this.MayNeedUpdate = mayNeedUpdate;
         }
 

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/IConsoleCommand.cs

@@ -15,9 +15,6 @@ internal interface IConsoleCommand
         /// <summary>Whether the command may need to perform logic when the game updates. This value shouldn't change.</summary>
         bool MayNeedUpdate { get; }
 
-        /// <summary>Whether the command may need to perform logic when the player presses a button. This value shouldn't change.</summary>
-        bool MayNeedInput { get; }
-
 
         /*********
         ** Public methods
@@ -31,10 +28,5 @@ internal interface IConsoleCommand
         /// <summary>Perform any logic needed on update tick.</summary>
         /// <param name="monitor">Writes messages to the console and log file.</param>
         void OnUpdated(IMonitor monitor);
-
-        /// <summary>Perform any logic when input is received.</summary>
-        /// <param name="monitor">Writes messages to the console and log file.</param>
-        /// <param name="button">The button that was pressed.</param>
-        void OnButtonPressed(IMonitor monitor, SButton button);
     }
 }

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

@@ -0,0 +1,31 @@
+using System.Diagnostics.CodeAnalysis;
+using StardewModdingAPI.Framework;
+
+namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Other
+{
+    /// <summary>A command which logs contextual info like keys pressed or menus changed until it's disabled.</summary>
+    [SuppressMessage("ReSharper", "UnusedMember.Global", Justification = "Loaded using reflection")]
+    internal class LogContextCommand : ConsoleCommand
+    {
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public LogContextCommand()
+            : base("log_context", "Prints contextual info like keys pressed or menus changed until it's disabled.", mayNeedUpdate: true) { }
+
+        /// <summary>Handle the command.</summary>
+        /// <param name="monitor">Writes messages to the console and log file.</param>
+        /// <param name="command">The command name.</param>
+        /// <param name="args">The command arguments.</param>
+        public override void Handle(IMonitor monitor, string command, ArgumentParser args)
+        {
+            Monitor.ForceLogContext = true;
+
+            monitor.Log(
+                Monitor.ForceLogContext ? "OK, logging contextual info until you run this command again." : "OK, no longer logging contextual info.",
+                LogLevel.Info
+            );
+        }
+    }
+}

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

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using StardewModdingAPI.Events;
 using StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands;
 
 namespace StardewModdingAPI.Mods.ConsoleCommands
@@ -18,9 +17,6 @@ public class ModEntry : Mod
         /// <summary>The commands which may need to handle update ticks.</summary>
         private IConsoleCommand[] UpdateHandlers = null!;
 
-        /// <summary>The commands which may need to handle input.</summary>
-        private IConsoleCommand[] InputHandlers = null!;
-
 
         /*********
         ** Public methods
@@ -35,27 +31,16 @@ public override void Entry(IModHelper helper)
                 helper.ConsoleCommands.Add(command.Name, command.Description, (name, args) => this.HandleCommand(command, name, args));
 
             // cache commands
-            this.InputHandlers = this.Commands.Where(p => p.MayNeedInput).ToArray();
             this.UpdateHandlers = this.Commands.Where(p => p.MayNeedUpdate).ToArray();
 
             // hook events
             helper.Events.GameLoop.UpdateTicked += this.OnUpdateTicked;
-            helper.Events.Input.ButtonPressed += this.OnButtonPressed;
         }
 
 
         /*********
         ** Private methods
         *********/
-        /// <summary>The method invoked when a button is pressed.</summary>
-        /// <param name="sender">The event sender.</param>
-        /// <param name="e">The event arguments.</param>
-        private void OnButtonPressed(object? sender, ButtonPressedEventArgs e)
-        {
-            foreach (IConsoleCommand command in this.InputHandlers)
-                command.OnButtonPressed(this.Monitor, e.Button);
-        }
-
         /// <summary>The method invoked when the game updates its state.</summary>
         /// <param name="sender">The event sender.</param>
         /// <param name="e">The event arguments.</param>