From f0cb2c0e63c9e00a7a902a7729c862a569d21061 Mon Sep 17 00:00:00 2001 From: Zoryn Aaron Date: Sun, 20 Mar 2016 17:19:02 -0400 Subject: [PATCH] converted mod loading to a manifest structure. mods now go in ./Mods// - in there you need a 'manifest.json' and your dll. See trainermod for example. --- StardewModdingAPI/Manifest.cs | 33 +++++++++ StardewModdingAPI/Mod.cs | 19 +----- StardewModdingAPI/Program.cs | 79 +++++++++++++++------- StardewModdingAPI/StardewModdingAPI.csproj | 1 + TrainerMod/TrainerMod.cs | 2 + TrainerMod/TrainerMod.csproj | 1 + TrainerMod/manifest.json | 7 ++ 7 files changed, 102 insertions(+), 40 deletions(-) create mode 100644 StardewModdingAPI/Manifest.cs create mode 100644 TrainerMod/manifest.json diff --git a/StardewModdingAPI/Manifest.cs b/StardewModdingAPI/Manifest.cs new file mode 100644 index 00000000..4fc1ed3c --- /dev/null +++ b/StardewModdingAPI/Manifest.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace StardewModdingAPI +{ + public class Manifest + { + /// + /// The name of your mod. + /// + public virtual string Name { get; set; } + + /// + /// The name of the mod's authour. + /// + public virtual string Authour { get; set; } + + /// + /// The version of the mod. + /// + public virtual string Version { get; set; } + + /// + /// A description of the mod. + /// + public virtual string Description { get; set; } + + public string EntryDll { get; set; } + } +} diff --git a/StardewModdingAPI/Mod.cs b/StardewModdingAPI/Mod.cs index a196c3a2..4b923fd7 100644 --- a/StardewModdingAPI/Mod.cs +++ b/StardewModdingAPI/Mod.cs @@ -9,24 +9,9 @@ namespace StardewModdingAPI public class Mod { /// - /// The name of your mod. + /// The mod's manifest /// - public virtual string Name { get; protected set; } - - /// - /// The name of the mod's authour. - /// - public virtual string Authour { get; protected set; } - - /// - /// The version of the mod. - /// - public virtual string Version { get; protected set; } - - /// - /// A description of the mod. - /// - public virtual string Description { get; protected set; } + public Manifest Manifest { get; internal set; } /// /// Where the mod is located on the disk. diff --git a/StardewModdingAPI/Program.cs b/StardewModdingAPI/Program.cs index 5ed2d644..6d137a68 100644 --- a/StardewModdingAPI/Program.cs +++ b/StardewModdingAPI/Program.cs @@ -13,6 +13,7 @@ using System.Linq; using System.Reflection; using System.Threading; using System.Windows.Forms; +using Newtonsoft.Json; namespace StardewModdingAPI { @@ -131,7 +132,7 @@ namespace StardewModdingAPI StardewModdingAPI.Log.Success("Loading Injector DLL..."); TypeInfo tar = mod.DefinedTypes.First(x => x.BaseType == typeof(Mod)); Mod m = (Mod)mod.CreateInstance(tar.ToString()); - Console.WriteLine("LOADED: {0} by {1} - Version {2} | Description: {3} (@:{4})", m.Name, m.Authour, m.Version, m.Description, s); + Console.WriteLine("LOADED: {0} by {1} - Version {2} | Description: {3} (@:{4})", m.Manifest.Name, m.Manifest.Authour, m.Manifest.Version, m.Manifest.Description, s); m.PathOnDisk = Path.GetDirectoryName(s); m.Entry(false); StardewInjectorLoaded = true; @@ -312,34 +313,67 @@ namespace StardewModdingAPI int loadedMods = 0; foreach (string ModPath in _modPaths) { - foreach (String s in Directory.GetFiles(ModPath, "*.dll")) + foreach (String d in Directory.GetDirectories(ModPath)) { - if (s.Contains("StardewInjector")) - continue; - StardewModdingAPI.Log.Success("Found DLL: " + s); - try + foreach (String s in Directory.GetFiles(d, "manifest.json")) { - Assembly mod = Assembly.UnsafeLoadFrom(s); //to combat internet-downloaded DLLs + if (s.Contains("StardewInjector")) + continue; + StardewModdingAPI.Log.Success("Found Manifest: " + s); + Manifest manifest = new Manifest(); + try + { + string t = File.ReadAllText(s); + if (string.IsNullOrEmpty(t)) + { + StardewModdingAPI.Log.Error("Failed to read mod manifest '{0}'. Manifest is empty!", s); + continue; + } + manifest = JsonConvert.DeserializeObject(t); + if (string.IsNullOrEmpty(manifest.EntryDll)) + { + StardewModdingAPI.Log.Error("Failed to read mod manifest '{0}'. EntryDll is empty!", s); + continue; + } + } + catch (Exception ex) + { + StardewModdingAPI.Log.Error("Failed to read mod manifest '{0}'. Exception details:\n" + ex, s); + continue; + } + try + { + string targDll = Path.Combine(Path.GetDirectoryName(s), manifest.EntryDll); + if (!File.Exists(targDll)) + { + StardewModdingAPI.Log.Error("Failed to load mod '{0}'. File {1} does not exist!", s, targDll); + continue; + } - if (mod.DefinedTypes.Count(x => x.BaseType == typeof(Mod)) > 0) - { - StardewModdingAPI.Log.Verbose("Loading Mod DLL..."); - TypeInfo tar = mod.DefinedTypes.First(x => x.BaseType == typeof(Mod)); - Mod m = (Mod)mod.CreateInstance(tar.ToString()); - m.PathOnDisk = Path.GetDirectoryName(s); - Console.WriteLine("LOADED MOD: {0} by {1} - Version {2} | Description: {3} (@{4})", m.Name, m.Authour, m.Version, m.Description, m.PathOnDisk); - loadedMods += 1; - m.Entry(); + Assembly mod = Assembly.UnsafeLoadFrom(targDll); + + if (mod.DefinedTypes.Count(x => x.BaseType == typeof (Mod)) > 0) + { + StardewModdingAPI.Log.Verbose("Loading Mod DLL..."); + TypeInfo tar = mod.DefinedTypes.First(x => x.BaseType == typeof (Mod)); + Mod m = (Mod) mod.CreateInstance(tar.ToString()); + m.PathOnDisk = Path.GetDirectoryName(s); + m.Manifest = manifest; + StardewModdingAPI.Log.Success("LOADED MOD: {0} by {1} - Version {2} | Description: {3} (@ {4})", m.Manifest.Name, m.Manifest.Authour, m.Manifest.Version, m.Manifest.Description, targDll); + loadedMods += 1; + m.Entry(); + } + else + { + StardewModdingAPI.Log.Error("Invalid Mod DLL"); + } } - else + catch (Exception ex) { - StardewModdingAPI.Log.Error("Invalid Mod DLL"); + StardewModdingAPI.Log.Error("Failed to load mod '{0}'. Exception details:\n" + ex, s); + continue; } } - catch (Exception ex) - { - StardewModdingAPI.Log.Error("Failed to load mod '{0}'. Exception details:\n" + ex, s); - } } } StardewModdingAPI.Log.Success("LOADED {0} MODS", loadedMods); @@ -400,7 +434,6 @@ namespace StardewModdingAPI } } - static void Events_LocationsChanged(List newLocations) { #if DEBUG diff --git a/StardewModdingAPI/StardewModdingAPI.csproj b/StardewModdingAPI/StardewModdingAPI.csproj index b4494faf..c2f286ce 100644 --- a/StardewModdingAPI/StardewModdingAPI.csproj +++ b/StardewModdingAPI/StardewModdingAPI.csproj @@ -150,6 +150,7 @@ + diff --git a/TrainerMod/TrainerMod.cs b/TrainerMod/TrainerMod.cs index e2482c5d..bed66b21 100644 --- a/TrainerMod/TrainerMod.cs +++ b/TrainerMod/TrainerMod.cs @@ -16,6 +16,7 @@ namespace TrainerMod { public class TrainerMod : Mod { + /* public override string Name { get { return "Trainer Mod"; } @@ -35,6 +36,7 @@ namespace TrainerMod { get { return "Registers several commands to use. Most commands are trainer-like in that they offer forms of cheating."; } } + */ public static int frozenTime; public static bool infHealth, infStamina, infMoney, freezeTime; diff --git a/TrainerMod/TrainerMod.csproj b/TrainerMod/TrainerMod.csproj index 2baa6a26..6424ecdb 100644 --- a/TrainerMod/TrainerMod.csproj +++ b/TrainerMod/TrainerMod.csproj @@ -85,6 +85,7 @@ + diff --git a/TrainerMod/manifest.json b/TrainerMod/manifest.json new file mode 100644 index 00000000..a85f8dc3 --- /dev/null +++ b/TrainerMod/manifest.json @@ -0,0 +1,7 @@ +{ + "Name": "Trainer Mod", + "Authour": "Zoryn", + "Version": "1.0", + "Description": "Registers several commands to use. Most commands are trainer-like in that they offer forms of cheating.", + "EntryDll": "TrainerMod.dll" +} \ No newline at end of file