add option to disable Harmony/MonoMod fix

Author: Pathoschild

docs/release-notes.md

@@ -3,6 +3,8 @@
 # Release notes
 ## Upcoming release
 * For players:
+  * Added option to disable Harmony/MonoMod fix for players with certain crashes.  
+    _This should only be changed if no installed mods use Harmony._
   * Fixed split-screen crash for non-English players when mods added translated variants of content assets.
   * SMAPI no longer rewrites mods which use Harmony 1.x, to help reduce Harmony crashes.  
     _This should affect very few mods that still work otherwise, and any Harmony mod updated after July 2021 should be unaffected._

src/SMAPI/Framework/Logging/LogManager.cs

@@ -261,7 +261,8 @@ public void LogSettingsHeader(SConfig settings)
         /// <param name="skippedMods">The mods which could not be loaded.</param>
         /// <param name="logParanoidWarnings">Whether to log issues for mods which directly use potentially sensitive .NET APIs like file or shell access.</param>
         /// <param name="logTechnicalDetailsForBrokenMods">Whether to include more technical details about broken mods in the TRACE logs. This is mainly useful for creating compatibility rewriters.</param>
-        public void LogModInfo(IModMetadata[] loaded, IModMetadata[] loadedContentPacks, IModMetadata[] loadedMods, IModMetadata[] skippedMods, bool logParanoidWarnings, bool logTechnicalDetailsForBrokenMods)
+        /// <param name="hasHarmonyFix">Whether Harmony was fixed to work with Stardew Valley.</param>
+        public void LogModInfo(IModMetadata[] loaded, IModMetadata[] loadedContentPacks, IModMetadata[] loadedMods, IModMetadata[] skippedMods, bool logParanoidWarnings, bool logTechnicalDetailsForBrokenMods, bool hasHarmonyFix)
         {
             // log loaded mods
             this.Monitor.Log($"Loaded {loadedMods.Length} mods" + (loadedMods.Length > 0 ? ":" : "."), LogLevel.Info);
@@ -300,7 +301,7 @@ public void LogModInfo(IModMetadata[] loaded, IModMetadata[] loadedContentPacks,
             }
 
             // log mod warnings
-            this.LogModWarnings(loaded, skippedMods, logParanoidWarnings, logTechnicalDetailsForBrokenMods);
+            this.LogModWarnings(loaded, skippedMods, logParanoidWarnings, logTechnicalDetailsForBrokenMods, hasHarmonyFix);
         }
 
         /// <inheritdoc />
@@ -318,8 +319,9 @@ public void Dispose()
         /// <param name="skippedMods">The mods which could not be loaded.</param>
         /// <param name="logParanoidWarnings">Whether to log issues for mods which directly use potentially sensitive .NET APIs like file or shell access.</param>
         /// <param name="logTechnicalDetailsForBrokenMods">Whether to include more technical details about broken mods in the TRACE logs. This is mainly useful for creating compatibility rewriters.</param>
+        /// <param name="hasHarmonyFix">Whether Harmony was fixed to work with Stardew Valley.</param>
         [SuppressMessage("ReSharper", "ConditionalAccessQualifierIsNonNullableAccordingToAPIContract", Justification = "Manifests aren't guaranteed non-null at this point in the loading process.")]
