From b08e27d13a1f0c82656df95212fc40588b3b5314 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 24 Jun 2018 21:51:51 -0400 Subject: merge IManifest interfaces into new project (#532) --- .../IManifest.cs | 44 ++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs (limited to 'src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs') diff --git a/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs b/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs new file mode 100644 index 00000000..6c07d374 --- /dev/null +++ b/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs @@ -0,0 +1,44 @@ +using System.Collections.Generic; + +namespace StardewModdingAPI +{ + /// A manifest which describes a mod for SMAPI. + public interface IManifest + { + /********* + ** Accessors + *********/ + /// The mod name. + string Name { get; } + + /// A brief description of the mod. + string Description { get; } + + /// The mod author's name. + string Author { get; } + + /// The mod version. + ISemanticVersion Version { get; } + + /// The minimum SMAPI version required by this mod, if any. + ISemanticVersion MinimumApiVersion { get; } + + /// The unique mod ID. + string UniqueID { get; } + + /// The name of the DLL in the directory that has the method. Mutually exclusive with . + string EntryDll { get; } + + /// The mod which will read this as a content pack. Mutually exclusive with . + IManifestContentPackFor ContentPackFor { get; } + + /// The other mods that must be loaded before this mod. + IManifestDependency[] Dependencies { get; } + + /// The namespaced mod IDs to query for updates (like Nexus:541). + string[] UpdateKeys { get; } + + /// Any manifest fields which didn't match a valid field. + IDictionary ExtraFields { get; } + } +} -- cgit From 37f867683b55b863893f7f8529248a772b137a2e Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Tue, 17 Jul 2018 00:28:30 -0400 Subject: fix XML docs --- src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs') diff --git a/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs b/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs index 6c07d374..7375f005 100644 --- a/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs +++ b/src/StardewModdingAPI.Toolkit.CoreInterfaces/IManifest.cs @@ -26,7 +26,7 @@ namespace StardewModdingAPI /// The unique mod ID. string UniqueID { get; } - /// The name of the DLL in the directory that has the method. Mutually exclusive with . + /// The name of the DLL in the directory that has the Entry method. Mutually exclusive with . string EntryDll { get; } /// The mod which will read this as a content pack. Mutually exclusive with . -- cgit