summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2018-08-01 11:07:29 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2018-08-01 11:07:29 -0400
commit60b41195778af33fd609eab66d9ae3f1d1165e8f (patch)
tree7128b906d40e94c56c34ed6058f27bc31c31a08b /src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs
parentb9bc1a6d17cafa0a97b46ffecda432cfc2f23b51 (diff)
parent52cf953f685c65b2b6814e375ec9a5ffa03c440a (diff)
downloadSMAPI-60b41195778af33fd609eab66d9ae3f1d1165e8f.tar.gz
SMAPI-60b41195778af33fd609eab66d9ae3f1d1165e8f.tar.bz2
SMAPI-60b41195778af33fd609eab66d9ae3f1d1165e8f.zip
Merge branch 'develop' into stable
Diffstat (limited to 'src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs')
-rw-r--r--src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs44
1 files changed, 44 insertions, 0 deletions
diff --git a/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs b/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs
new file mode 100644
index 00000000..7375f005
--- /dev/null
+++ b/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs
@@ -0,0 +1,44 @@
+using System.Collections.Generic;
+
+namespace StardewModdingAPI
+{
+ /// <summary>A manifest which describes a mod for SMAPI.</summary>
+ public interface IManifest
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The mod name.</summary>
+ string Name { get; }
+
+ /// <summary>A brief description of the mod.</summary>
+ string Description { get; }
+
+ /// <summary>The mod author's name.</summary>
+ string Author { get; }
+
+ /// <summary>The mod version.</summary>
+ ISemanticVersion Version { get; }
+
+ /// <summary>The minimum SMAPI version required by this mod, if any.</summary>
+ ISemanticVersion MinimumApiVersion { get; }
+
+ /// <summary>The unique mod ID.</summary>
+ string UniqueID { get; }
+
+ /// <summary>The name of the DLL in the directory that has the <c>Entry</c> method. Mutually exclusive with <see cref="ContentPackFor"/>.</summary>
+ string EntryDll { get; }
+
+ /// <summary>The mod which will read this as a content pack. Mutually exclusive with <see cref="EntryDll"/>.</summary>
+ IManifestContentPackFor ContentPackFor { get; }
+
+ /// <summary>The other mods that must be loaded before this mod.</summary>
+ IManifestDependency[] Dependencies { get; }
+
+ /// <summary>The namespaced mod IDs to query for updates (like <c>Nexus:541</c>).</summary>
+ string[] UpdateKeys { get; }
+
+ /// <summary>Any manifest fields which didn't match a valid field.</summary>
+ IDictionary<string, object> ExtraFields { get; }
+ }
+}