Merge branch 'develop' into stable

Author: Pathoschild

build/common.targets

@@ -7,13 +7,16 @@ repo. It imports the other MSBuild files as needed.
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <!--set general build properties -->
-    <Version>3.18.3</Version>
+    <Version>3.18.4</Version>
     <Product>SMAPI</Product>
     <LangVersion>latest</LangVersion>
     <AssemblySearchPaths>$(AssemblySearchPaths);{GAC}</AssemblySearchPaths>
     <DefineConstants>$(DefineConstants);SMAPI_DEPRECATED</DefineConstants>
     <DebugSymbols>true</DebugSymbols>
 
+    <!--embed symbols for error stack trace line numbers on Linux/macOS: https://github.com/dotnet/runtime/issues/39987-->
+    <DebugType>embedded</DebugType>
+
     <!--enable nullable annotations, except in .NET Standard 2.0 where they aren't supported-->
     <Nullable Condition="'$(TargetFramework)' != 'netstandard2.0'">enable</Nullable>
     <NoWarn Condition="'$(TargetFramework)' == 'netstandard2.0'">$(NoWarn);CS8632</NoWarn>

build/deploy-local-smapi.targets

@@ -18,7 +18,6 @@ This assumes `find-game-folder.targets` has already been imported and validated.
     <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(GamePath)" />
     <Copy SourceFiles="$(TargetDir)\$(TargetName).exe" DestinationFolder="$(GamePath)" Condition="$(OS) == 'Windows_NT'" />
     <Copy SourceFiles="$(TargetDir)\$(TargetName)" DestinationFolder="$(GamePath)" Condition="$(OS) != 'Windows_NT'" />
-    <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)" />
     <Copy SourceFiles="$(TargetDir)\$(TargetName).xml" DestinationFolder="$(GamePath)" />
     <Copy SourceFiles="$(TargetDir)\SMAPI.config.json" DestinationFiles="$(GamePath)\smapi-internal\config.json" />
     <Copy SourceFiles="$(TargetDir)\SMAPI.metadata.json" DestinationFiles="$(GamePath)\smapi-internal\metadata.json" />
@@ -62,20 +61,17 @@ This assumes `find-game-folder.targets` has already been imported and validated.
     </ItemGroup>
 
     <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(GamePath)\Mods\$(AssemblyName)" />
-    <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)\Mods\$(AssemblyName)" Condition="Exists('$(TargetDir)\$(TargetName).pdb')" />
     <Copy SourceFiles="$(TargetDir)\manifest.json" DestinationFolder="$(GamePath)\Mods\$(AssemblyName)" />
     <Copy SourceFiles="@(TranslationFiles)" DestinationFolder="$(GamePath)\Mods\$(AssemblyName)\i18n" />
   </Target>
 
   <!-- toolkit -->
   <Target Name="CopyToolkit" Condition="'$(MSBuildProjectName)' == 'SMAPI.Toolkit'" AfterTargets="PostBuildEvent">
     <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(GamePath)\smapi-internal" />
-    <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)\smapi-internal" />
     <Copy SourceFiles="$(TargetDir)\$(TargetName).xml" DestinationFolder="$(GamePath)\smapi-internal" />
   </Target>
   <Target Name="CopyToolkitCoreInterfaces" Condition="'$(MSBuildProjectName)' == 'SMAPI.Toolkit.CoreInterfaces'" AfterTargets="PostBuildEvent">
     <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(GamePath)\smapi-internal" />
-    <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)\smapi-internal" />
     <Copy SourceFiles="$(TargetDir)\$(TargetName).xml" DestinationFolder="$(GamePath)\smapi-internal" />
   </Target>
 </Project>

build/unix/prepare-install-package.sh

@@ -122,7 +122,7 @@ for folder in ${folders[@]}; do
     fi
 
     # bundle root files
