From 104aa314127bd816d5dbcac8c57ecb84b12f20d1 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Tue, 14 Mar 2017 20:48:02 -0400
Subject: let players override SMAPI incompatible-code detection if needed

---
 .../Framework/Models/IncompatibleMod.cs            | 65 ----------------------
 .../Framework/Models/ModCompatibility.cs           | 65 ++++++++++++++++++++++
 .../Framework/Models/ModCompatibilityType.cs       | 12 ++++
 src/StardewModdingAPI/Framework/Models/SConfig.cs  |  4 +-
 4 files changed, 79 insertions(+), 67 deletions(-)
 delete mode 100644 src/StardewModdingAPI/Framework/Models/IncompatibleMod.cs
 create mode 100644 src/StardewModdingAPI/Framework/Models/ModCompatibility.cs
 create mode 100644 src/StardewModdingAPI/Framework/Models/ModCompatibilityType.cs

(limited to 'src/StardewModdingAPI/Framework/Models')

diff --git a/src/StardewModdingAPI/Framework/Models/IncompatibleMod.cs b/src/StardewModdingAPI/Framework/Models/IncompatibleMod.cs
deleted file mode 100644
index 29e18ddb..00000000
--- a/src/StardewModdingAPI/Framework/Models/IncompatibleMod.cs
+++ /dev/null
@@ -1,65 +0,0 @@
-using System.Runtime.Serialization;
-using Newtonsoft.Json;
-
-namespace StardewModdingAPI.Framework.Models
-{
-    /// <summary>Contains abstract metadata about an incompatible mod.</summary>
-    internal class IncompatibleMod
-    {
-        /*********
-        ** Accessors
-        *********/
-        /****
-        ** From config
-        ****/
-        /// <summary>The unique mod ID.</summary>
-        public string ID { get; set; }
-
-        /// <summary>The mod name.</summary>
-        public string Name { get; set; }
-
-        /// <summary>The oldest incompatible mod version, or <c>null</c> for all past versions.</summary>
-        public string LowerVersion { get; set; }
-
-        /// <summary>The most recent incompatible mod version.</summary>
-        public string UpperVersion { get; set; }
-
-        /// <summary>The URL the user can check for an official updated version.</summary>
-        public string UpdateUrl { get; set; }
-
-        /// <summary>The URL the user can check for an unofficial updated version.</summary>
-        public string UnofficialUpdateUrl { get; set; }
-
-        /// <summary>A regular expression matching version strings to consider compatible, even if they technically precede <see cref="UpperVersion"/>.</summary>
-        public string ForceCompatibleVersion { get; set; }
-
-        /// <summary>The reason phrase to show in the warning, or <c>null</c> to use the default value.</summary>
-        /// <example>"this version is incompatible with the latest version of the game"</example>
-        public string ReasonPhrase { get; set; }
-
-
-        /****
-        ** Injected
-        ****/
-        /// <summary>The semantic version corresponding to <see cref="LowerVersion"/>.</summary>
-        [JsonIgnore]
-        public ISemanticVersion LowerSemanticVersion { get; set; }
-
-        /// <summary>The semantic version corresponding to <see cref="UpperVersion"/>.</summary>
-        [JsonIgnore]
-        public ISemanticVersion UpperSemanticVersion { get; set; }
-
-
-        /*********
-        ** Private methods
-        *********/
-        /// <summary>The method called when the model finishes deserialising.</summary>
-        /// <param name="context">The deserialisation context.</param>
-        [OnDeserialized]
-        private void OnDeserialized(StreamingContext context)
-        {
-            this.LowerSemanticVersion = this.LowerVersion != null ? new SemanticVersion(this.LowerVersion) : null;
-            this.UpperSemanticVersion = this.UpperVersion != null ? new SemanticVersion(this.UpperVersion) : null;
-        }
-    }
-}
diff --git a/src/StardewModdingAPI/Framework/Models/ModCompatibility.cs b/src/StardewModdingAPI/Framework/Models/ModCompatibility.cs
new file mode 100644
index 00000000..1e71dae0
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/Models/ModCompatibility.cs
@@ -0,0 +1,65 @@
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+
+namespace StardewModdingAPI.Framework.Models
+{
+    /// <summary>Metadata about a mod version that SMAPI should assume is compatible or broken, regardless of whether it detects incompatible code.</summary>
+    internal class ModCompatibility
+    {
+        /*********
+        ** Accessors
+        *********/
+        /****
+        ** From config
+        ****/
+        /// <summary>The unique mod ID.</summary>
+        public string ID { get; set; }
+
+        /// <summary>The mod name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The oldest incompatible mod version, or <c>null</c> for all past versions.</summary>
+        public string LowerVersion { get; set; }
+
+        /// <summary>The most recent incompatible mod version.</summary>
+        public string UpperVersion { get; set; }
+
+        /// <summary>The URL the user can check for an official updated version.</summary>
+        public string UpdateUrl { get; set; }
+
+        /// <summary>The URL the user can check for an unofficial updated version.</summary>
+        public string UnofficialUpdateUrl { get; set; }
+
+        /// <summary>The reason phrase to show in the warning, or <c>null</c> to use the default value.</summary>
+        /// <example>"this version is incompatible with the latest version of the game"</example>
+        public string ReasonPhrase { get; set; }
+
+        /// <summary>Indicates how SMAPI should consider the mod.</summary>
+        public ModCompatibilityType Compatibility { get; set; }
+
+
+        /****
+        ** Injected
+        ****/
+        /// <summary>The semantic version corresponding to <see cref="LowerVersion"/>.</summary>
+        [JsonIgnore]
+        public ISemanticVersion LowerSemanticVersion { get; set; }
+
+        /// <summary>The semantic version corresponding to <see cref="UpperVersion"/>.</summary>
+        [JsonIgnore]
+        public ISemanticVersion UpperSemanticVersion { get; set; }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>The method called when the model finishes deserialising.</summary>
+        /// <param name="context">The deserialisation context.</param>
+        [OnDeserialized]
+        private void OnDeserialized(StreamingContext context)
+        {
+            this.LowerSemanticVersion = this.LowerVersion != null ? new SemanticVersion(this.LowerVersion) : null;
+            this.UpperSemanticVersion = this.UpperVersion != null ? new SemanticVersion(this.UpperVersion) : null;
+        }
+    }
+}
diff --git a/src/StardewModdingAPI/Framework/Models/ModCompatibilityType.cs b/src/StardewModdingAPI/Framework/Models/ModCompatibilityType.cs
new file mode 100644
index 00000000..35edec5e
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/Models/ModCompatibilityType.cs
@@ -0,0 +1,12 @@
+namespace StardewModdingAPI.Framework.Models
+{
+    /// <summary>Indicates how SMAPI should consider a mod.</summary>
+    internal enum ModCompatibilityType
+    {
+        /// <summary>Assume the mod is not compatible, even if SMAPI doesn't detect any incompatible code.</summary>
+        AssumeBroken = 0,
+
+        /// <summary>Assume the mod is compatible, even if SMAPI detects incompatible code.</summary>
+        AssumeCompatible = 1
+    }
+}
diff --git a/src/StardewModdingAPI/Framework/Models/SConfig.cs b/src/StardewModdingAPI/Framework/Models/SConfig.cs
index 558da82a..0de96297 100644
--- a/src/StardewModdingAPI/Framework/Models/SConfig.cs
+++ b/src/StardewModdingAPI/Framework/Models/SConfig.cs
@@ -12,7 +12,7 @@
         /// <summary>Whether to check if a newer version of SMAPI is available on startup.</summary>
         public bool CheckForUpdates { get; set; } = true;
 
-        /// <summary>A list of mod versions which should be considered incompatible.</summary>
-        public IncompatibleMod[] IncompatibleMods { get; set; }
+        /// <summary>A list of mod versions which should be considered compatible or incompatible regardless of whether SMAPI detects incompatible code.</summary>
+        public ModCompatibility[] ModCompatibility { get; set; }
     }
 }
-- 
cgit