Merge pull request #19 from Extremelyd1/modding-api-1.5

Update HKMP to use modding API for Hollow Knight 1.5.*
Extremelyd1 · Sep 12, 2021 · 04fd20e · 04fd20e
2 parents a0873a3 + ee1abd1
commit 04fd20e
Show file tree

Hide file tree

Showing 17 changed files with 75 additions and 30 deletions.
diff --git a/HKMP/Animation/AnimationManager.cs b/HKMP/Animation/AnimationManager.cs
@@ -576,8 +576,8 @@ Game.Settings.GameSettings gameSettings
             On.HeroController.CancelDash += HeroControllerOnCancelDash;
 
             // Register a callback so we can check the nail art charge status
-            ModHooks.Instance.HeroUpdateHook += OnHeroUpdateHook;
-
+            ModHooks.HeroUpdateHook += OnHeroUpdateHook;
+            
             // Register a callback for when we get hit by a hazard
             On.HeroController.DieFromHazard += HeroControllerOnDieFromHazard;
             // Also register a callback from when we respawn from a hazard
@@ -590,8 +590,8 @@ Game.Settings.GameSettings gameSettings
             On.HeroController.RelinquishControl += HeroControllerOnRelinquishControl;
 
             // Register when the player dies to send the animation
-            ModHooks.Instance.BeforePlayerDeadHook += OnDeath;
-
+            ModHooks.BeforePlayerDeadHook += OnDeath;
+            
             // Set the game settings for all animation effects
             foreach (var effect in AnimationEffects.Values) {
                 effect.SetGameSettings(gameSettings);

diff --git a/HKMP/Animation/Effects/FocusBurst.cs b/HKMP/Animation/Effects/FocusBurst.cs
@@ -115,7 +115,7 @@ public override bool[] GetEffectInfo() {
             } else {
                 // Since the event already happened locally, the FSM move to the Cooldown state
                 // thus the only way to check whether we activated the cloud is when the cooldown is "fresh" aka ~0
-                var timeOnCooldown = ReflectionHelper.GetAttr<Wait, float>(
+                var timeOnCooldown = ReflectionHelper.GetField<Wait, float>(
                     sporeCooldownFsm.GetAction<Wait>("Cooldown", 0),
                     "timer"
                 );

diff --git a/HKMP/Game/Client/ClientManager.cs b/HKMP/Game/Client/ClientManager.cs
@@ -104,7 +104,7 @@ PacketManager packetManager
             _netClient.RegisterOnTimeout(OnTimeout);
 
             // Register application quit handler
-            ModHooks.Instance.ApplicationQuitHook += OnApplicationQuit;
+            ModHooks.ApplicationQuitHook += OnApplicationQuit;
         }
 
         /**

diff --git a/HKMP/Game/Client/MapManager.cs b/HKMP/Game/Client/MapManager.cs
@@ -172,10 +172,10 @@ public Vector3 GetMapLocation() {
             } else {
                 var playerPosition = HeroController.instance.gameObject.transform.position;
 
-                var originOffsetX = ReflectionHelper.GetAttr<GameMap, float>(gameMap, "originOffsetX");
-                var originOffsetY = ReflectionHelper.GetAttr<GameMap, float>(gameMap, "originOffsetY");
-                var sceneWidth = ReflectionHelper.GetAttr<GameMap, float>(gameMap, "sceneWidth");
-                var sceneHeight = ReflectionHelper.GetAttr<GameMap, float>(gameMap, "sceneHeight");
+                var originOffsetX = ReflectionHelper.GetField<GameMap, float>(gameMap, "originOffsetX");
+                var originOffsetY = ReflectionHelper.GetField<GameMap, float>(gameMap, "originOffsetY");
+                var sceneWidth = ReflectionHelper.GetField<GameMap, float>(gameMap, "sceneWidth");
+                var sceneHeight = ReflectionHelper.GetField<GameMap, float>(gameMap, "sceneHeight");
 
                 position = new Vector3(
                     currentScenePos.x - size.x / 2.0f + (playerPosition.x + originOffsetX) / sceneWidth *
@@ -246,7 +246,7 @@ private void OnCloseQuickMap(On.GameMap.orig_CloseQuickMap orig, GameMap self) {
         private void OnPositionCompass(On.GameMap.orig_PositionCompass orig, GameMap self, bool posShade) {
             orig(self, posShade);
 
-            var posGate = ReflectionHelper.GetAttr<GameMap, bool>(self, "posGate");
+            var posGate = ReflectionHelper.GetField<GameMap, bool>(self, "posGate");
 
             // If this is a call where we either update the shade position or the dream gate position,
             // we don't want to display the icons again, because we haven't opened the map

diff --git a/HKMP/Game/Client/PauseManager.cs b/HKMP/Game/Client/PauseManager.cs
@@ -1,4 +1,3 @@
-using System;
 using System.Collections;
 using System.Reflection;
 using GlobalEnums;
@@ -28,7 +27,7 @@ public void RegisterHooks() {
             On.TransitionPoint.OnTriggerEnter2D += TransitionPointOnOnTriggerEnter2D;
             On.HeroController.DieFromHazard += HeroControllerOnDieFromHazard;
 
-            ModHooks.Instance.BeforePlayerDeadHook += OnDeath;
+            ModHooks.BeforePlayerDeadHook += OnDeath;
         }
 
         private void UIManagerOnTogglePauseGame(On.UIManager.orig_TogglePauseGame orig, UIManager self) {
@@ -39,7 +38,7 @@ private void UIManagerOnTogglePauseGame(On.UIManager.orig_TogglePauseGame orig,
 
             // First evaluate whether the original method would have started the coroutine:
             // GameManager#PauseGameToggleByMenu
-            var setTimeScale = !ReflectionHelper.GetAttr<UIManager, bool>(self, "ignoreUnpause");
+            var setTimeScale = !ReflectionHelper.GetField<UIManager, bool>(self, "ignoreUnpause");
 
             // Now we execute the original method, which will potentially set the timescale to 0f
             orig(self);
@@ -145,7 +144,7 @@ private void ImmediateUnpauseIfPaused() {
                 if (UIManager.instance.uiState.Equals(UIState.PAUSED)) {
                     var gm = global::GameManager.instance;
 
-                    ReflectionHelper.GetAttr<global::GameManager, GameCameras>(gm, "gameCams").ResumeCameraShake();
+                    ReflectionHelper.GetField<global::GameManager, GameCameras>(gm, "gameCams").ResumeCameraShake();
                     gm.inputHandler.PreventPause();
                     gm.actorSnapshotUnpaused.TransitionTo(0f);
                     gm.isPaused = false;

diff --git a/HKMP/Game/Settings/ModSettings.cs b/HKMP/Game/Settings/ModSettings.cs
@@ -1,8 +1,8 @@
 namespace Hkmp.Game.Settings {
     /**
-     * Settings file that stores last used addresses and ports
+     * Settings class that stored user preferences
      */
-    public class ModSettings : Modding.ModSettings {
+    public class ModSettings {
         public int HideUiKey { get; set; } = 307;
 
         public string JoinAddress { get; set; }
@@ -11,10 +11,13 @@ public class ModSettings : Modding.ModSettings {
 
         public string Username { get; set; }
 
-        public int HostPort { get; set; } = -1;
+        public int HostPort { get; set; } = 26950;
 
         public bool DisplayPing { get; set; }
 
-        public Game.Settings.GameSettings GameSettings { get; set; }
+        public bool AutoConnectWhenHosting { get; set; } = true;
+
+        public GameSettings GameSettings { get; set; }
+
     }
 }
diff --git a/HKMP/HKMP.csproj b/HKMP/HKMP.csproj
@@ -9,7 +9,7 @@
         <AppDesignerFolder>Properties</AppDesignerFolder>
         <RootNamespace>HKMP</RootNamespace>
         <AssemblyName>HKMP</AssemblyName>
-        <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
+        <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
         <FileAlignment>512</FileAlignment>
     </PropertyGroup>
     <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
@@ -36,6 +36,10 @@
           <HintPath>lib\Assembly-CSharp.dll</HintPath>
           <Private>False</Private>
         </Reference>
+        <Reference Include="MMHOOK_Assembly-CSharp, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null">
+          <HintPath>lib\MMHOOK_Assembly-CSharp.dll</HintPath>
+          <Private>False</Private>
+        </Reference>
         <Reference Include="PlayMaker, Version=1.6.0.0, Culture=neutral, PublicKeyToken=null">
           <HintPath>lib\PlayMaker.dll</HintPath>
           <Private>False</Private>
@@ -59,6 +63,10 @@
           <HintPath>lib\UnityEngine.ImageConversionModule.dll</HintPath>
           <Private>False</Private>
         </Reference>
+        <Reference Include="UnityEngine.InputLegacyModule, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null">
+          <HintPath>lib\UnityEngine.InputLegacyModule.dll</HintPath>
+          <Private>False</Private>
+        </Reference>
         <Reference Include="UnityEngine.ParticleSystemModule, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null">
           <HintPath>lib\UnityEngine.ParticleSystemModule.dll</HintPath>
           <Private>False</Private>

diff --git a/HKMP/Hkmp.cs b/HKMP/Hkmp.cs
@@ -5,10 +5,13 @@
 
 namespace Hkmp {
     // Main class of the mod
-    public class Hkmp : Mod {
+    public class Hkmp : Mod, IGlobalSettings<ModSettings> {
         // Statically create Settings object, so it can be accessed early
         private ModSettings _modSettings = new ModSettings();
 
+        public Hkmp() : base("HKMP") {
+        }
+
         public override string GetVersion() {
             return Version.String;
         }
@@ -27,9 +30,12 @@ public override void Initialize() {
             new Game.GameManager(_modSettings);
         }
 
-        public override Modding.ModSettings GlobalSettings {
-            get => _modSettings;
-            set => _modSettings = (ModSettings) value;
+        public void OnLoadGlobal(ModSettings modSettings) {
+            _modSettings = modSettings;
+        }
+
+        public ModSettings OnSaveGlobal() {
+            return _modSettings;
         }
     }
 }
diff --git a/HKMP/ModLogger.cs b/HKMP/ModLogger.cs
@@ -3,6 +3,7 @@
 namespace Hkmp {
     // Singleton class providing methods for logging purposes
     public class ModLogger : ILogger {
+
         private static string GetOriginString(object origin) {
             if (origin is string s) {
                 return s;

diff --git a/HKMP/Ui/Component/Component.cs b/HKMP/Ui/Component/Component.cs
@@ -39,8 +39,8 @@ protected Component(ComponentGroup componentGroup, Vector2 position, Vector2 siz
         public void SetGroupActive(bool groupActive) {
             // TODO: figure out why this could be happening
             if (GameObject == null) {
-                Logger.Get().Error(this, 
-                    $"The GameObject belonging to this component (type: {GetType()}) is null, this shouldn't happen");
+                // Logger.Get().Error(this, 
+                //     $"The GameObject belonging to this component (type: {GetType()}) is null, this shouldn't happen");
                 return;
             }
 

diff --git a/HKMP/Ui/Component/IInputComponent.cs b/HKMP/Ui/Component/IInputComponent.cs
@@ -1,5 +1,7 @@
 namespace Hkmp.Ui.Component {
     public interface IInputComponent : IComponent {
+        void SetInput(string input);
+
         string GetInput();
     }
 }
diff --git a/HKMP/Ui/Component/InputComponent.cs b/HKMP/Ui/Component/InputComponent.cs
@@ -82,6 +82,10 @@ public InputComponent(
             InputField.characterLimit = characterLimit;
         }
 
+        public void SetInput(string input) {
+            InputField.text = input;
+        }
+
         public string GetInput() {
             return InputField.text;
         }

diff --git a/HKMP/Ui/ConnectInterface.cs b/HKMP/Ui/ConnectInterface.cs
@@ -8,6 +8,8 @@
 
 namespace Hkmp.Ui {
     public class ConnectInterface {
+        private const string LocalhostAddress = "127.0.0.1";
+
         private readonly ModSettings _modSettings;
         private readonly ClientManager _clientManager;
         private readonly ServerManager _serverManager;
@@ -361,6 +363,14 @@ private void OnStartButtonPressed() {
             _serverFeedbackText.SetColor(Color.green);
             _serverFeedbackText.SetText("Started server");
             _serverFeedbackText.SetActive(true);
+
+            // If the setting for automatically connecting when hosting is enabled,
+            // we connect the client to itself as well
+            if (_modSettings.AutoConnectWhenHosting) {
+                _addressInput.SetInput(LocalhostAddress);
+
+                OnConnectButtonPressed();
+            }
         }
 
         private void OnStopButtonPressed() {

diff --git a/HKMP/Ui/Resources/FontManager.cs b/HKMP/Ui/Resources/FontManager.cs
@@ -26,6 +26,18 @@ public static void LoadFonts() {
                         break;
                 }
             }
+
+            if (UIFontRegular == null) {
+                Logger.Get().Error("FontManager", "UI font regular is missing!");
+            }
+
+            if (UIFontBold == null) {
+                Logger.Get().Error("FontManager", "UI font bold is missing!");
+            }
+
+            if (InGameNameFont == null) {
+                Logger.Get().Error("FontManager", "In-game name font is missing!");
+            }
         }
     }
 }
diff --git a/HKMP/Ui/UiManager.cs b/HKMP/Ui/UiManager.cs
@@ -155,8 +155,8 @@ NetClient netClient
             // The game is automatically unpaused when the knight dies, so we need
             // to disable the UI menu manually
             // TODO: this still gives issues, since it displays the cursor while we are supposed to be unpaused
-            ModHooks.Instance.AfterPlayerDeadHook += () => { pauseMenuGroup.SetActive(false); };
-
+            ModHooks.AfterPlayerDeadHook += () => { pauseMenuGroup.SetActive(false); };
+            
             MonoBehaviourUtil.Instance.OnUpdateEvent += () => { CheckKeyBinds(pauseMenuGroup); };
         }
 

diff --git a/HKMPServer/HKMPServer.csproj b/HKMPServer/HKMPServer.csproj
@@ -9,7 +9,7 @@
         <AppDesignerFolder>Properties</AppDesignerFolder>
         <RootNamespace>HKMPServer</RootNamespace>
         <AssemblyName>HKMPServer</AssemblyName>
-        <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
+        <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
         <FileAlignment>512</FileAlignment>
     </PropertyGroup>
     <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">

diff --git a/HKMPShared/Version.cs b/HKMPShared/Version.cs
@@ -1,5 +1,5 @@
 namespace Hkmp {
     public static class Version {
-        public const string String = "0.7.2";
+        public const string String = "1.0.0";
     }
 }