-    for name in "StardewModdingAPI" "StardewModdingAPI.dll" "StardewModdingAPI.pdb" "StardewModdingAPI.xml" "steam_appid.txt"; do
+    for name in "StardewModdingAPI" "StardewModdingAPI.dll" "StardewModdingAPI.xml" "steam_appid.txt"; do
         if [ $name == "StardewModdingAPI" ] && [ $folder == "windows" ]; then
             name="$name.exe"
         fi
@@ -134,7 +134,7 @@ for folder in ${folders[@]}; do
     cp -r "$smapiBin/i18n" "$bundlePath/smapi-internal"
 
     # bundle smapi-internal
-    for name in "0Harmony.dll" "0Harmony.xml" "Mono.Cecil.dll" "Mono.Cecil.Mdb.dll" "Mono.Cecil.Pdb.dll" "MonoMod.Common.dll" "Newtonsoft.Json.dll" "Pathoschild.Http.Client.dll" "Pintail.dll" "TMXTile.dll" "SMAPI.Toolkit.dll" "SMAPI.Toolkit.pdb" "SMAPI.Toolkit.xml" "SMAPI.Toolkit.CoreInterfaces.dll" "SMAPI.Toolkit.CoreInterfaces.pdb" "SMAPI.Toolkit.CoreInterfaces.xml" "System.Net.Http.Formatting.dll"; do
+    for name in "0Harmony.dll" "0Harmony.xml" "Mono.Cecil.dll" "Mono.Cecil.Mdb.dll" "Mono.Cecil.Pdb.dll" "MonoMod.Common.dll" "Newtonsoft.Json.dll" "Pathoschild.Http.Client.dll" "Pintail.dll" "TMXTile.dll" "SMAPI.Toolkit.dll" "SMAPI.Toolkit.xml" "SMAPI.Toolkit.CoreInterfaces.dll" "SMAPI.Toolkit.CoreInterfaces.xml" "System.Net.Http.Formatting.dll"; do
         cp "$smapiBin/$name" "$bundlePath/smapi-internal"
     done
 
@@ -164,7 +164,6 @@ for folder in ${folders[@]}; do
         mkdir "$targetPath" --parents
 
         cp "$fromPath/$modName.dll" "$targetPath"
-        cp "$fromPath/$modName.pdb" "$targetPath"
         cp "$fromPath/manifest.json" "$targetPath"
         if [ -d "$fromPath/i18n" ]; then
             cp -r "$fromPath/i18n" "$targetPath"

build/windows/prepare-install-package.ps1

@@ -142,7 +142,7 @@ foreach ($folder in $folders) {
     }
 
     # bundle root files
