Merge pull request #1 from MrPurple6411/dev

Convert to Bepinex and Fix a few other issues.

Example mod/mod.json

@@ -2,11 +2,11 @@
   "Id": "SMLHelperExampleMod",
   "DisplayName": "Example Mod For SMLHelper",
   "Author": "The SMLHelper Dev Team",
-  "Version": "2.14.1",
+  "Version": "2.15.0",
   "Enable": true,
   "AssemblyName": "Example mod.dll",
   "VersionDependencies": {
-    "SMLHelper": "2.14.1"
+    "SMLHelper": "2.15.0"
   },
   "Game": "Both",
   "NitroxCompat": true

SMLHelper/Assets/Craftable.cs

@@ -1,6 +1,7 @@
 namespace SMLHelper.V2.Assets
 {
     using SMLHelper.V2.Interfaces;
+    using SMLHelper.V2.Utility;
 
     /// <summary>
     /// An item that can be crafted into the game world from a fabricator.
@@ -45,7 +46,7 @@ private void PatchCraftingData()
         {
             if (this.FabricatorType == CraftTree.Type.None)
             {
-                Logger.Debug($"Craftable '{this.ClassID}' was not automatically patched into a crafting tree.");
+                InternalLogger.Debug($"Craftable '{this.ClassID}' was not automatically patched into a crafting tree.");
             }
             else
             {

SMLHelper/Assets/CustomFabricator.cs

@@ -1,12 +1,14 @@
-namespace SMLHelper.V2.Assets
+using SMLHelper.V2.Utility;
+
+namespace SMLHelper.V2.Assets
 {
     using System;
     using System.Collections;
     using System.Collections.Generic;
     using SMLHelper.V2.Crafting;
     using SMLHelper.V2.Handlers;
     using UnityEngine;
-    using Logger = V2.Logger;
+    using InternalLogger = InternalLogger;
 
 #if SUBNAUTICA
     using Sprite = Atlas.Sprite;
@@ -151,22 +153,7 @@ protected CustomFabricator(string classId, string friendlyName, string descripti
         /// <returns></returns>
         public override GameObject GetGameObject()
         {
-#if SUBNAUTICA_EXP || BELOWZERO
             return null;
-#else
-            GameObject prefab = this.Model switch
-            {
-                Models.Fabricator => GameObject.Instantiate(CraftData.GetPrefabForTechType(TechType.Fabricator)),
-                Models.Workbench => GameObject.Instantiate(CraftData.GetPrefabForTechType(TechType.Workbench)),
-#if SUBNAUTICA
-                Models.MoonPool => GameObject.Instantiate(Resources.Load<GameObject>("Submarine/Build/CyclopsFabricator")),
-#endif
-                Models.Custom => GetCustomCrafterPreFab(),
-                _ => null
-            };
-
-            return PreProcessPrefab(prefab);
-#endif
         }
 
         /// <summary>
@@ -350,7 +337,7 @@ public void AddTabNode(string tabId, string displayText, Sprite tabSprite, strin
         /// When this value is null, the craft node will be added to the root of the craft tree.</param>
         public void AddCraftNode(TechType techType, string parentTabId = null)
         {
-            Logger.Debug($"'{techType.AsString()}' will be added to the custom craft tree '{this.ClassID}'");
+            InternalLogger.Debug($"'{techType.AsString()}' will be added to the custom craft tree '{this.ClassID}'");
             OrderedCraftTreeActions.Add(() =>
             {
                 ModCraftTreeLinkingNode parentTab = CraftTreeLinkingNodes[parentTabId ?? RootNode];
@@ -367,7 +354,7 @@ public void AddCraftNode(TechType techType, string parentTabId = null)
         /// When this value is null, the craft node will be added to the root of the craft tree.</param>
         public void AddCraftNode(string moddedTechType, string parentTabId = null)
         {
-            Logger.Debug($"'{moddedTechType}' will be added to the custom craft tree '{this.ClassID}'");
+            InternalLogger.Debug($"'{moddedTechType}' will be added to the custom craft tree '{this.ClassID}'");
             OrderedCraftTreeActions.Add(() =>
             {
                 if (this.TechTypeHandler.TryGetModdedTechType(moddedTechType, out TechType techType))
@@ -377,7 +364,7 @@ public void AddCraftNode(string moddedTechType, string parentTabId = null)
                 }
                 else
                 {
-                    Logger.Info($"Did not find a TechType value for '{moddedTechType}' to add to the custom craft tree '{this.ClassID}'");
+                    InternalLogger.Info($"Did not find a TechType value for '{moddedTechType}' to add to the custom craft tree '{this.ClassID}'");
                 }
             });
         }
@@ -392,12 +379,12 @@ public void AddCraftNode(string moddedTechType, string parentTabId = null)
         /// The craft node will be added to the root of the craft tree if both are null.</param>
         public void AddCraftNode(Craftable item, string parentTabId = null)
         {
-            Logger.Debug($"'{item.ClassID}' will be added to the custom craft tree '{this.ClassID}'");
+            InternalLogger.Debug($"'{item.ClassID}' will be added to the custom craft tree '{this.ClassID}'");
             OrderedCraftTreeActions.Add(() =>
             {
                 if (item.TechType == TechType.None)
                 {
-                    Logger.Info($"'{item.ClassID} had to be patched early to obtain its TechType value for the custom craft tree '{this.ClassID}'");
+                    InternalLogger.Info($"'{item.ClassID} had to be patched early to obtain its TechType value for the custom craft tree '{this.ClassID}'");
                     item.Patch();
                 }
 

SMLHelper/Assets/FishPrefab.cs

@@ -47,7 +47,7 @@ public FishPrefab(string classId, string prefabFileName, TechType techType = Tec
         /// </summary>
         public sealed override GameObject GetGameObject()
         {
-            V2.Logger.Debug($"[FishFramework] Initializing fish: {this.ClassID}");
+            Utility.InternalLogger.Debug($"[FishFramework] Initializing fish: {this.ClassID}");
             GameObject mainObj = modelPrefab;
 
             Renderer[] renderers = mainObj.GetComponentsInChildren<Renderer>();
@@ -68,11 +68,7 @@ public sealed override GameObject GetGameObject()
             forces.handleGravity = true;
             forces.underwaterDrag = 1f;
             forces.underwaterGravity = 0;
-#if BELOWZERO || SUBNAUTICA_EXP
             forces.waterDepth = Ocean.GetOceanLevel();
-#else
-            forces.waterDepth = Ocean.main.GetOceanLevel();
-#endif
             forces.enabled = false;
             forces.enabled = true;
 

SMLHelper/Assets/ModPrefabCache.cs

@@ -1,9 +1,11 @@
-namespace SMLHelper.V2.Assets
+using SMLHelper.V2.Utility;
+
+namespace SMLHelper.V2.Assets
 {
     using System;
     using System.Collections.Generic;
     using UnityEngine;
-    using Logger = V2.Logger;
+    using InternalLogger = InternalLogger;
 
     /// <summary>
     /// Class that used by <see cref="ModPrefab"/> to store game objects that used as prefabs.
@@ -29,7 +31,7 @@ public void Update()
                     if (Time.time < prefabs[i].Item1 + cleanDelay || Builder.prefab == prefabs[i].Item2)
                         continue;
 
-                    Logger.Debug($"ModPrefabCache: removing prefab {prefabs[i].Item2}");
+                    InternalLogger.Debug($"ModPrefabCache: removing prefab {prefabs[i].Item2}");
 
                     Destroy(prefabs[i].Item2);
                     prefabs.RemoveAt(i);
@@ -85,7 +87,7 @@ private static void AddPrefabInternal(GameObject prefab, bool autoremove)
             if (autoremove)
                 prefabs.Add(Tuple.Create(Time.time, prefab));
 
-            Logger.Debug($"ModPrefabCache: adding prefab {prefab}");
+            InternalLogger.Debug($"ModPrefabCache: adding prefab {prefab}");
         }
     }
 }

SMLHelper/Assets/ModPrefabRequest.cs

@@ -50,10 +50,8 @@ public bool MoveNext()
 
         public void Reset() {}
 
-#if BELOWZERO || SUBNAUTICA_EXP
         public void Release()
         {
         }
-#endif
     }
 }

SMLHelper/Assets/PdaItem.cs

@@ -2,6 +2,7 @@
 {
     using Crafting;
     using SMLHelper.V2.Interfaces;
+    using SMLHelper.V2.Utility;
     using System.Collections.Generic;
 
     /// <summary>
@@ -117,7 +118,7 @@ private void PatchTechDataEntry()
                 }
                 else
                 {
-                    Logger.Error($"Failed to add {TechType} to {GroupForPDA}/{CategoryForPDA} as it is not a registered combination.");
+                    InternalLogger.Error($"Failed to add {TechType} to {GroupForPDA}/{CategoryForPDA} as it is not a registered combination.");
                 }
             }
 

SMLHelper/Assets/Spawnable.cs

@@ -1,4 +1,6 @@
-namespace SMLHelper.V2.Assets
+using SMLHelper.V2.Utility;
+
+namespace SMLHelper.V2.Assets
 {
     using Handlers;
     using Interfaces;
@@ -10,7 +12,7 @@
     using System.Reflection;
     using UnityEngine;
     using UWE;
-    using Logger = Logger;
+    using InternalLogger = InternalLogger;
 #if SUBNAUTICA
     using Sprite = Atlas.Sprite;
 #endif
@@ -113,7 +115,7 @@ protected Spawnable(string classId, string friendlyName, string description)
         {
             if(string.IsNullOrEmpty(classId))
             {
-                Logger.Log($"ClassID for Spawnables must be a non-empty value.", LogLevel.Error);
+                InternalLogger.Log($"ClassID for Spawnables must be a non-empty value.", LogLevel.Error);
                 throw new ArgumentException($"Error patching Spawnable");
             }
 
@@ -222,8 +224,8 @@ internal virtual void PatchTechType()
         protected virtual Sprite GetItemSprite()
         {
             // This is for backwards compatibility with mods that were using the "ModName/Assets" format
-            string path = this.AssetsFolder != ModFolderLocation
-                ? IOUtilities.Combine(".", "QMods", this.AssetsFolder.Trim('/'), this.IconFileName)
+            string path = this.AssetsFolder != ModFolderLocation && !string.IsNullOrWhiteSpace(this.AssetsFolder)
+                ? IOUtilities.Combine(ModFolderLocation, this.AssetsFolder.Trim('/'), this.IconFileName)
                 : Path.Combine(this.AssetsFolder, this.IconFileName);
 
             if(File.Exists(path))
@@ -232,7 +234,7 @@ protected virtual Sprite GetItemSprite()
             }
 
             if(HasSprite)
-                Logger.Error($"Sprite for '{this.PrefabFileName}'{Environment.NewLine}Did not find an image file at '{path}'");
+                InternalLogger.Error($"Sprite for '{this.PrefabFileName}'{Environment.NewLine}Did not find an image file at '{path}'");
 
             return SpriteManager.defaultSprite;
         }

SMLHelper/Assets/SubnauticaModSprite.cs

@@ -3,6 +3,7 @@ namespace SMLHelper.V2.Assets
 {
     using System;
     using System.Collections.Generic;
+    using SMLHelper.V2.Utility;
 
     /// <summary>
     /// A class that handles a custom sprite and what item it is associated to.
@@ -20,7 +21,7 @@ internal static void Add(SpriteManager.Group group, string name, Atlas.Sprite sp
                 ModSprites.Add(group, new Dictionary<string, Atlas.Sprite>(StringComparer.InvariantCultureIgnoreCase));
 
             if(ModSprites[group].ContainsKey(name))
-                Logger.Debug($"ModSprite already registered for {group}/{name}.  Old sprite will be overwritten.");
+                InternalLogger.Debug($"ModSprite already registered for {group}/{name}.  Old sprite will be overwritten.");
             ModSprites[group][name] = sprite;
         }
 

SMLHelper/Commands/ConsoleCommand.cs

@@ -1,7 +1,6 @@
 namespace SMLHelper.V2.Commands
 {
     using HarmonyLib;
-    using QModManager.API;
     using System;
     using System.Collections.Generic;
     using System.Linq;
@@ -20,7 +19,7 @@ internal class ConsoleCommand
         /// <summary>
         /// The QMod that registered the command.
         /// </summary>
-        public IQMod QMod { get; }
+        public string ModName { get; }
 
         /// <summary>
         /// The parameters for the command.
@@ -53,7 +52,7 @@ public ConsoleCommand(string trigger, MethodInfo targetMethod, bool isDelegate =
             IsMethodStatic = targetMethod.IsStatic;
             IsDelegate = isDelegate;
             Instance = instance;
-            QMod = QModServices.Main.GetMod(DeclaringType.Assembly);
+            ModName = DeclaringType.Assembly.GetName().Name;
             Parameters = targetMethod.GetParameters().Select(param => new Parameter(param));
             ParameterTypes = Parameters.Select(param => param.ParameterType).ToArray();
         }

SMLHelper/FMod/FModMultiSounds.cs

@@ -91,7 +91,7 @@ Channel IFModSound.PlaySound()
                 return AudioUtils.PlaySound(_sounds[Index], _bus);
             }
 
-            Logger.Error("MultiSounds must have some sounds.");
+            InternalLogger.Error("MultiSounds must have some sounds.");
             return default;
         }
     }

SMLHelper/Handlers/CoordinatedSpawnsHandler.cs

@@ -1,11 +1,7 @@
 using System;
 using System.Collections.Generic;
 using UnityEngine;
-#if SUBNAUTICA_STABLE
-using Oculus.Newtonsoft.Json;
-#else
 using Newtonsoft.Json;
-#endif
 
 namespace SMLHelper.V2.Handlers
 {

SMLHelper/Handlers/FishHandler.cs

@@ -5,6 +5,7 @@
     using System.IO;
     using SMLHelper.V2.Assets;
     using SMLHelper.V2.Interfaces;
+    using SMLHelper.V2.Utility;
 
     /// <summary>
     /// Class to manage registering of fish into the game
@@ -52,7 +53,7 @@ TechType IFishHandler.RegisterFish(Fish fish)
 
             PrefabHandler.RegisterPrefab(fishPrefab);
 
-            Logger.Debug($"Successfully registered fish: '{fish.displayName}' with Tech Type: '{fish.id}'");
+            InternalLogger.Debug($"Successfully registered fish: '{fish.displayName}' with Tech Type: '{fish.id}'");
 
             return type;
         }

SMLHelper/Handlers/KnownTechHandler.cs

@@ -1,10 +1,12 @@
-namespace SMLHelper.V2.Handlers
+using SMLHelper.V2.Utility;
+
+namespace SMLHelper.V2.Handlers
 {
     using Interfaces;
     using Patchers;
     using System.Collections.Generic;
     using UnityEngine;
-    using Logger = V2.Logger;
+    using InternalLogger = InternalLogger;
 
     /// <summary>
     /// A handler class for configuring custom unlocking conditions for item blueprints.
@@ -66,33 +68,33 @@ internal void AddAnalysisTech(TechType techTypeToBeAnalysed, IEnumerable<TechTyp
             }
             else
             {
-                Logger.Error("Cannot Add Unlock to TechType.None!");
+                InternalLogger.Error("Cannot Add Unlock to TechType.None!");
             }
         }
 
         internal void AddCompoundUnlock(TechType techType, List<TechType> compoundTechsForUnlock)
         {
             if (techType == TechType.None)
             {
-                Logger.Error("Cannot Add Unlock to TechType.None!");
+                InternalLogger.Error("Cannot Add Unlock to TechType.None!");
                 return;
             }
 
             if (compoundTechsForUnlock.Contains(techType))
             {
-                Logger.Error("Cannot Add Compound Unlock that contains itself!");
+                InternalLogger.Error("Cannot Add Compound Unlock that contains itself!");
                 return;
             }
 
 
             if (KnownTechPatcher.CompoundTech.TryGetValue(techType, out KnownTech.CompoundTech compoundTech))
             {
-                Logger.Debug($"Compound Unlock already found for {techType.AsString()}, Overwriting.");
+                InternalLogger.Debug($"Compound Unlock already found for {techType.AsString()}, Overwriting.");
                 compoundTech.dependencies = compoundTechsForUnlock;
             }
             else
             {
-                Logger.Debug($"Adding Compound Unlock for {techType.AsString()}");
+                InternalLogger.Debug($"Adding Compound Unlock for {techType.AsString()}");
                 KnownTechPatcher.CompoundTech.Add(techType, new KnownTech.CompoundTech() { techType = techType, dependencies = compoundTechsForUnlock });
             }
         }
@@ -119,20 +121,20 @@ internal void RemoveAnalysisTechEntry(TechType targetTechType)
             {
                 if (tech.unlockTechTypes.Contains(targetTechType))
                 {
-                    Logger.Debug($"Removed {targetTechType.AsString()} from {tech.techType.AsString()} unlocks that was added by another mod!");
+                    InternalLogger.Debug($"Removed {targetTechType.AsString()} from {tech.techType.AsString()} unlocks that was added by another mod!");
                     tech.unlockTechTypes.Remove(targetTechType);
                 }
             }
 
             if (KnownTechPatcher.CompoundTech.TryGetValue(targetTechType, out var types))
             {
-                Logger.Debug($"Removed Compound Unlock for {targetTechType.AsString()} that was added by another mod!");
+                InternalLogger.Debug($"Removed Compound Unlock for {targetTechType.AsString()} that was added by another mod!");
                 KnownTechPatcher.CompoundTech.Remove(targetTechType);
             }
 
             if (KnownTechPatcher.UnlockedAtStart.Contains(targetTechType))
             {
-                Logger.Debug($"Removed UnlockedAtStart for {targetTechType.AsString()} that was added by another mod!");
+                InternalLogger.Debug($"Removed UnlockedAtStart for {targetTechType.AsString()} that was added by another mod!");
                 KnownTechPatcher.UnlockedAtStart.Remove(targetTechType);
             }