summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/Models/Manifest.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI/Framework/Models/Manifest.cs')
-rw-r--r--src/StardewModdingAPI/Framework/Models/Manifest.cs51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/Framework/Models/Manifest.cs b/src/StardewModdingAPI/Framework/Models/Manifest.cs
new file mode 100644
index 00000000..29c3517e
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/Models/Manifest.cs
@@ -0,0 +1,51 @@
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using StardewModdingAPI.Framework.Serialisation;
+
+namespace StardewModdingAPI.Framework.Models
+{
+ /// <summary>A manifest which describes a mod for SMAPI.</summary>
+ internal class Manifest : IManifest
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The mod name.</summary>
+ public string Name { get; set; }
+
+ /// <summary>A brief description of the mod.</summary>
+ public string Description { get; set; }
+
+ /// <summary>The mod author's name.</summary>
+ public string Author { get; set; }
+
+ /// <summary>The mod version.</summary>
+ [JsonConverter(typeof(SFieldConverter))]
+ public ISemanticVersion Version { get; set; }
+
+ /// <summary>The minimum SMAPI version required by this mod, if any.</summary>
+ [JsonConverter(typeof(SFieldConverter))]
+ public ISemanticVersion MinimumApiVersion { get; set; }
+
+ /// <summary>The name of the DLL in the directory that has the <see cref="Mod.Entry"/> method.</summary>
+ public string EntryDll { get; set; }
+
+ /// <summary>The other mods that must be loaded before this mod.</summary>
+ [JsonConverter(typeof(SFieldConverter))]
+ public IManifestDependency[] Dependencies { get; set; }
+
+ /// <summary>The unique mod ID.</summary>
+ public string UniqueID { get; set; }
+
+#if SMAPI_1_x
+ /// <summary>Whether the mod uses per-save config files.</summary>
+ [Obsolete("Use " + nameof(Mod) + "." + nameof(Mod.Helper) + "." + nameof(IModHelper.ReadConfig) + " instead")]
+ public bool PerSaveConfigs { get; set; }
+#endif
+
+ /// <summary>Any manifest fields which didn't match a valid field.</summary>
+ [JsonExtensionData]
+ public IDictionary<string, object> ExtraFields { get; set; }
+ }
+}