summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/IMod.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI/IMod.cs')
-rw-r--r--src/StardewModdingAPI/IMod.cs26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/IMod.cs b/src/StardewModdingAPI/IMod.cs
new file mode 100644
index 00000000..35ac7c0f
--- /dev/null
+++ b/src/StardewModdingAPI/IMod.cs
@@ -0,0 +1,26 @@
+namespace StardewModdingAPI
+{
+ /// <summary>The implementation for a Stardew Valley mod.</summary>
+ public interface IMod
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>Provides simplified APIs for writing mods.</summary>
+ IModHelper Helper { get; }
+
+ /// <summary>Writes messages to the console and log file.</summary>
+ IMonitor Monitor { get; }
+
+ /// <summary>The mod's manifest.</summary>
+ IManifest ModManifest { get; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>The mod entry point, called after the mod is first loaded.</summary>
+ /// <param name="helper">Provides simplified APIs for writing mods.</param>
+ void Entry(IModHelper helper);
+ }
+} \ No newline at end of file