From 48833b5c306dfc88669e4cf4fc77640c426c519b Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 3 Mar 2018 15:47:29 -0500
Subject: move technical compatibility details into TRACE log (#453)

---
 src/SMAPI/Framework/ModLoading/AssemblyLoader.cs |  3 ++-
 src/SMAPI/Program.cs                             | 19 +++++++++----------
 2 files changed, 11 insertions(+), 11 deletions(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
index ccbd053e..7dcf94bf 100644
--- a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
+++ b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
@@ -270,9 +270,10 @@ namespace StardewModdingAPI.Framework.ModLoading
                     break;
 
                 case InstructionHandleResult.NotCompatible:
+                    this.Monitor.LogOnce(loggedMessages, $"{logPrefix}Broken code in {filename}: {handler.NounPhrase}.");
                     if (!assumeCompatible)
                         throw new IncompatibleInstructionException(handler.NounPhrase, $"Found an incompatible CIL instruction ({handler.NounPhrase}) while loading assembly {filename}.");
-                    this.Monitor.LogOnce(loggedMessages, $"{logPrefix}Found an incompatible CIL instruction ({handler.NounPhrase}) while loading assembly {filename}, but SMAPI is configured to allow it anyway. The mod may crash or behave unexpectedly.", LogLevel.Warn);
+                    this.Monitor.LogOnce(loggedMessages, $"{logPrefix}Found broken code ({handler.NounPhrase}) while loading assembly {filename}, but SMAPI is configured to allow it anyway. The mod may crash or behave unexpectedly.", LogLevel.Warn);
                     break;
 
                 case InstructionHandleResult.DetectedGamePatch:
diff --git a/src/SMAPI/Program.cs b/src/SMAPI/Program.cs
index 47db8e86..acab8c70 100644
--- a/src/SMAPI/Program.cs
+++ b/src/SMAPI/Program.cs
@@ -674,8 +674,8 @@ namespace StardewModdingAPI
         {
             this.Monitor.Log("Loading mods...", LogLevel.Trace);
 
-            IDictionary<IModMetadata, string> skippedMods = new Dictionary<IModMetadata, string>();
-            void TrackSkip(IModMetadata mod, string reasonPhrase) => skippedMods[mod] = reasonPhrase;
+            IDictionary<IModMetadata, string[]> skippedMods = new Dictionary<IModMetadata, string[]>();
+            void TrackSkip(IModMetadata mod, string userReasonPhrase, string devReasonPhrase = null) => skippedMods[mod] = new[] { userReasonPhrase, devReasonPhrase };
 
             // load content packs
             foreach (IModMetadata metadata in mods.Where(p => p.IsContentPack))
@@ -746,17 +746,17 @@ namespace StardewModdingAPI
                     }
                     catch (IncompatibleInstructionException ex)
                     {
-                        TrackSkip(metadata, $"it's no longer compatible (detected {ex.NounPhrase}). Please check for a newer version of the mod.");
+                        TrackSkip(metadata, "it's no longer compatible. Please check for a newer version of the mod.");
                         continue;
                     }
                     catch (SAssemblyLoadFailedException ex)
                     {
-                        TrackSkip(metadata, $"its DLL '{manifest.EntryDll}' couldn't be loaded: {ex.Message}");
+                        TrackSkip(metadata, $"it DLL couldn't be loaded: {ex.Message}");
                         continue;
                     }
                     catch (Exception ex)
                     {
-                        TrackSkip(metadata, $"its DLL '{manifest.EntryDll}' couldn't be loaded:\n{ex.GetLogSummary()}");
+                        TrackSkip(metadata, "its DLL couldn't be loaded.", $"Error: {ex.GetLogSummary()}");
                         continue;
                     }
 
@@ -816,12 +816,11 @@ namespace StardewModdingAPI
                 foreach (var pair in skippedMods.OrderBy(p => p.Key.DisplayName))
                 {
                     IModMetadata mod = pair.Key;
-                    string reason = pair.Value;
+                    string[] reason = pair.Value;
 
-                    if (mod.Manifest?.Version != null)
-                        this.Monitor.Log($"   {mod.DisplayName} {mod.Manifest.Version} because {reason}", LogLevel.Error);
-                    else
-                        this.Monitor.Log($"   {mod.DisplayName} because {reason}", LogLevel.Error);
+                    this.Monitor.Log($"   {mod.DisplayName}{(mod.Manifest?.Version != null ? " " + mod.Manifest.Version.ToString() : "")} because {reason[0]}", LogLevel.Error);
+                    if (reason[1] != null)
+                        this.Monitor.Log($"     {reason[1]}", LogLevel.Trace);
                 }
                 this.Monitor.Newline();
             }
-- 
cgit 


From adebec4dd4d3bf4b45f23377a6ab1525fa2d78ef Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 3 Mar 2018 17:49:24 -0500
Subject: automatically detect broken code (#453)

---
 src/SMAPI/Framework/ModLoading/AssemblyLoader.cs   |   5 +-
 .../Finders/ReferenceToMissingMemberFinder.cs      |  87 ++++++++++++++
 .../ReferenceToMemberWithUnexpectedTypeFinder.cs   | 131 +++++++++++++++++++++
 src/SMAPI/Metadata/InstructionMetadata.cs          |  48 ++++----
 src/SMAPI/StardewModdingAPI.csproj                 |   2 +
 5 files changed, 250 insertions(+), 23 deletions(-)
 create mode 100644 src/SMAPI/Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs
 create mode 100644 src/SMAPI/Framework/ModLoading/Rewriters/ReferenceToMemberWithUnexpectedTypeFinder.cs

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
index 7dcf94bf..f0e186a1 100644
--- a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
+++ b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
@@ -238,10 +238,13 @@ namespace StardewModdingAPI.Framework.ModLoading
 
                 // check CIL instructions
                 ILProcessor cil = method.Body.GetILProcessor();
-                foreach (Instruction instruction in cil.Body.Instructions.ToArray())
+                var instructions = cil.Body.Instructions;
+                // ReSharper disable once ForCanBeConvertedToForeach -- deliberate access by index so each handler sees replacements from previous handlers
+                for (int offset = 0; offset < instructions.Count; offset++)
                 {
                     foreach (IInstructionHandler handler in handlers)
                     {
+                        Instruction instruction = instructions[offset];
                         InstructionHandleResult result = handler.Handle(module, cil, instruction, this.AssemblyMap, platformChanged);
                         this.ProcessInstructionHandleResult(mod, handler, result, loggedMessages, logPrefix, assumeCompatible, filename);
                         if (result == InstructionHandleResult.Rewritten)
diff --git a/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs b/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs
new file mode 100644
index 00000000..60373c9d
--- /dev/null
+++ b/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs
@@ -0,0 +1,87 @@
+using System.Linq;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
+
+namespace StardewModdingAPI.Framework.ModLoading.Finders
+{
+    /// <summary>Finds references to a field, property, or method which no longer exists.</summary>
+    /// <remarks>This implementation is purely heuristic. It should never return a false positive, but won't detect all cases.</remarks>
+    internal class ReferenceToMissingMemberFinder : IInstructionHandler
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>A brief noun phrase indicating what the instruction finder matches.</summary>
+        public string NounPhrase { get; private set; } = "";
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Perform the predefined logic for a method if applicable.</summary>
+        /// <param name="module">The assembly module containing the instruction.</param>
+        /// <param name="method">The method definition containing the instruction.</param>
+        /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        public virtual InstructionHandleResult Handle(ModuleDefinition module, MethodDefinition method, PlatformAssemblyMap assemblyMap, bool platformChanged)
+        {
+            return InstructionHandleResult.None;
+        }
+
+        /// <summary>Perform the predefined logic for an instruction if applicable.</summary>
+        /// <param name="module">The assembly module containing the instruction.</param>
+        /// <param name="cil">The CIL processor.</param>
+        /// <param name="instruction">The instruction to handle.</param>
+        /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        public virtual InstructionHandleResult Handle(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged)
+        {
+            // field reference
+            FieldReference fieldRef = RewriteHelper.AsFieldReference(instruction);
+            if (fieldRef != null)
+            {
+                FieldDefinition target = fieldRef.DeclaringType.Resolve()?.Fields.FirstOrDefault(p => p.Name == fieldRef.Name);
+                if (target == null)
+                {
+                    this.NounPhrase = $"reference to {fieldRef.DeclaringType.FullName}.{fieldRef.Name} (no such field)";
+                    return InstructionHandleResult.NotCompatible;
+                }
+            }
+
+            // method reference
+            MethodReference methodRef = RewriteHelper.AsMethodReference(instruction);
+            if (methodRef != null && !this.IsUnsupported(methodRef))
+            {
+                MethodDefinition target = methodRef.DeclaringType.Resolve()?.Methods.FirstOrDefault(p => p.Name == methodRef.Name);
+                if (target == null)
+                {
+                    this.NounPhrase = this.IsProperty(methodRef)
+                        ? $"reference to {methodRef.DeclaringType.FullName}.{methodRef.Name.Substring(4)} (no such property)"
+                        : $"reference to {methodRef.DeclaringType.FullName}.{methodRef.Name} (no such method)";
+                    return InstructionHandleResult.NotCompatible;
+                }
+            }
+
+            return InstructionHandleResult.None;
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Get whether a method reference is a special case that's not currently supported (e.g. array methods).</summary>
+        /// <param name="method">The method reference.</param>
+        private bool IsUnsupported(MethodReference method)
+        {
+            return
+                method.DeclaringType.Name.Contains("["); // array methods
+        }
+
+        /// <summary>Get whether a method reference is a property getter or setter.</summary>
+        /// <param name="method">The method reference.</param>
+        private bool IsProperty(MethodReference method)
+        {
+            return method.Name.StartsWith("get_") || method.Name.StartsWith("set_");
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/ReferenceToMemberWithUnexpectedTypeFinder.cs b/src/SMAPI/Framework/ModLoading/Rewriters/ReferenceToMemberWithUnexpectedTypeFinder.cs
new file mode 100644
index 00000000..f2080e40
--- /dev/null
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/ReferenceToMemberWithUnexpectedTypeFinder.cs
@@ -0,0 +1,131 @@
+using System.Linq;
+using System.Text.RegularExpressions;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
+
+namespace StardewModdingAPI.Framework.ModLoading.Rewriters
+{
+    /// <summary>Finds references to a field, property, or method which returns a different type than the code expects.</summary>
+    /// <remarks>This implementation is purely heuristic. It should never return a false positive, but won't detect all cases.</remarks>
+    internal class ReferenceToMemberWithUnexpectedTypeFinder : IInstructionHandler
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>A pattern matching type name substrings to strip for display.</summary>
+        private readonly Regex StripTypeNamePattern = new Regex(@"`\d+(?=<)", RegexOptions.Compiled);
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>A brief noun phrase indicating what the instruction finder matches.</summary>
+        public string NounPhrase { get; private set; } = "";
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Perform the predefined logic for a method if applicable.</summary>
+        /// <param name="module">The assembly module containing the instruction.</param>
+        /// <param name="method">The method definition containing the instruction.</param>
+        /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        public virtual InstructionHandleResult Handle(ModuleDefinition module, MethodDefinition method, PlatformAssemblyMap assemblyMap, bool platformChanged)
+        {
+            return InstructionHandleResult.None;
+        }
+
+        /// <summary>Perform the predefined logic for an instruction if applicable.</summary>
+        /// <param name="module">The assembly module containing the instruction.</param>
+        /// <param name="cil">The CIL processor.</param>
+        /// <param name="instruction">The instruction to handle.</param>
+        /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        public virtual InstructionHandleResult Handle(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged)
+        {
+            // field reference
+            FieldReference fieldRef = RewriteHelper.AsFieldReference(instruction);
+            if (fieldRef != null)
+            {
+                // get target field
+                FieldDefinition targetField = fieldRef.DeclaringType.Resolve()?.Fields.FirstOrDefault(p => p.Name == fieldRef.Name);
+                if (targetField == null)
+                    return InstructionHandleResult.None;
+
+                // validate return type
+                string actualReturnTypeID = this.GetComparableTypeID(targetField.FieldType);
+                string expectedReturnTypeID = this.GetComparableTypeID(fieldRef.FieldType);
+                if (actualReturnTypeID != expectedReturnTypeID)
+                {
+                    this.NounPhrase = $"reference to {fieldRef.DeclaringType.FullName}.{fieldRef.Name} (field returns {this.GetFriendlyTypeName(targetField.FieldType, actualReturnTypeID)}, not {this.GetFriendlyTypeName(fieldRef.FieldType, expectedReturnTypeID)})";
+                    return InstructionHandleResult.NotCompatible;
+                }
+            }
+
+            // method reference
+            MethodReference methodReference = RewriteHelper.AsMethodReference(instruction);
+            if (methodReference != null)
+            {
+                // get potential targets
+                MethodDefinition[] candidateMethods = methodReference.DeclaringType.Resolve()?.Methods.Where(found => found.Name == methodReference.Name).ToArray();
+                if (candidateMethods == null || !candidateMethods.Any())
+                    return InstructionHandleResult.None;
+
+                // compare return types
+                MethodDefinition methodDef = methodReference.Resolve();
+                if (methodDef == null)
+                {
+                    this.NounPhrase = $"reference to {methodReference.DeclaringType.FullName}.{methodReference.Name} (no such method)";
+                    return InstructionHandleResult.NotCompatible;
+                }
+
+                string expectedReturnType = this.GetComparableTypeID(methodDef.ReturnType);
+                if (candidateMethods.All(method => this.GetComparableTypeID(method.ReturnType) != expectedReturnType))
+                {
+                    this.NounPhrase = $"reference to {methodDef.DeclaringType.FullName}.{methodDef.Name} (no such method returns {this.GetFriendlyTypeName(methodDef.ReturnType, expectedReturnType)})";
+                    return InstructionHandleResult.NotCompatible;
+                }
+            }
+
+            return InstructionHandleResult.None;
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Get a unique string representation of a type.</summary>
+        /// <param name="type">The type reference.</param>
+        private string GetComparableTypeID(TypeReference type)
+        {
+            return this.StripTypeNamePattern.Replace(type.FullName, "");
+        }
+
+        /// <summary>Get a shorter type name for display.</summary>
+        /// <param name="type">The type reference.</param>
+        /// <param name="typeID">The comparable type ID from <see cref="GetComparableTypeID"/>.</param>
+        private string GetFriendlyTypeName(TypeReference type, string typeID)
+        {
+            // most common built-in types
+            switch (type.FullName)
+            {
+                case "System.Boolean":
+                    return "bool";
+                case "System.Int32":
+                    return "int";
+                case "System.String":
+                    return "string";
+            }
+
+            // most common unambiguous namespaces
+            foreach (string @namespace in new[] { "Microsoft.Xna.Framework", "Netcode", "System", "System.Collections.Generic" })
+            {
+                if (type.Namespace == @namespace)
+                    return typeID.Substring(@namespace.Length + 1);
+            }
+
+            return typeID;
+        }
+    }
+}
diff --git a/src/SMAPI/Metadata/InstructionMetadata.cs b/src/SMAPI/Metadata/InstructionMetadata.cs
index 5bb461c1..9e2b7967 100644
--- a/src/SMAPI/Metadata/InstructionMetadata.cs
+++ b/src/SMAPI/Metadata/InstructionMetadata.cs
@@ -21,7 +21,27 @@ namespace StardewModdingAPI.Metadata
             return new IInstructionHandler[]
             {
                 /****
-                ** throw exception for incompatible code
+                ** rewrite CIL to fix incompatible code
+                ****/
+                // crossplatform
+                new MethodParentRewriter(typeof(SpriteBatch), typeof(SpriteBatchMethods), onlyIfPlatformChanged: true),
+
+                // Stardew Valley 1.2
+                new FieldToPropertyRewriter(typeof(Game1), nameof(Game1.activeClickableMenu)),
+                new FieldToPropertyRewriter(typeof(Game1), nameof(Game1.currentMinigame)),
+                new FieldToPropertyRewriter(typeof(Game1), nameof(Game1.gameMode)),
+                new FieldToPropertyRewriter(typeof(Game1), nameof(Game1.player)),
+                new FieldReplaceRewriter(typeof(Game1), "borderFont", nameof(Game1.smallFont)),
+                new FieldReplaceRewriter(typeof(Game1), "smoothFont", nameof(Game1.smallFont)),
+
+                // SMAPI 1.9
+                new TypeReferenceRewriter("StardewModdingAPI.Inheritance.ItemStackChange", typeof(ItemStackChange)),
+
+                // SMAPI 2.0
+                new VirtualEntryCallRemover(), // Mod.Entry changed from virtual to abstract in SMAPI 2.0, which breaks the few mods which called base.Entry()
+
+                /****
+                ** detect incompatible code
                 ****/
                 // changes in Stardew Valley 1.2 (with no rewriters)
                 new FieldFinder("StardewValley.Item", "set_Name", InstructionHandleResult.NotCompatible),
@@ -66,6 +86,10 @@ namespace StardewModdingAPI.Metadata
                 new PropertyFinder("StardewModdingAPI.Mod", "PerSaveConfigFolder", InstructionHandleResult.NotCompatible),
                 new PropertyFinder("StardewModdingAPI.Mod", "PerSaveConfigPath", InstructionHandleResult.NotCompatible),
 
+                // broken code
+                new ReferenceToMissingMemberFinder(),
+                new ReferenceToMemberWithUnexpectedTypeFinder(),
+
                 /****
                 ** detect code which may impact game stability
                 ****/
@@ -74,27 +98,7 @@ namespace StardewModdingAPI.Metadata
                 new FieldFinder(typeof(SaveGame).FullName, nameof(SaveGame.serializer), InstructionHandleResult.DetectedSaveSerialiser),
                 new FieldFinder(typeof(SaveGame).FullName, nameof(SaveGame.farmerSerializer), InstructionHandleResult.DetectedSaveSerialiser),
                 new FieldFinder(typeof(SaveGame).FullName, nameof(SaveGame.locationSerializer), InstructionHandleResult.DetectedSaveSerialiser),
-                new EventFinder(typeof(SpecialisedEvents).FullName, nameof(SpecialisedEvents.UnvalidatedUpdateTick), InstructionHandleResult.DetectedUnvalidatedUpdateTick), 
-
-                /****
-                ** rewrite CIL to fix incompatible code
-                ****/
-                // crossplatform
-                new MethodParentRewriter(typeof(SpriteBatch), typeof(SpriteBatchMethods), onlyIfPlatformChanged: true),
-
-                // Stardew Valley 1.2
-                new FieldToPropertyRewriter(typeof(Game1), nameof(Game1.activeClickableMenu)),
-                new FieldToPropertyRewriter(typeof(Game1), nameof(Game1.currentMinigame)),
-                new FieldToPropertyRewriter(typeof(Game1), nameof(Game1.gameMode)),
-                new FieldToPropertyRewriter(typeof(Game1), nameof(Game1.player)),
-                new FieldReplaceRewriter(typeof(Game1), "borderFont", nameof(Game1.smallFont)),
-                new FieldReplaceRewriter(typeof(Game1), "smoothFont", nameof(Game1.smallFont)),
-
-                // SMAPI 1.9
-                new TypeReferenceRewriter("StardewModdingAPI.Inheritance.ItemStackChange", typeof(ItemStackChange)),
-
-                // SMAPI 2.0
-                new VirtualEntryCallRemover() // Mod.Entry changed from virtual to abstract in SMAPI 2.0, which breaks the few mods which called base.Entry()
+                new EventFinder(typeof(SpecialisedEvents).FullName, nameof(SpecialisedEvents.UnvalidatedUpdateTick), InstructionHandleResult.DetectedUnvalidatedUpdateTick)
             };
         }
     }
diff --git a/src/SMAPI/StardewModdingAPI.csproj b/src/SMAPI/StardewModdingAPI.csproj
index 8ef3022f..a04208e4 100644
--- a/src/SMAPI/StardewModdingAPI.csproj
+++ b/src/SMAPI/StardewModdingAPI.csproj
@@ -103,6 +103,7 @@
     <Compile Include="Framework\ModLoading\Finders\FieldFinder.cs" />
     <Compile Include="Framework\ModLoading\Finders\MethodFinder.cs" />
     <Compile Include="Framework\ModLoading\Finders\PropertyFinder.cs" />
+    <Compile Include="Framework\ModLoading\Finders\ReferenceToMissingMemberFinder.cs" />
     <Compile Include="Framework\ModLoading\Finders\TypeFinder.cs" />
     <Compile Include="Framework\ModLoading\IInstructionHandler.cs" />
     <Compile Include="Framework\ModLoading\IncompatibleInstructionException.cs" />
@@ -112,6 +113,7 @@
     <Compile Include="Framework\ModLoading\RewriteHelper.cs" />
     <Compile Include="Framework\ModLoading\Rewriters\FieldReplaceRewriter.cs" />
     <Compile Include="Framework\ModLoading\Rewriters\FieldToPropertyRewriter.cs" />
+    <Compile Include="Framework\ModLoading\Rewriters\ReferenceToMemberWithUnexpectedTypeFinder.cs" />
     <Compile Include="Framework\ModLoading\Rewriters\VirtualEntryCallRemover.cs" />
     <Compile Include="Framework\ModLoading\Rewriters\MethodParentRewriter.cs" />
     <Compile Include="Framework\ModLoading\Rewriters\TypeReferenceRewriter.cs" />
-- 
cgit 


From 36a527956c5410fe5992bfc42fdc11adff9cd9db Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 3 Mar 2018 17:54:17 -0500
Subject: fix detected incompatibility errors not showing mod's update URL
 (#453)

---
 src/SMAPI/Program.cs | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/Program.cs b/src/SMAPI/Program.cs
index acab8c70..fec03d6f 100644
--- a/src/SMAPI/Program.cs
+++ b/src/SMAPI/Program.cs
@@ -388,7 +388,7 @@ namespace StardewModdingAPI
                 mods = resolver.ProcessDependencies(mods, modDatabase).ToArray();
 
                 // load mods
-                this.LoadMods(mods, this.JsonHelper, this.ContentManager);
+                this.LoadMods(mods, this.JsonHelper, this.ContentManager, modDatabase);
 
                 // check for updates
                 this.CheckForUpdatesAsync(mods);
@@ -670,7 +670,8 @@ namespace StardewModdingAPI
         /// <param name="mods">The mods to load.</param>
         /// <param name="jsonHelper">The JSON helper with which to read mods' JSON files.</param>
         /// <param name="contentManager">The content manager to use for mod content.</param>
-        private void LoadMods(IModMetadata[] mods, JsonHelper jsonHelper, SContentManager contentManager)
+        /// <param name="modDatabase">Handles access to SMAPI's internal mod metadata list.</param>
+        private void LoadMods(IModMetadata[] mods, JsonHelper jsonHelper, SContentManager contentManager, ModDatabase modDatabase)
         {
             this.Monitor.Log("Loading mods...", LogLevel.Trace);
 
@@ -744,9 +745,10 @@ namespace StardewModdingAPI
                     {
                         modAssembly = modAssemblyLoader.Load(metadata, assemblyPath, assumeCompatible: metadata.DataRecord?.Status == ModStatus.AssumeCompatible);
                     }
-                    catch (IncompatibleInstructionException ex)
+                    catch (IncompatibleInstructionException) // details already in trace logs
                     {
-                        TrackSkip(metadata, "it's no longer compatible. Please check for a newer version of the mod.");
+                        string url = modDatabase.GetModPageUrlFor(metadata.Manifest.UniqueID);
+                        TrackSkip(metadata, $"it's no longer compatible. Please check for a newer version of the mod{(url != null ? $" at {url}" : "")}.");
                         continue;
                     }
                     catch (SAssemblyLoadFailedException ex)
-- 
cgit 


From 47b9c5995e56fc8424dfeb4151d33a1080d3fc2b Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 3 Mar 2018 21:28:12 -0500
Subject: update compatibility list

---
 src/SMAPI/StardewModdingAPI.config.json | 47 ++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/StardewModdingAPI.config.json b/src/SMAPI/StardewModdingAPI.config.json
index c7527275..f6f4a1fa 100644
--- a/src/SMAPI/StardewModdingAPI.config.json
+++ b/src/SMAPI/StardewModdingAPI.config.json
@@ -189,6 +189,11 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "Default | UpdateKey": "Nexus:643"
     },
 
+    "AutoFish": {
+      "ID": "WhiteMind.AF",
+      "Default | UpdateKey": "Nexus:1895"
+    },
+
     "AutoGate": {
       "ID": "AutoGate",
       "Default | UpdateKey": "Nexus:820"
@@ -452,6 +457,11 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "Default | UpdateKey": "Nexus:638"
     },
 
+    "Custom Asset Modifier": {
+      "ID": "Omegasis.CustomAssetModifier",
+      "Default | UpdateKey": "1836"
+    },
+
     "Custom Critters": {
       "ID": "spacechase0.CustomCritters",
       "Default | UpdateKey": "Nexus:1255"
@@ -693,6 +703,11 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "Default | UpdateKey": "Nexus:1089"
     },
 
+    "Faster Grass": {
+      "ID": "IceGladiador.FasterGrass",
+      "Default | UpdateKey": "Nexus:1772"
+    },
+
     "Faster Paths": {
       "ID": "Entoarox.FasterPaths",
       "FormerIDs": "{ID:'821ce8f6-e629-41ad-9fde-03b54f68b0b6', Name:'Faster Paths'} | 615f85f8-5c89-44ee-aecc-c328f172e413", // changed in 1.2 and 1.3; disambiguate from Shop Expander
@@ -717,6 +732,11 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "Default | UpdateKey": "Chucklefish:4578"
     },
 
+    "Fixed Secret Woods Debris": {
+      "ID": "f4iTh.WoodsDebrisFix",
+      "Default | UpdateKey": "Nexus:1941"
+    },
+
     "FlorenceMod": {
       "ID": "{EntryDll: 'FlorenceMod.dll'}",
       "MapLocalVersions": { "1.0.1": "1.1" },
@@ -1005,6 +1025,11 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "~ | StatusReasonPhrase": "it's no longer maintained or used."
     },
 
+    "Monster Level Tip": {
+      "ID": "WhiteMind.MonsterLT",
+      "Default | UpdateKey": "Nexus:1896"
+    },
+
     "More Animals": {
       "ID": "Entoarox.MoreAnimals",
       "FormerIDs": "821ce8f6-e629-41ad-9fde-03b54f68b0b6MOREPETS | Entoarox.MorePets", // changed in 1.3 and 2.0
@@ -1056,6 +1081,11 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "~1.3    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
+    "Mushroom Level Tip": {
+      "ID": "WhiteMind.MLT",
+      "Default | UpdateKey": "Nexus:1894"
+    },
+
     "New Machines": {
       "ID": "F70D4FAB-0AB2-4B78-9F1B-AF2CA2236A59",
       "Default   | UpdateKey": "Chucklefish:3683",
@@ -1093,7 +1123,12 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "Default | UpdateKey": "Nexus:506" // added in 1.4.1
     },
 
-    "NoSoilDecay": {
+    "No Rumble Horse": {
+      "ID": "Xangria.NoRumbleHorse",
+      "Default | UpdateKey": "Nexus:1779"
+    },
+
+    "No Soil Decay": {
       "ID": "289dee03-5f38-4d8e-8ffc-e440198e8610",
       "Default | UpdateKey": "Nexus:237",
       "~0.5    | Status": "AssumeBroken", // broke in SDV 1.2 and uses Assembly.GetExecutingAssembly().Location
@@ -1162,6 +1197,11 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "Default | UpdateKey": "Nexus:1419"
     },
 
+    "Persistent Game Options": {
+      "ID": "Xangria.PersistentGameOptions",
+      "Default | UpdateKey": "Nexus:1778"
+    },
+
     "Persival's BundleMod": {
       "ID": "{EntryDll: 'BundleMod.dll'}",
       "Default | UpdateKey": "Nexus:438",
@@ -1323,6 +1363,11 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "Default | UpdateKey": "Nexus:1106"
     },
 
+    "SDV Twitch": {
+      "ID": "MTD.SDVTwitch",
+      "Default | UpdateKey": "Nexus:1760"
+    },
+
     "Seasonal Immersion": {
       "ID": "Entoarox.SeasonalImmersion",
       "FormerIDs": "EntoaroxSeasonalHouse | EntoaroxSeasonalBuildings | EntoaroxSeasonalImmersion", // changed in 1.1, 1.6 or earlier, and 1.7
-- 
cgit 


From f9dc901994c1a8b17e22de3f68ceb038965e0cc5 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 3 Mar 2018 22:03:41 -0500
Subject: fix error in new incompatibility finders when they resolve members in
 a dependency (#453)

---
 .../ModLoading/AssemblyDefinitionResolver.cs       |  2 +-
 src/SMAPI/Framework/ModLoading/AssemblyLoader.cs   | 24 ++++++++++++++--------
 2 files changed, 17 insertions(+), 9 deletions(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs b/src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs
index 4378798c..d85a9a28 100644
--- a/src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs
+++ b/src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs
@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Mono.Cecil;
 
 namespace StardewModdingAPI.Framework.ModLoading
diff --git a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
index f0e186a1..a60f63da 100644
--- a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
+++ b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
@@ -16,17 +16,20 @@ namespace StardewModdingAPI.Framework.ModLoading
         /*********
         ** Properties
         *********/
+        /// <summary>Encapsulates monitoring and logging.</summary>
+        private readonly IMonitor Monitor;
+
+        /// <summary>Whether to enable developer mode logging.</summary>
+        private readonly bool IsDeveloperMode;
+
         /// <summary>Metadata for mapping assemblies to the current platform.</summary>
         private readonly PlatformAssemblyMap AssemblyMap;
 
         /// <summary>A type => assembly lookup for types which should be rewritten.</summary>
         private readonly IDictionary<string, Assembly> TypeAssemblies;
 
-        /// <summary>Encapsulates monitoring and logging.</summary>
-        private readonly IMonitor Monitor;
-
-        /// <summary>Whether to enable developer mode logging.</summary>
-        private readonly bool IsDeveloperMode;
+        /// <summary>A minimal assembly definition resolver which resolves references to known loaded assemblies.</summary>
+        private readonly AssemblyDefinitionResolver AssemblyDefinitionResolver;
 
 
         /*********
@@ -41,6 +44,7 @@ namespace StardewModdingAPI.Framework.ModLoading
             this.Monitor = monitor;
             this.IsDeveloperMode = isDeveloperMode;
             this.AssemblyMap = Constants.GetAssemblyMap(targetPlatform);
+            this.AssemblyDefinitionResolver = new AssemblyDefinitionResolver();
 
             // generate type => assembly lookup for types which should be rewritten
             this.TypeAssemblies = new Dictionary<string, Assembly>();
@@ -69,9 +73,8 @@ namespace StardewModdingAPI.Framework.ModLoading
             // get referenced local assemblies
             AssemblyParseResult[] assemblies;
             {
-                AssemblyDefinitionResolver resolver = new AssemblyDefinitionResolver();
                 HashSet<string> visitedAssemblyNames = new HashSet<string>(AppDomain.CurrentDomain.GetAssemblies().Select(p => p.GetName().Name)); // don't try loading assemblies that are already loaded
-                assemblies = this.GetReferencedLocalAssemblies(new FileInfo(assemblyPath), visitedAssemblyNames, resolver).ToArray();
+                assemblies = this.GetReferencedLocalAssemblies(new FileInfo(assemblyPath), visitedAssemblyNames, this.AssemblyDefinitionResolver).ToArray();
             }
 
             // validate load
@@ -94,7 +97,10 @@ namespace StardewModdingAPI.Framework.ModLoading
                 if (assembly.Status == AssemblyLoadStatus.AlreadyLoaded)
                     continue;
 
+                // rewrite assembly
                 bool changed = this.RewriteAssembly(mod, assembly.Definition, assumeCompatible, loggedMessages, logPrefix: "   ");
+
+                // load assembly
                 if (changed)
                 {
                     if (!oneAssembly)
@@ -112,6 +118,9 @@ namespace StardewModdingAPI.Framework.ModLoading
                         this.Monitor.Log($"   Loading {assembly.File.Name}...", LogLevel.Trace);
                     lastAssembly = Assembly.UnsafeLoadFrom(assembly.File.FullName);
                 }
+
+                // track loaded assembly for definition resolution
+                this.AssemblyDefinitionResolver.Add(assembly.Definition);
             }
 
             // last assembly loaded is the root
@@ -166,7 +175,6 @@ namespace StardewModdingAPI.Framework.ModLoading
                 yield return new AssemblyParseResult(file, null, AssemblyLoadStatus.AlreadyLoaded);
                 yield break;
             }
-
             visitedAssemblyNames.Add(assembly.Name.Name);
 
             // yield referenced assemblies
-- 
cgit 


From a290a2fa5229a1105942300c5ccd471a34915758 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 3 Mar 2018 22:18:44 -0500
Subject: mark Stardew Valley 1.3 incompatible in SMAPI 2.5.x to reduce
 confusion when it's released (#453)

---
 src/SMAPI/Constants.cs | 2 +-
 src/SMAPI/Program.cs   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/Constants.cs b/src/SMAPI/Constants.cs
index fe9fdf9b..c5e378e2 100644
--- a/src/SMAPI/Constants.cs
+++ b/src/SMAPI/Constants.cs
@@ -43,7 +43,7 @@ namespace StardewModdingAPI
         public static ISemanticVersion MinimumGameVersion { get; } = new SemanticVersion("1.2.30");
 
         /// <summary>The maximum supported version of Stardew Valley.</summary>
-        public static ISemanticVersion MaximumGameVersion { get; } = null;
+        public static ISemanticVersion MaximumGameVersion { get; } = new SemanticVersion("1.2.33");
 
         /// <summary>The path to the game folder.</summary>
         public static string ExecutionPath { get; } = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
diff --git a/src/SMAPI/Program.cs b/src/SMAPI/Program.cs
index fec03d6f..22bceafd 100644
--- a/src/SMAPI/Program.cs
+++ b/src/SMAPI/Program.cs
@@ -177,7 +177,7 @@ namespace StardewModdingAPI
                 }
                 if (Constants.MaximumGameVersion != null && Constants.GameVersion.IsNewerThan(Constants.MaximumGameVersion))
                 {
-                    this.Monitor.Log($"Oops! You're running Stardew Valley {Constants.GameVersion}, but this version of SMAPI is only compatible up to Stardew Valley {Constants.MaximumGameVersion}. Please check for a newer version of SMAPI.", LogLevel.Error);
+                    this.Monitor.Log($"Oops! You're running Stardew Valley {Constants.GameVersion}, but this version of SMAPI is only compatible up to Stardew Valley {Constants.MaximumGameVersion}. Please check for a newer version of SMAPI: https://smapi.io.", LogLevel.Error);
                     this.PressAnyKeyToExit();
                     return;
                 }
-- 
cgit 


From 01579d63f37e3f2bd48c6e4502047f894ee4e133 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 4 Mar 2018 00:31:48 -0500
Subject: fix default update key not applied if mod sets a blank update key

---
 src/SMAPI/Framework/ModData/ModDataField.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/Framework/ModData/ModDataField.cs b/src/SMAPI/Framework/ModData/ModDataField.cs
index fa8dd6d0..df906103 100644
--- a/src/SMAPI/Framework/ModData/ModDataField.cs
+++ b/src/SMAPI/Framework/ModData/ModDataField.cs
@@ -66,7 +66,7 @@ namespace StardewModdingAPI.Framework.ModData
             {
                 // update key
                 case ModDataFieldKey.UpdateKey:
-                    return manifest.UpdateKeys != null && manifest.UpdateKeys.Any();
+                    return manifest.UpdateKeys != null && manifest.UpdateKeys.Any(p => !string.IsNullOrWhiteSpace(p));
 
                 // non-manifest fields
                 case ModDataFieldKey.AlternativeUrl:
-- 
cgit 


From a9714b78970119583f01b81499e96ab1e47b412b Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 4 Mar 2018 00:44:07 -0500
Subject: fix data for some old mods with no ID

---
 src/SMAPI/StardewModdingAPI.config.json | 34 ++++++++++++++++-----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/StardewModdingAPI.config.json b/src/SMAPI/StardewModdingAPI.config.json
index f6f4a1fa..101b9dac 100644
--- a/src/SMAPI/StardewModdingAPI.config.json
+++ b/src/SMAPI/StardewModdingAPI.config.json
@@ -350,7 +350,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Choose Baby Gender": {
-      "ID": "{EntryDll: 'ChooseBabyGender.dll'}",
+      "FormerIDs": "{EntryDll: 'ChooseBabyGender.dll'}",
       "Default | UpdateKey": "Nexus:590",
       "~1.0.2  | Status": "AssumeBroken", // broke in SMAPI 2.0
       "~1.0.2  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
@@ -666,13 +666,13 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Farm Automation: Barn Door Automation": {
-      "ID": "{EntryDll: 'FarmAutomation.BarnDoorAutomation.dll'}",
+      "FormerIDs": "{EntryDll: 'FarmAutomation.BarnDoorAutomation.dll'}",
       "~1.0 | Status": "AssumeBroken", // broke in SMAPI 2.0
       "~1.0 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
     },
 
     "Farm Automation: Item Collector": {
-      "ID": "{EntryDll: 'FarmAutomation.ItemCollector.dll'}",
+      "FormerIDs": "{EntryDll: 'FarmAutomation.ItemCollector.dll'}",
       "~1.0 | Status": "AssumeBroken", // broke in SDV 1.2
       "~1.0 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
     },
@@ -692,7 +692,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Farm Resource Generator": {
-      "ID": "{EntryDll: 'FarmResourceGenerator.dll'}",
+      "FormerIDs": "{EntryDll: 'FarmResourceGenerator.dll'}",
       "Default | UpdateKey": "Nexus:647",
       "~1.0.4  | Status": "AssumeBroken", // broke in SMAPI 2.0
       "~1.0.4  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
@@ -738,7 +738,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "FlorenceMod": {
-      "ID": "{EntryDll: 'FlorenceMod.dll'}",
+      "FormerIDs": "{EntryDll: 'FlorenceMod.dll'}",
       "MapLocalVersions": { "1.0.1": "1.1" },
       "Default | UpdateKey": "Nexus:591",
       "~1.1    | Status": "AssumeBroken", // broke in SMAPI 2.0
@@ -824,7 +824,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Happy Birthday (Oxyligen fork)": {
-      "ID": "{ID:'HappyBirthday', Author:'Alpha_Omegasis/Oxyligen'}", // disambiguate from Oxyligen's fork
+      "FormerIDs": "{ID:'HappyBirthday', Author:'Alpha_Omegasis/Oxyligen'}", // disambiguate from Oxyligen's fork
       "Default | UpdateKey": "Nexus:1064"
     },
 
@@ -1148,7 +1148,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "NPC Speak": {
-      "ID": "{EntryDll: 'NpcEcho.dll'}",
+      "FormerIDs": "{EntryDll: 'NpcEcho.dll'}",
       "Default | UpdateKey": "Nexus:694",
       "~1.0    | Status": "AssumeBroken", // broke in SMAPI 2.0
       "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
@@ -1203,7 +1203,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Persival's BundleMod": {
-      "ID": "{EntryDll: 'BundleMod.dll'}",
+      "FormerIDs": "{EntryDll: 'BundleMod.dll'}",
       "Default | UpdateKey": "Nexus:438",
       "~1.0    | Status": "AssumeBroken", // broke in SDV 1.1
       "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
@@ -1250,7 +1250,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Rain Randomizer": {
-      "ID": "{EntryDll: 'RainRandomizer.dll'}",
+      "FormerIDs": "{EntryDll: 'RainRandomizer.dll'}",
       "~1.0.3 | Status": "AssumeBroken", // broke in SMAPI 2.0
       "~1.0.3 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
     },
@@ -1575,7 +1575,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "StaminaRegen": {
-      "ID": "{EntryDll: 'StaminaRegen.dll'}",
+      "FormerIDs": "{EntryDll: 'StaminaRegen.dll'}",
       "~1.0.3 | Status": "AssumeBroken", // broke in SMAPI 2.0
       "~1.0.3 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
     },
@@ -1636,7 +1636,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Stone Bridge Over Pond (PondWithBridge)": {
-      "ID": "{EntryDll: 'PondWithBridge.dll'}",
+      "FormerIDs": "{EntryDll: 'PondWithBridge.dll'}",
       "MapLocalVersions": { "0.0": "1.0" },
       "Default | UpdateKey": "Nexus:316",
       "~1.0    | Status": "AssumeBroken" // broke in SMAPI 2.0
@@ -1660,7 +1660,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Tainted Cellar": {
-      "ID": "{EntryDll: 'TaintedCellar.dll'}",
+      "FormerIDs": "{EntryDll: 'TaintedCellar.dll'}",
       "~1.0 | Status": "AssumeBroken", // broke in SDV 1.1 or 1.11
       "~1.0 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
     },
@@ -1753,13 +1753,13 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "WakeUp": {
-      "ID": "{EntryDll: 'WakeUp.dll'}",
+      "FormerIDs": "{EntryDll: 'WakeUp.dll'}",
       "~1.0.2 | Status": "AssumeBroken", // broke in SMAPI 2.0
       "~1.0.2 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
     },
 
     "Wallpaper Fix": {
-      "ID": "{EntryDll: 'WallpaperFix.dll'}",
+      "FormerIDs": "{EntryDll: 'WallpaperFix.dll'}",
       "Default | UpdateKey": "Chucklefish:4211",
       "~1.1    | Status": "AssumeBroken", // broke in SMAPI 2.0
       "~1.1    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
@@ -1771,7 +1771,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Weather Controller": {
-      "ID": "{EntryDll: 'WeatherController.dll'}",
+      "FormerIDs": "{EntryDll: 'WeatherController.dll'}",
       "~1.0.2 | Status": "AssumeBroken", // broke in SDV 1.2
       "~1.0.2 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
     },
@@ -1787,13 +1787,13 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     },
 
     "Wonderful Farm Life": {
-      "ID": "{EntryDll: 'WonderfulFarmLife.dll'}",
+      "FormerIDs": "{EntryDll: 'WonderfulFarmLife.dll'}",
       "~1.0 | Status": "AssumeBroken", // broke in SDV 1.1 or 1.11
       "~1.0 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
     },
 
     "XmlSerializerRetool": {
-      "ID": "{EntryDll: 'XmlSerializerRetool.dll'}",
+      "FormerIDs": "{EntryDll: 'XmlSerializerRetool.dll'}",
       "~ | Status": "Obsolete",
       "~ | StatusReasonPhrase": "it's no longer maintained or used."
     },
-- 
cgit 


From 19570f43129dbd3dbfa77a9c62e135a72528a68e Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 4 Mar 2018 01:07:55 -0500
Subject: simplify and always include default update URL, shorten
 no-longer-compatible skip messages

---
 src/SMAPI/Framework/ModLoading/ModResolver.cs |   5 +-
 src/SMAPI/Program.cs                          |   5 +-
 src/SMAPI/StardewModdingAPI.config.json       | 201 +++++++++-----------------
 3 files changed, 74 insertions(+), 137 deletions(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/Framework/ModLoading/ModResolver.cs b/src/SMAPI/Framework/ModLoading/ModResolver.cs
index ba6dab1a..f878a1b9 100644
--- a/src/SMAPI/Framework/ModLoading/ModResolver.cs
+++ b/src/SMAPI/Framework/ModLoading/ModResolver.cs
@@ -98,7 +98,7 @@ namespace StardewModdingAPI.Framework.ModLoading
                     case ModStatus.AssumeBroken:
                         {
                             // get reason
-                            string reasonPhrase = mod.DataRecord.StatusReasonPhrase ?? "it's no longer compatible";
+                            string reasonPhrase = mod.DataRecord.StatusReasonPhrase ?? "it's outdated";
 
                             // get update URLs
                             List<string> updateUrls = new List<string>();
@@ -111,6 +111,9 @@ namespace StardewModdingAPI.Framework.ModLoading
                             if (mod.DataRecord.AlternativeUrl != null)
                                 updateUrls.Add(mod.DataRecord.AlternativeUrl);
 
+                            // default update URL
+                            updateUrls.Add("https://smapi.io/compat");
+
                             // build error
                             string error = $"{reasonPhrase}. Please check for a ";
                             if (mod.DataRecord.StatusUpperVersion == null || mod.Manifest.Version.Equals(mod.DataRecord.StatusUpperVersion))
diff --git a/src/SMAPI/Program.cs b/src/SMAPI/Program.cs
index 22bceafd..979f6328 100644
--- a/src/SMAPI/Program.cs
+++ b/src/SMAPI/Program.cs
@@ -747,8 +747,9 @@ namespace StardewModdingAPI
                     }
                     catch (IncompatibleInstructionException) // details already in trace logs
                     {
-                        string url = modDatabase.GetModPageUrlFor(metadata.Manifest.UniqueID);
-                        TrackSkip(metadata, $"it's no longer compatible. Please check for a newer version of the mod{(url != null ? $" at {url}" : "")}.");
+                        string[] updateUrls = new[] { modDatabase.GetModPageUrlFor(metadata.Manifest.UniqueID), "https://smapi.io/compat" }.Where(p => p != null).ToArray();
+
+                        TrackSkip(metadata, $"it's outdated. Please check for a new version at {string.Join(" or ", updateUrls)}.");
                         continue;
                     }
                     catch (SAssemblyLoadFailedException ex)
diff --git a/src/SMAPI/StardewModdingAPI.config.json b/src/SMAPI/StardewModdingAPI.config.json
index 101b9dac..437feea5 100644
--- a/src/SMAPI/StardewModdingAPI.config.json
+++ b/src/SMAPI/StardewModdingAPI.config.json
@@ -97,15 +97,13 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "ID": "AccessChestAnywhere",
       "MapLocalVersions": { "1.1-1078": "1.1" },
       "Default | UpdateKey": "Nexus:257",
-      "~1.1    | Status": "AssumeBroken",
-      "~1.1    | AlternativeUrl": "https://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.1    | Status": "AssumeBroken"
     },
 
     "AdjustArtisanPrices": {
       "ID": "1e36d4ca-c7ef-4dfb-9927-d27a6c3c8bdc",
       "Default | UpdateKey": "Chucklefish:3532",
-      "~0.1    | Status": "AssumeBroken",
-      "~0.1    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~0.1    | Status": "AssumeBroken"
     },
 
     "Adjust Monster": {
@@ -127,8 +125,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "AgingMod": {
       "ID": "skn.AgingMod",
       "Default | UpdateKey": "Nexus:1129",
-      "~1.0    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "All Crops All Seasons": {
@@ -173,8 +170,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "A Tapper's Dream": {
       "ID": "ddde5195-8f85-4061-90cc-0d4fd5459358",
       "Default | UpdateKey": "Nexus:260",
-      "~1.4    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.4    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.4    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Auto Animal Doors": {
@@ -247,16 +243,14 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "ID": "Kithio:BetterShippingBox",
       "MapLocalVersions": { "1.0.1": "1.0.2" },
       "Default | UpdateKey": "Chucklefish:4302",
-      "~1.0.2  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0.2  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0.2  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Better Sprinklers": {
       "ID": "Speeder.BetterSprinklers",
       "FormerIDs": "SPDSprinklersMod", // changed in 2.3
       "Default                   | UpdateKey": "Nexus:41",
-      "~2.3.1-pathoschild-update | Status": "AssumeBroken", // broke in SDV 1.2
-      "~2.3.1-pathoschild-update | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~2.3.1-pathoschild-update | Status": "AssumeBroken" // broke in SDV 1.2
     },
 
     "Billboard Anywhere": {
@@ -269,8 +263,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "ID": "KathrynHazuka.BirthdayMail",
       "FormerIDs": "005e02dc-d900-425c-9c68-1ff55c5a295d", // changed in 1.2.3-pathoschild-update
       "Default | UpdateKey": "Nexus:276",
-      "~1.2.2  | Status": "AssumeBroken", // broke in SDV 1.2
-      "~1.2.2  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.2.2  | Status": "AssumeBroken" // broke in SDV 1.2
     },
 
     "Breed Like Rabbits": {
@@ -331,8 +324,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "ID": "Speeder.ChestLabel",
       "FormerIDs": "SPDChestLabel", // changed in 1.5.1-pathoschild-update
       "Default | UpdateKey": "Nexus:242",
-      "~1.6    | Status": "AssumeBroken", // broke in SDV 1.1
-      "~1.6    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.6    | Status": "AssumeBroken" // broke in SDV 1.1
     },
 
     "Chest Pooling": {
@@ -352,8 +344,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Choose Baby Gender": {
       "FormerIDs": "{EntryDll: 'ChooseBabyGender.dll'}",
       "Default | UpdateKey": "Nexus:590",
-      "~1.0.2  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0.2  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0.2  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "CJB Automation": {
@@ -398,8 +389,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Cold Weather Haley": {
       "ID": "LordXamon.ColdWeatherHaleyPRO",
       "Default | UpdateKey": "Nexus:1169",
-      "~1.0    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Colored Chests": {
@@ -411,8 +401,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Combat with Farm Implements": {
       "ID": "SPDFarmingImplementsInCombat",
       "Default | UpdateKey": "Nexus:313",
-      "~1.0    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Community Bundle Item Tooltip": {
@@ -434,8 +423,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Configurable Shipping Dates": {
       "ID": "ConfigurableShippingDates",
       "Default | UpdateKey": "Nexus:675",
-      "~1.1.1  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.1.1  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.1.1  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Cooking Skill": {
@@ -515,8 +503,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Customizable Traveling Cart Days": {
       "ID": "TravelingCartYyeahdude",
       "Default | UpdateKey": "Nexus:567",
-      "~1.0    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Custom Linens": {
@@ -566,8 +553,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Dynamic Checklist": {
       "ID": "gunnargolf.DynamicChecklist",
       "Default | UpdateKey": "Nexus:1145", // added in 1.0.1-pathoschild-update
-      "~1.0    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Dynamic Horses": {
@@ -580,8 +566,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "ID": "DynamicMachines",
       "MapLocalVersions": { "1.1": "1.1.1" },
       "Default | UpdateKey": "Nexus:374",
-      "~1.1.1  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.1.1  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.1.1  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Dynamic NPC Sprites": {
@@ -597,16 +582,14 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Empty Hands": {
       "ID": "QuicksilverFox.EmptyHands",
       "Default | UpdateKey": "Nexus:1176", // added in 1.0.1-pathoschild-update
-      "~1.0    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Enemy Health Bars": {
       "ID": "Speeder.HealthBars",
       "FormerIDs": "SPDHealthBar", // changed in 1.7.1-pathoschild-update
       "Default | UpdateKey": "Nexus:193",
-      "~1.7    | Status": "AssumeBroken", // broke in SDV 1.2
-      "~1.7    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.7    | Status": "AssumeBroken" // broke in SDV 1.2
     },
 
     "Entoarox Framework": {
@@ -636,15 +619,13 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "ID": "Crystalmir.ExtendedFridge",
       "FormerIDs": "Mystra007ExtendedFridge", // changed in 1.0.1
       "Default | UpdateKey": "Nexus:485",
-      "~1.0    | Status": "AssumeBroken", // broke in SDV 1.2
-      "~1.0    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0    | Status": "AssumeBroken" // broke in SDV 1.2
     },
 
     "Extended Greenhouse": {
       "ID": "ExtendedGreenhouse",
       "Default | UpdateKey": "Chucklefish:4303",
-      "~1.0.2  | Status": "AssumeBroken", // broke in SDV 1.2
-      "~1.0.2  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0.2  | Status": "AssumeBroken" // broke in SDV 1.2
     },
 
     "Extended Minecart": {
@@ -667,35 +648,30 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
 
     "Farm Automation: Barn Door Automation": {
       "FormerIDs": "{EntryDll: 'FarmAutomation.BarnDoorAutomation.dll'}",
-      "~1.0 | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0 | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Farm Automation: Item Collector": {
       "FormerIDs": "{EntryDll: 'FarmAutomation.ItemCollector.dll'}",
-      "~1.0 | Status": "AssumeBroken", // broke in SDV 1.2
-      "~1.0 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0 | Status": "AssumeBroken" // broke in SDV 1.2
     },
 
     "Farm Automation Unofficial: Item Collector": {
       "ID": "Maddy99.FarmAutomation.ItemCollector",
-      "~0.5 | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~0.5 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~0.5 | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Farm Expansion": {
       "ID": "Advize.FarmExpansion",
       "FormerIDs": "3888bdfd-73f6-4776-8bb7-8ad45aea1915 | AdvizeFarmExpansionMod-2-0 | AdvizeFarmExpansionMod-2-0-5", // changed in 2.0, 2.0.5, and 3.0
       "Default | UpdateKey": "Nexus:130",
-      "~2.0.5  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~2.0.5  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~2.0.5  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Farm Resource Generator": {
       "FormerIDs": "{EntryDll: 'FarmResourceGenerator.dll'}",
       "Default | UpdateKey": "Nexus:647",
-      "~1.0.4  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0.4  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0.4  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Fast Animations": {
@@ -718,8 +694,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "ID": "KathrynHazuka.FasterRun",
       "FormerIDs": "{EntryDll: 'FasterRun.dll'}", // changed in 1.1.1-pathoschild-update
       "Default | UpdateKey": "Nexus:733", // added in 1.1.1-pathoschild-update
-      "~1.1    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.1    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.1    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Fishing Adjust": {
@@ -741,8 +716,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "FormerIDs": "{EntryDll: 'FlorenceMod.dll'}",
       "MapLocalVersions": { "1.0.1": "1.1" },
       "Default | UpdateKey": "Nexus:591",
-      "~1.1    | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.1    | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.1    | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Flower Color Picker": {
@@ -753,8 +727,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Forage at the Farm": {
       "ID": "ForageAtTheFarm",
       "Default | UpdateKey": "Nexus:673",
-      "~1.5.1  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.5.1  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.5.1  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Furniture Anywhere": {
@@ -812,8 +785,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
 
     "Happy Animals": {
       "ID": "HappyAnimals",
-      "~1.0.3 | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0.3 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0.3 | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Happy Birthday (Omegasis)": {
@@ -841,8 +813,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Harvest With Scythe": {
       "ID": "965169fd-e1ed-47d0-9f12-b104535fb4bc",
       "Default | UpdateKey": "Nexus:236",
-      "~1.0.6  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0.6  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0.6  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Horse Whistle (icepuente)": {
@@ -858,8 +829,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Hunger for Food (Tigerle)": {
       "ID": "HungerForFoodByTigerle",
       "Default | UpdateKey": "Nexus:810",
-      "~0.1.2  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~0.1.2  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~0.1.2  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Hunger Mod (skn)": {
@@ -882,8 +852,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
 
     "Instant Geode": {
       "ID": "InstantGeode",
-      "~1.12 | Status": "AssumeBroken", // broke in SDV 1.2
-      "~1.12 | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.12 | Status": "AssumeBroken" // broke in SDV 1.2
     },
 
     "Instant Grow Trees": {
@@ -895,8 +864,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
     "Interaction Helper": {
       "ID": "HammurabiInteractionHelper",
       "Default | UpdateKey": "Chucklefish:4640", // added in 1.0.4-pathoschild-update
-      "~1.0.3  | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.0.3  | AlternativeUrl": "http://stardewvalleywiki.com/Modding:SMAPI_2.0"
+      "~1.0.3  | Status": "AssumeBroken" // broke in SMAPI 2.0
     },
 
     "Item Auto Stacker": {
@@ -926,8 +894,7 @@ This file contains advanced configuration for SMAPI. You generally shouldn't cha
       "ID": "BALANCEMOD_AntiExhaustion",
       "MapLocalVersions": { "0.0": "1.1" },
       "Default | UpdateKey": "Nexus:637",
-      "~1.1 | Status": "AssumeBroken", // broke in SMAPI 2.0
-      "~1.1 | AlternativeUrl"