From ab0653ffe5e7d3b2d5026e7886dc3ce5f741bc4b Mon Sep 17 00:00:00 2001 From: amazingalek Date: Fri, 27 Dec 2019 21:32:04 +0100 Subject: [PATCH] Versions (#27) * removed OWML version check --- OWML.Common/IModManifest.cs | 1 - OWML.Launcher/App.cs | 5 +---- OWML.ModHelper/ModManifest.cs | 3 --- .../OWML.EnableDebugMode/manifest.json | 1 - .../OWML.LoadCustomAssets/manifest.json | 1 - OWML.SampleMods/OWML.TestMod/manifest.json | 1 - Readme.md | 18 ++++++------------ 7 files changed, 7 insertions(+), 23 deletions(-) diff --git a/OWML.Common/IModManifest.cs b/OWML.Common/IModManifest.cs index 5d170ebb..0c88ee45 100644 --- a/OWML.Common/IModManifest.cs +++ b/OWML.Common/IModManifest.cs @@ -6,7 +6,6 @@ public interface IModManifest string Author { get; } string Name { get; } string Version { get; } - string OWMLVersion { get; } string AssemblyPath { get; } string UniqueName { get; } string FolderPath { get; set; } diff --git a/OWML.Launcher/App.cs b/OWML.Launcher/App.cs index d226dcba..c475d4fa 100644 --- a/OWML.Launcher/App.cs +++ b/OWML.Launcher/App.cs @@ -12,8 +12,6 @@ namespace OWML.Launcher { public class App { - private const string OWMLVersion = "0.2.3"; - private readonly string[] _filesToCopy = { "UnityEngine.CoreModule.dll", "Assembly-CSharp.dll" }; public void Run() @@ -87,8 +85,7 @@ private void ShowModList(IModFinder modFinder) foreach (var manifest in manifests) { var stateText = manifest.Enabled ? "" : "(disabled)"; - var versionCheckText = manifest.OWMLVersion == OWMLVersion ? "" : $"(mod is for OWML {manifest.OWMLVersion} but you are running OWML {OWMLVersion})"; - Console.WriteLine($"* {manifest.UniqueName} ({manifest.Version}) {stateText} {versionCheckText}"); + Console.WriteLine($"* {manifest.UniqueName} ({manifest.Version}) {stateText}"); } } diff --git a/OWML.ModHelper/ModManifest.cs b/OWML.ModHelper/ModManifest.cs index ad49c8aa..57bae90d 100644 --- a/OWML.ModHelper/ModManifest.cs +++ b/OWML.ModHelper/ModManifest.cs @@ -20,9 +20,6 @@ public class ModManifest : IModManifest [JsonProperty("version")] public string Version { get; private set; } - [JsonProperty("owmlVersion")] - public string OWMLVersion { get; private set; } - [JsonProperty("enabled")] public bool Enabled { get; private set; } diff --git a/OWML.SampleMods/OWML.EnableDebugMode/manifest.json b/OWML.SampleMods/OWML.EnableDebugMode/manifest.json index 1a389093..32fec53f 100644 --- a/OWML.SampleMods/OWML.EnableDebugMode/manifest.json +++ b/OWML.SampleMods/OWML.EnableDebugMode/manifest.json @@ -4,6 +4,5 @@ "name": "EnableDebugMode", "uniqueName": "Alek.EnableDebugMode", "version": "0.2", - "owmlVersion": "0.2.3", "enabled": false } \ No newline at end of file diff --git a/OWML.SampleMods/OWML.LoadCustomAssets/manifest.json b/OWML.SampleMods/OWML.LoadCustomAssets/manifest.json index 5b32ee8b..7db10b17 100644 --- a/OWML.SampleMods/OWML.LoadCustomAssets/manifest.json +++ b/OWML.SampleMods/OWML.LoadCustomAssets/manifest.json @@ -4,6 +4,5 @@ "name": "LoadCustomAssets", "uniqueName": "Alek.LoadCustomAssets", "version": "0.2", - "owmlVersion": "0.2.3", "enabled": false } \ No newline at end of file diff --git a/OWML.SampleMods/OWML.TestMod/manifest.json b/OWML.SampleMods/OWML.TestMod/manifest.json index 84e61737..32c88b4b 100644 --- a/OWML.SampleMods/OWML.TestMod/manifest.json +++ b/OWML.SampleMods/OWML.TestMod/manifest.json @@ -4,6 +4,5 @@ "name": "TestMod", "uniqueName": "Alek.TestMod", "version": "0.1", - "owmlVersion": "0.2.3", "enabled": false } \ No newline at end of file diff --git a/Readme.md b/Readme.md index 4e4cb4b3..30b74b71 100644 --- a/Readme.md +++ b/Readme.md @@ -35,16 +35,12 @@ Refer to the sample mods for examples. ### Get started -Make a new project targeting .Net Framework 3.5. Reference the following files: -* OWML: - * OWML.Common.dll - * OWML.ModHelper.dll - * OWML.ModHelper.Events.dll - * OWML.ModHelper.Assets.dll -* {gamePath}\OuterWilds_Data\Managed: - * Assembly-CSharp.dll - * UnityEngine.CoreModule.dll - * More Unity DLLs if needed +1. Create a class library project targeting .Net Framework 3.5. +2. Install the [OWML Nuget package](https://www.nuget.org/packages/OWML/). +3. Reference the following files in {gamePath}\OuterWilds_Data\Managed: + * Assembly-CSharp.dll + * UnityEngine.CoreModule.dll + * More Unity DLLs if needed Inherit from ModBehaviour. You can have any number of classes/projects you want, but only one ModBehaviour per mod. @@ -196,7 +192,6 @@ Add a manifest file called manifest.json. Example: "name": "EnableDebugMode", "uniqueName": "Alek.EnableDebugMode", "version": "0.1", - "owmlVersion": "0.2.3", "enabled": true } ~~~~ @@ -219,7 +214,6 @@ Each mod is defined in a manifest.json file: |name|The name of the mod.| |uniqueName|Usually {author}.{uniqueName}.| |version|The version number.| -|owmlVersion|The version of OWML the mod was made for.| |enabled|Whether or not the mod will be loaded.| ## Compatibility