-    foreach ($name in @("StardewModdingAPI", "StardewModdingAPI.dll", "StardewModdingAPI.pdb", "StardewModdingAPI.xml", "steam_appid.txt")) {
+    foreach ($name in @("StardewModdingAPI", "StardewModdingAPI.dll", "StardewModdingAPI.xml", "steam_appid.txt")) {
         if ($name -eq "StardewModdingAPI" -and $folder -eq "windows") {
             $name = "$name.exe"
         }
@@ -154,7 +154,7 @@ foreach ($folder in $folders) {
     cp -Recurse "$smapiBin/i18n" "$bundlePath/smapi-internal"
 
     # bundle smapi-internal
-    foreach ($name in @("0Harmony.dll", "0Harmony.xml", "Mono.Cecil.dll", "Mono.Cecil.Mdb.dll", "Mono.Cecil.Pdb.dll", "MonoMod.Common.dll", "Newtonsoft.Json.dll", "Pathoschild.Http.Client.dll", "Pintail.dll", "TMXTile.dll", "SMAPI.Toolkit.dll", "SMAPI.Toolkit.pdb", "SMAPI.Toolkit.xml", "SMAPI.Toolkit.CoreInterfaces.dll", "SMAPI.Toolkit.CoreInterfaces.pdb", "SMAPI.Toolkit.CoreInterfaces.xml", "System.Net.Http.Formatting.dll")) {
+    foreach ($name in @("0Harmony.dll", "0Harmony.xml", "Mono.Cecil.dll", "Mono.Cecil.Mdb.dll", "Mono.Cecil.Pdb.dll", "MonoMod.Common.dll", "Newtonsoft.Json.dll", "Pathoschild.Http.Client.dll", "Pintail.dll", "TMXTile.dll", "SMAPI.Toolkit.dll", "SMAPI.Toolkit.xml", "SMAPI.Toolkit.CoreInterfaces.dll", "SMAPI.Toolkit.CoreInterfaces.xml", "System.Net.Http.Formatting.dll")) {
         cp "$smapiBin/$name" "$bundlePath/smapi-internal"
     }
 
@@ -189,7 +189,6 @@ foreach ($folder in $folders) {
         mkdir "$targetPath" > $null
 
         cp "$fromPath/$modName.dll" "$targetPath"
-        cp "$fromPath/$modName.pdb" "$targetPath"
         cp "$fromPath/manifest.json" "$targetPath"
         if (Test-Path "$fromPath/i18n" -PathType Container) {
             cp -Recurse "$fromPath/i18n" "$targetPath"

docs/release-notes.md

@@ -7,6 +7,29 @@
   _If needed, you can update to SMAPI 3.16.0 first and then install the latest version._
 -->
 
+## 3.18.4
+Released 24 June 2023 for Stardew Valley 1.5.6 or later.
+
+* For players:
+  * In multiplayer, the game/SMAPI window titles now show whether you're the main player or a farmhand.
+  * The `test_input` console command now logs input until the command is run again (instead of for 30 seconds).
+  * Fixed logged SMAPI errors not having line numbers on Linux/macOS.
+  * Fixed wezterm terminal support on Linux/macoS (thanks to romangraef!).
+  * Fixed install error if a game folder has an invalid symlink.
+
+* For mod authors:
+  * Added `--no-prompt` installer command-line argument for automated tools (thanks to NyCodeGHG!).
+  * Added clearer error message when a map tilesheet has no image source (thanks to atravita!).
+  * Fixed `Context.HasRemotePlayers` being true when there's no farmhands connected.
+  * Fixed error loading a mod if it explicitly sets `"MinimumApiVersion": null`.
+  * Updated Newtonsoft.Json 13.0.2 → 13.0.3 (see [changes](https://github.com/JamesNK/Newtonsoft.Json/releases/tag/13.0.3)) and Pintail 2.2.2 → 2.3.0 (see [changes](https://github.com/Nanoray-pl/Pintail/blob/master/docs/release-notes.md#230)).
+
+* For SMAPI toolkit users:
+  * Fixed `ModFolder` not being JSON-serializable.
+
+* For the web API:
+  * Fixed manifest schema format for the `examples` field (thanks to boneskull!).
+
 ## 3.18.3
 Released 09 April 2023 for Stardew Valley 1.5.6 or later.
 
@@ -15,7 +38,7 @@ Released 09 April 2023 for Stardew Valley 1.5.6 or later.
   * Fixed installer error for some Linux players due to a non-portable shebang (thanks to freyacoded!).
   * Fixed error using load order overrides when there are broken mods installed (thanks to atravita!).
   * Removed `LargeAddressAware` flag on SMAPI (no longer needed since it's 64-bit now).
-  * Improved translations. Thganks to stylemate (updated Korean)!
+  * Improved translations. Thanks to stylemate (updated Korean)!
 
 * For mod authors:
   * Added `IsActiveForScreen()` method to `PerScreen<T>`.

docs/technical/mod-package.md

@@ -416,28 +416,33 @@ The NuGet package is generated automatically in `StardewModdingAPI.ModBuildConfi
 when you compile it.
 
 ## Release notes
+## 4.1.1
+Released 24 June 2023 for SMAPI 3.13.0 or later.
+
+* Replaced `.pdb` files with embedded symbols by default. This fixes logged errors not having line numbers on Linux/macOS.
+
 ### 4.1.0
-Released 08 January 2023.
+Released 08 January 2023 for SMAPI 3.13.0 or later.
 
 * Added `manifest.json` format validation on build (thanks to tylergibbs2!).
 * Fixed game DLLs not excluded from the release zip when they're referenced explicitly but `BundleExtraAssemblies` isn't set.
 
 ### 4.0.2
-Released 09 October 2022.
+Released 09 October 2022 for SMAPI 3.13.0 or later.
 
 * Switched to the newer crossplatform `portable` debug symbols (thanks to lanturnalis!).
 * Fixed `BundleExtraAssemblies` option being partly case-sensitive.
 * Fixed `BundleExtraAssemblies` not applying `All` value to game assemblies.
 
 ### 4.0.1
-Released 14 April 2022.
+Released 14 April 2022 for SMAPI 3.13.0 or later.
 
 * Added detection for Xbox app game folders.
 * Fixed "_conflicts between different versions of Microsoft.Win32.Registry_" warnings in recent SMAPI versions.
 * Internal refactoring.
 
 ### 4.0.0
-Released 30 November 2021.
+Released 30 November 2021 for SMAPI 3.13.0 or later.
 
 * Updated for Stardew Valley 1.5.5 and SMAPI 3.13.0. (Older versions are no longer supported.)
 * Added `IgnoreModFilePaths` option to ignore literal paths.
@@ -459,7 +464,7 @@ Released 30 November 2021.
      documentation](#configure).
 
 ### 3.3.0
-Released 30 March 2021.
+Released 30 March 2021 for SMAPI 3.0.0 or later.
 
 * Added a build warning when the mod isn't compiled for `Any CPU`.
 * Added a `GameFramework` build property set to `MonoGame` or `Xna` based on the platform. This can
@@ -468,32 +473,32 @@ Released 30 March 2021.
 * The package now suppresses the misleading 'processor architecture mismatch' warnings.
 
 ### 3.2.2
-Released 23 September 2020.
+Released 23 September 2020 for SMAPI 3.0.0 or later.
 
 * Reworked and streamlined how the package is compiled.
 * Added [SMAPI-ModTranslationClassBuilder](https://github.com/Pathoschild/SMAPI-ModTranslationClassBuilder)
   files to the ignore list.
 
 ### 3.2.1
-Released 11 September 2020.
+Released 11 September 2020 for SMAPI 3.0.0 or later.
 
 * Added more detailed logging.
 * Fixed _path's format is not supported_ error when using default `Mods` path in 3.2.
 
 ### 3.2.0
-Released 07 September 2020.
+Released 07 September 2020 for SMAPI 3.0.0 or later.
 
 * Added option to change `Mods` folder path.
 * Rewrote documentation to make it easier to read.
 
 ### 3.1.0
-Released 01 February 2020.
+Released 01 February 2020 for SMAPI 3.0.0 or later.
 
 * Added support for semantic versioning 2.0.
 * `0Harmony.dll` is now ignored if the mod references Harmony directly (it's bundled with SMAPI).
 
 ### 3.0.0
-Released 26 November 2019.
+Released 26 November 2019 for SMAPI 3.0.0 or later.
 
 * Updated for SMAPI 3.0 and Stardew Valley 1.4.
 * Added automatic support for `assets` folders.

docs/technical/smapi.md

@@ -32,6 +32,7 @@ argument | purpose
 `--install` | Preselects the install action, skipping the prompt asking what the user wants to do.
 `--uninstall` | Preselects the uninstall action, skipping the prompt asking what the user wants to do.
 `--game-path "path"` | Specifies the full path to the folder containing the Stardew Valley executable, skipping automatic detection and any prompt to choose a path. If the path is not valid, the installer displays an error.
+`--no-prompt` | Don't let the installer wait for user input (e.g. for cases where it's being run by a script). If the installer is unable to continue without user input, it'll fail instead.
 
 SMAPI itself recognises five arguments, but these are meant for internal use or testing, and might
 change without warning. **On Linux/macOS**, command-line arguments won't work; see _environment