summaryrefslogtreecommitdiff
path: root/src/SMAPI/IMod.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2017-10-07 23:07:10 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2017-10-07 23:07:10 -0400
commit929dccb75a1405737975d76648e015a3e7c00177 (patch)
tree659fe16509327e694555db363caf7f47f326443b /src/SMAPI/IMod.cs
parent926894f8f52c2a5cf104fcac2f7f34b637f7b531 (diff)
downloadSMAPI-929dccb75a1405737975d76648e015a3e7c00177.tar.gz
SMAPI-929dccb75a1405737975d76648e015a3e7c00177.tar.bz2
SMAPI-929dccb75a1405737975d76648e015a3e7c00177.zip
reorganise repo structure
Diffstat (limited to 'src/SMAPI/IMod.cs')
-rw-r--r--src/SMAPI/IMod.cs26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/SMAPI/IMod.cs b/src/SMAPI/IMod.cs
new file mode 100644
index 00000000..35ac7c0f
--- /dev/null
+++ b/src/SMAPI/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