-        private void LogModWarnings(IEnumerable<IModMetadata> mods, IModMetadata[] skippedMods, bool logParanoidWarnings, bool logTechnicalDetailsForBrokenMods)
+        private void LogModWarnings(IEnumerable<IModMetadata> mods, IModMetadata[] skippedMods, bool logParanoidWarnings, bool logTechnicalDetailsForBrokenMods, bool hasHarmonyFix)
         {
             // get mods with warnings
             IModMetadata[] modsWithWarnings = mods
@@ -390,17 +392,29 @@ private void LogModWarnings(IEnumerable<IModMetadata> mods, IModMetadata[] skipp
                     "errors, or crashes in-game."
                 );
 
+                // missing Harmony fix
+                if (!hasHarmonyFix)
+                {
+                    this.LogModWarningGroup(modsWithWarnings, ModWarning.PatchesGame, LogLevel.Warn, "Patched game code without Harmony fix",
+                        $"These mods directly change the game code using Harmony, but you disabled the {nameof(SConfig.FixHarmony)} option.",
+                        "The game will probably crash soon."
+                    );
+                }
+
                 // changes serializer
                 this.LogModWarningGroup(modsWithWarnings, ModWarning.ChangesSaveSerializer, LogLevel.Warn, "Changed save serializer",
                     "These mods change the save serializer. They may corrupt your save files, or make them unusable if",
                     "you uninstall these mods."
                 );
 
                 // patched game code
-                this.LogModWarningGroup(modsWithWarnings, ModWarning.PatchesGame, LogLevel.Info, "Patched game code",
-                    "These mods directly change the game code. They're more likely to cause errors or bugs in-game; if",
-                    "your game has issues, try removing these first. Otherwise you can ignore this warning."
-                );
+                if (hasHarmonyFix)
+                {
+                    this.LogModWarningGroup(modsWithWarnings, ModWarning.PatchesGame, LogLevel.Info, "Patched game code",
+                        "These mods directly change the game code. They're more likely to cause errors or bugs in-game; if",
+                        "your game has issues, try removing these first. Otherwise you can ignore this warning."
+                    );
+                }
 
                 // unvalidated update tick
                 this.LogModWarningGroup(modsWithWarnings, ModWarning.UsesUnvalidatedUpdateTick, LogLevel.Info, "Bypassed safety checks",

src/SMAPI/Framework/Models/SConfig.cs

@@ -24,6 +24,7 @@ internal class SConfig
             [nameof(LogNetworkTraffic)] = false,
             [nameof(LogTechnicalDetailsForBrokenMods)] = false,
             [nameof(RewriteMods)] = true,
+            [nameof(FixHarmony)] = true,
             [nameof(UseCaseInsensitivePaths)] = Constants.Platform is Platform.Android or Platform.Linux,
             [nameof(SuppressHarmonyDebugMode)] = true
         };
@@ -71,6 +72,9 @@ internal class SConfig
         /// <summary>Whether SMAPI should rewrite mods for compatibility.</summary>
         public bool RewriteMods { get; set; }
 
+        /// <summary>Whether to apply fixes to Harmony so it works with Stardew Valley.</summary>
+        public bool FixHarmony { get; set; }
+
         /// <summary>Whether to make SMAPI file APIs case-insensitive, even on Linux.</summary>
         public bool UseCaseInsensitivePaths { get; set; }
 
@@ -109,6 +113,7 @@ internal class SConfig
         /// <param name="webApiBaseUrl"><inheritdoc cref="WebApiBaseUrl" path="/summary" /></param>
         /// <param name="verboseLogging"><inheritdoc cref="VerboseLogging" path="/summary" /></param>
         /// <param name="rewriteMods"><inheritdoc cref="RewriteMods" path="/summary" /></param>
+        /// <param name="fixHarmony"><inheritdoc cref="FixHarmony" path="/summary" /></param>
         /// <param name="useCaseInsensitivePaths"><inheritdoc cref="UseCaseInsensitivePaths" path="/summary" /></param>
         /// <param name="logNetworkTraffic"><inheritdoc cref="LogNetworkTraffic" path="/summary" /></param>
         /// <param name="logTechnicalDetailsForBrokenMods"><inheritdoc cref="LogTechnicalDetailsForBrokenMods" path="/summary" /></param>
@@ -117,7 +122,7 @@ internal class SConfig
         /// <param name="suppressUpdateChecks"><inheritdoc cref="SuppressUpdateChecks" path="/summary" /></param>
         /// <param name="modsToLoadEarly"><inheritdoc cref="ModsToLoadEarly" path="/summary" /></param>
         /// <param name="modsToLoadLate"><inheritdoc cref="ModsToLoadLate" path="/summary" /></param>
-        public SConfig(bool developerMode, bool? checkForUpdates, bool? listenForConsoleInput, bool? paranoidWarnings, bool? useBetaChannel, string gitHubProjectName, string webApiBaseUrl, string[]? verboseLogging, bool? rewriteMods, bool? useCaseInsensitivePaths, bool? logNetworkTraffic, bool? logTechnicalDetailsForBrokenMods, ColorSchemeConfig consoleColors, bool? suppressHarmonyDebugMode, string[]? suppressUpdateChecks, string[]? modsToLoadEarly, string[]? modsToLoadLate)
+        public SConfig(bool developerMode, bool? checkForUpdates, bool? listenForConsoleInput, bool? paranoidWarnings, bool? useBetaChannel, string gitHubProjectName, string webApiBaseUrl, string[]? verboseLogging, bool? rewriteMods, bool? fixHarmony, bool? useCaseInsensitivePaths, bool? logNetworkTraffic, bool? logTechnicalDetailsForBrokenMods, ColorSchemeConfig consoleColors, bool? suppressHarmonyDebugMode, string[]? suppressUpdateChecks, string[]? modsToLoadEarly, string[]? modsToLoadLate)
         {
             this.DeveloperMode = developerMode;
             this.CheckForUpdates = checkForUpdates ?? (bool)SConfig.DefaultValues[nameof(this.CheckForUpdates)];
@@ -128,6 +133,7 @@ public SConfig(bool developerMode, bool? checkForUpdates, bool? listenForConsole
             this.WebApiBaseUrl = webApiBaseUrl;
             this.VerboseLogging = new HashSet<string>(verboseLogging ?? Array.Empty<string>(), StringComparer.OrdinalIgnoreCase);
             this.RewriteMods = rewriteMods ?? (bool)SConfig.DefaultValues[nameof(this.RewriteMods)];
+            this.FixHarmony = fixHarmony ?? (bool)SConfig.DefaultValues[nameof(this.FixHarmony)];
             this.UseCaseInsensitivePaths = useCaseInsensitivePaths ?? (bool)SConfig.DefaultValues[nameof(this.UseCaseInsensitivePaths)];
             this.LogNetworkTraffic = logNetworkTraffic ?? (bool)SConfig.DefaultValues[nameof(this.LogNetworkTraffic)];
             this.LogTechnicalDetailsForBrokenMods = logTechnicalDetailsForBrokenMods ?? (bool)SConfig.DefaultValues[nameof(this.LogTechnicalDetailsForBrokenMods)];

src/SMAPI/Framework/SCore.cs

@@ -280,7 +280,8 @@ public void RunInteractively()
                 GameRunner.instance = this.Game;
 
                 // fix Harmony for mods
-                MiniMonoModHotfix.Apply();
+                if (this.Settings.FixHarmony)
+                    MiniMonoModHotfix.Apply();
 
                 // set window titles
                 this.UpdateWindowTitles();
@@ -1743,7 +1744,7 @@ private void LoadMods(IModMetadata[] mods, JsonHelper jsonHelper, ContentCoordin
             this.ModRegistry.AreAllModsLoaded = true;
 
             // log mod info
-            this.LogManager.LogModInfo(loaded, loadedContentPacks, loadedMods, skippedMods.ToArray(), this.Settings.ParanoidWarnings, this.Settings.LogTechnicalDetailsForBrokenMods);
+            this.LogManager.LogModInfo(loaded, loadedContentPacks, loadedMods, skippedMods.ToArray(), this.Settings.ParanoidWarnings, this.Settings.LogTechnicalDetailsForBrokenMods, this.Settings.FixHarmony);
 
             // initialize translations
             this.ReloadTranslations(loaded);

src/SMAPI/SMAPI.config.json

@@ -53,6 +53,13 @@ in future SMAPI versions.
      */
     "RewriteMods": true,
 
+    /**
+     * Whether to fix the library mods use to patch game code, so it works with Stardew Valley.
+     *
+     * If you disable this, mods which use Harmony are likely to cause game crashes.
+     */
+    "FixHarmony": true,
+
     /**
      * Whether to make SMAPI file APIs case-insensitive (even if the filesystem is case-sensitive).
      *