feat: Continued reorganize and build apon the hook system

Author: OrsellGit

src/commands.cpp

@@ -8,6 +8,7 @@
 #include "stdafx.hpp"
 #include "commands.hpp"
 
+#include "signatures.hpp"
 #include "utils.hpp"
 
 //---------------------------------------------------------------------------------
@@ -22,15 +23,15 @@ ConVar p2sm_multiplayer_instantrespawn("p2sm_multiplayer_instantrespawn", "0", F
 
 static void ChangePtexVolumetricState(IConVar* var, const char* pOldValue, float flOldValue)
 {
-    if (!dynamic_cast<ConVar*>(var)->GetBool())
+    if (dynamic_cast<ConVar*>(var)->GetBool())
     {
-        Log(INFO, false, "Disabled volumetrics for projected textures...");
-        Memory::ReplacePattern("engine", "0F 84 47 0C 00 00 80 BF 10 02 00 00 00 0F 85 3A 0C 00 00", "0F 85 47 0C 00 00 80 BF 10 02 00 00 00 0F 84 3A 0C 00 00");
+        Log(INFO, false, "Enabled volumetrics for projected textures...");
+        Memory::ReplacePattern("engine", Signature::CShadowMgr_DrawVolumetrics_VolState, Signature::CShadowMgr_DrawVolumetrics_VolState_Patch);
     }
     else
     {
-        Log(INFO, false, "Enabled volumetrics for projected textures...");
-        Memory::ReplacePattern("engine", "0F 85 47 0C 00 00 80 BF 10 02 00 00 00 0F 84 3A 0C 00 00", "0F 84 47 0C 00 00 80 BF 10 02 00 00 00 0F 85 3A 0C 00 00");
+        Log(INFO, false, "Disabled volumetrics for projected textures...");
+        Memory::ReplacePattern("engine", Signature::CShadowMgr_DrawVolumetrics_VolState_Patch, Signature::CShadowMgr_DrawVolumetrics_VolState);
     }
 }
 ConVar p2sm_ptex_volumetrics("p2sm_ptex_volumetrics", "0", FCVAR_NONE, "Enable or disable volumetrics for projected textures.", ChangePtexVolumetricState);

src/modules/cportal_player.cpp

@@ -27,7 +27,7 @@ REDECL(CPortal_Player::FlashlightTurnOff);
 /**
  * @brief For hooking onto the function that is called before a player respawns to skip the delay that is usual there and instead force a instant respawn of the player.
  */
-DECL_HOOK(CPortal_Player::PlayerDeathThink_Hook, CPortal_Player_PlayerDeathThink);
+DEFINE_HOOK(CPortal_Player, PlayerDeathThink);
 DETOUR_T(void, CPortal_Player::PlayerDeathThink)
 {
 	if (p2sm_multiplayer_instantrespawn.GetBool())
@@ -36,17 +36,17 @@ DETOUR_T(void, CPortal_Player::PlayerDeathThink)
     	return;
     }
 
-	h_CPortal_Player_PlayerDeathThink.Disable();
+	h_PlayerDeathThink->Disable();
 	CPortal_Player::PlayerDeathThink(thisPtr);
-	h_CPortal_Player_PlayerDeathThink.Enable();
+	h_PlayerDeathThink->Enable();
 }
 
 /**
  * @brief Player flashlight turn on hook.
  * @param playSound If flashlight sound should play. Coded to always pass as false.
  * @return If flashlight was enabled successfully.
  */
-DECL_HOOK(CPortal_Player::FlashlightTurnOn_Hook, CPortal_Player_FlashlightTurnOn);
+DEFINE_HOOK(CPortal_Player, FlashlightTurnOn);
 DETOUR_T(bool, CPortal_Player::FlashlightTurnOn, bool playSound)
 {
 	CBaseEntity* pEntity = static_cast<CBaseEntity*>(thisPtr);
@@ -69,7 +69,8 @@ DETOUR_T(bool, CPortal_Player::FlashlightTurnOn, bool playSound)
  * @brief Player flashlight turn off hook.
  * @param playSound If flashlight sound should play. Coded to always pass as false.
  */
-DECL_HOOK(CPortal_Player::FlashlightTurnOff_Hook, CPortal_Player_FlashlightTurnOff);
+DEFINE_HOOK(CPortal_Player, FlashlightTurnOff);
+//Hook* CPortal_Player::h_CPortal_Player_FlashlightTurnOff = nullptr;
 DETOUR_T(void, CPortal_Player::FlashlightTurnOff, bool playSound)
 {
 	CBaseEntity* pEntity = static_cast<CBaseEntity*>(thisPtr);

src/modules/cportal_player.hpp

@@ -10,8 +10,11 @@
 #ifndef CPORTAL_PLAYER_HPP
 #define CPORTAL_PLAYER_HPP
 
+#include "hook.hpp"
 #include "utils/platform.hpp"
 
+class Hook;
+
 // Respawn Hooks.
 // extern void (__fastcall* CPortal_Player__PlayerDeathThink_orig)(CPortal_Player* thisPtr);
 // void __fastcall CPortal_Player__PlayerDeathThink_hook(CPortal_Player* thisPtr);
@@ -28,23 +31,17 @@ class CPortal_Player
 #pragma region Public Members
 
     // Player respawn hook.
+    DECL_HOOK(PlayerDeathThink);
     DECL_DETOUR_T(void, PlayerDeathThink);
-    // using _PlayerDeathThink = void(__thiscall*)(void* thisPtr);
-    // static _PlayerDeathThink PlayerDeathThink;
-    // static void __fastcall PlayerDeathThink_Hook(void* thisPtr, int edx);
 
     // Flashlight turn on hook.
+    DECL_HOOK(FlashlightTurnOn);
     DECL_DETOUR_T(bool, FlashlightTurnOn, bool playSound);
-    // using _FlashlightTurnOn = bool(__thiscall*)(void* thisPtr, bool playSound);
-    // static _FlashlightTurnOn FlashlightTurnOn;
-    // static bool __fastcall FlashlightTurnOn_Hook(void* thisPtr, int edx, bool playSound);
 
     // Flashlight turn off hook.
+    DECL_HOOK(FlashlightTurnOff);
     DECL_DETOUR_T(void, FlashlightTurnOff, bool playSound);
-    // using _FlashlightTurnOff = void(__thiscall*)(void* thisPtr, bool playSound);
-    // static _FlashlightTurnOff FlashlightTurnOff;
-    // static void __fastcall FlashlightTurnOff_Hook(void* thisPtr, int edx, bool playSound);
-    
+
     static void RespawnPlayer(int playerEntityIndex);
     static void SetFlashlightState(int playerEntityIndex, bool enabled);
 

src/modules/misc.cpp

@@ -19,7 +19,7 @@ REDECL(CPrecipitation::Spawn);
  * @brief Stop the UGC manager from automatically download workshop maps. Simply return doing nothing so that nothing gets updated and therefore nothing gets downloaded.
  * @warning This makes the game extremely unstable, most of the time crashing, if the plugin is unloaded while the game is running.
  */
-DECL_HOOK(CUGCFileRequestManager::Update_Hook, CUGCFileRequestManager_Update);
+DEFINE_HOOK(CUGCFileRequestManager, Update);
 DETOUR_T(void, CUGCFileRequestManager::Update)
 {
     return;
@@ -28,11 +28,11 @@ DETOUR_T(void, CUGCFileRequestManager::Update)
 /**
  * @brief func_precipitation entity brushes are bugged where they need to set to the world origin to function properly. 
  */
-DECL_HOOK(CPrecipitation::Spawn_Hook, CPrecipitation_Spawn);
+DEFINE_HOOK(CPrecipitation, Spawn);
 DETOUR_T(void, CPrecipitation::Spawn)
 {
-    h_CPrecipitation_Spawn.Disable();
+    h_Spawn->Disable();
     CPrecipitation::Spawn(thisPtr);
-    h_CPrecipitation_Spawn.Enable();
+    h_Spawn->Enable();
     Utils::SetOrigin(static_cast<CBaseEntity*>(thisPtr), Vector(0,0,0), false);
 }

src/modules/misc.hpp

@@ -13,12 +13,15 @@
 #include "hook.hpp"
 #include "platform.hpp"
 
+class Hook;
+
 class CUGCFileRequestManager
 {
 public: // MARK: CUGCFileRequestManager Public Members
 #pragma region Public Members
 
     // Workshop download stopping hooks.
+    DECL_HOOK(Update);
     DECL_DETOUR_T(void, Update);
 
 #pragma endregion
@@ -34,6 +37,7 @@ class CPrecipitation
 #pragma region Public Members
 
     // func_precipitation origin fix hook.
+    DECL_HOOK(Spawn);
     DECL_DETOUR_T(void, Spawn);
 
 #pragma endregion

src/p2sm.cpp

@@ -15,6 +15,7 @@
 
 #include "utils.hpp"
 #include "globals.hpp"
+#include "patch-hook.hpp"
 
 //---------------------------------------------------------------------------------
 // The plugin is a static singleton that is exported as an interface
@@ -127,74 +128,16 @@ bool CP2SMPlusPlusPlugin::Load(CreateInterfaceFn interfaceFactory, const CreateI
 
 		Log(INFO, true, "Executing game patches...");
 
-#if _WIN32
-		// When a player, both client or host, goes through a linked_portal_door entity in multiplayer, the host will crash. This fixes that.
-		Log(INFO, true, "Fixing linked portal doors for multiplayer...");
-		Memory::ReplacePattern(MODULE_SERVER, "0F B6 87 04 05 00 00 8B 16", "EB 14 87 04 05 00 00 8B 16");
-		
-		// Increase runtime max from 0.03 to 0.05.
-		// Helps add some more leeway to some things we do in VScript without the engine complaining and shutting down the rest of the script.
-		Log(INFO, true, "Patching max runtime for VScript...");
-		Memory::ReplacePattern(MODULE_VSCRIPT, "00 00 00 E0 51 B8 9E 3F", "9a 99 99 99 99 99 a9 3f");
-
-		// Increase the projected texture limit and disable the game auto-disabling others when there is more than one active. Thanks to \n and BetweenReality with help with these.
-		//! Engine limit still exists though with a max of eight env_projectedtextures.
-		Log(INFO, true, "Patching max amount of projected textures at once and auto disabling of projected textures...");
-		// CEnvProjectedTexture::EnforceSingleProjectionRules
-		Memory::ReplacePattern(MODULE_SERVER, "8B F0 3B F3 0F 84 95 00 00 00", "E9 9D 00 00 00 84 95 00 00 00"); // Skip for loop jump and jump to function return.
-		
-		// CClientShadowMgr::CalculateRenderTargetsAndSizes
-		Memory::ReplacePattern(MODULE_CLIENT, "F7 D8 1B C0 83 E0 07 40 5F", "B8 08 00 00 00 90 90 90 5F"); // Force the number of max projected texture to be 8.
-		Log(INFO, true, "Increasing shadow map resolution for projected textures...");
-		Memory::ReplacePattern(MODULE_CLIENT, "0F 95 C3 89 8E", "0F 94 C3 89 8E"); // Allow for higher resolution shadow maps without tools mode.	
-
-		Log(INFO, true, "Patching all projected textures to have volumetrics...");
-		// CShadowMgr::DrawVolumetrics
-		// TODO: Make volumetric intensity customizable.
-		Memory::ReplacePattern("engine", "0F 85 47 0C 00 00 80 BF 10 02 00 00 00 0F 84 3A 0C 00 00", "0F 84 47 0C 00 00 80 BF 10 02 00 00 00 0F 85 3A 0C 00 00"); // Make volumetrics work for projected textures.
-
-		
-#else // Linux Patching. Due to the way this plugin is structured, it's currently not possible to compile this for Linux. Literally 1984 I know, but I don't have enough time or experience to figure it out by myself. One day.
-#endif
+		if (!Patches::EnablePatches())
+		{
+			this->m_bNoUnload = true;
+			throw std::runtime_error("Failed to enable patches!");
+		}
 
 #if _WIN32
 		// MinHook initialization and hooking.
 		Log(INFO, true, "Initializing MinHook and hooking functions...");
-		MH_Initialize();
-		
-		// Hook the death think function so players can be spawned immediate when the p2sm_instantrespawn ConVar is on.
-		Log(INFO, true, "Hooking CPortal_Player::PlayerDeathThink...");
-		MH_CreateHook(
-			Memory::Scan<void*>(SERVER, "53 8B DC 83 EC 08 83 E4 F0 83 C4 04 55 8B 6B ? 89 6C 24 ? 8B EC A1 ? ? ? ? F3 0F 10 40 ? F3 0F 58 05 ? ? ? ? 83 EC 28 56 57 6A 00 51 8B F1 F3 0F 11 04 24 E8 ? ? ? ? 6A 03"),
-			&CPortal_Player__PlayerDeathThink_hook, reinterpret_cast<void**>(&CPortal_Player__PlayerDeathThink_orig)
-		);
-
-		// Hook flashlight functions.
-		Log(INFO, true, "Hooking CPortal_Player::FlashlightTurnOn...");
-		MH_CreateHook(
-			Memory::Scan<void*>(SERVER, "A1 ? ? ? ? 8B 50 ? 83 7A ? ? 75"),
-			&CPortal_Player__FlashlightTurnOn_hook, reinterpret_cast<void**>(&CPortal_Player__FlashlightTurnOn_orig)
-		);
-		Log(INFO, true, "Hooking CPortal_Player::FlashlightTurnOff...");
-		MH_CreateHook(
-			Memory::Scan<void*>(SERVER, "A1 ? ? ? ? 8B 50 ? 83 7A ? ? 74 ? 8B 81"),
-			&CPortal_Player__FlashlightTurnOff_hook, reinterpret_cast<void**>(&CPortal_Player__FlashlightTurnOff_orig)
-		);
-		
-		// Stop workshop map downloads by not returning false on the download request.
-		//!! TEMP TO FIX ORIGINAL HOOK THAT SUDDENLY BROKE
-		MH_CreateHook(
-			Memory::Scan<void*>(MODULE_CLIENT, "55 8B EC 81 EC 48 01 00 00 57"),
-			&CUGCFileRequestManager__Update_hook, reinterpret_cast<void**>(&CUGCFileRequestManager__Update_orig)
-		);
 
-		// Log(INFO, true, "Hooking CEnvProjectedTexture::EnforceSingleProjectionRules...");
-		// MH_CreateHook(
-		// 	Memory::Scan<void*>(CLIENT, "55 8B EC 8B 45 ? 8B 55 ? 50 8B 45 ? 52 8B 55 ? 50 8B 45 ? 52 8B 55 ? 50 8B 45"),
-		// 	&CWorkshopManager__CreateFileDownloadRequest_hook, reinterpret_cast<void**>(&CWorkshopManager__CreateFileDownloadRequest_orig)
-		// );
-		
-		MH_EnableHook(MH_ALL_HOOKS);
 
 #else // Linux Hooking. Due to the way this plugin is structured, it's currently not possible to compile this for Linux. Literally 1984 I know, but I don't have enough time or experience to figure it out by myself. One day.
 #endif // _WIN32
@@ -255,11 +198,10 @@ void CP2SMPlusPlusPlugin::Unload(void)
 #if _WIN32
 		Log(INFO, true, "Un-patching game patches...");
 
-		Log(INFO, true, "Un-patching linked portal doors...");
-		Memory::ReplacePattern("server", "EB 14 87 04 05 00 00 8B 16", "0F B6 87 04 05 00 00 8B 16");
-
-		Log(INFO, true, "Un-patching max runtime for VScript...");
-		Memory::ReplacePattern("vscript", "00 00 00 00 00 00 E0 3F", "00 00 00 E0 51 B8 9E 3F");
+		if (!Patches::DisablePatches())
+		{
+			throw std::runtime_error("Failed to disable patches!");
+		}
 
 		Log(INFO, true, "Disconnecting hooked functions and un-initializing MinHook...");
 		MH_DisableHook(MH_ALL_HOOKS);

src/patch-hook.cpp

@@ -0,0 +1,135 @@
+/*******************************************************************
+* @file   patch-hook.cpp
+* @brief  Perform hooks and patches for the plugin.
+* @author Orsell
+* @date   06 2025
+*********************************************************************/
+
+#include "stdafx.hpp"
+#include "patch-hook.hpp"
+
+#include "misc.hpp"
+#include "utils.hpp"
+#include "signatures.hpp"
+#include "hook.hpp"
+
+/**
+ * @brief Enable and execute the patches for the plugin.
+ * @return True if patches executed successfully.
+ */
+bool Patches::EnablePatches()
+{
+	try
+	{
+		// When a player, both client or host, goes through a linked_portal_door entity in multiplayer, the host will crash. This fixes that.
+		Log(INFO, true, "Fixing linked portal doors for multiplayer...");
+		Memory::ReplacePattern("server", Signature::CPortal_Player_NotifySystemEvent_EventTeleportUserID, Signature::CPortal_Player_NotifySystemEvent_EventTeleportUserID_Patch);
+    		
+    	// Increase runtime max from 0.03 to 0.05.
+    	// Helps add some more leeway to some things we do in VScript without the engine complaining and shutting down the rest of the script.
+    	Log(INFO, true, "Patching max runtime for VScript...");
+    	Memory::ReplacePattern("vscript", Signature::SQVM_RuntimeTimeout, Signature::SQVM_RuntimeTimeout_Patch);
+	
+    	// Disable the game auto-disabling others when there is more than one active. Thanks to \n and BetweenReality with help with these.
+    	Log(INFO, true, "Patching max amount of projected textures at once and auto disabling of projected textures...");
+    	// CEnvProjectedTexture::EnforceSingleProjectionRules
+    	Memory::ReplacePattern("server", Signature::CEnvProjectedTexture_EnforceSingleProjectionRules_Loop, Signature::CEnvProjectedTexture_EnforceSingleProjectionRules_Loop_Patch);
+    		
+    	// CClientShadowMgr::CalculateRenderTargetsAndSizes | Increase the projected texture limit from 1 -> 8
+    	Memory::ReplacePattern("client", Signature::CClientShadowMgr_CalculateRenderTargetsAndSizes_PtexLimit, Signature::CClientShadowMgr_CalculateRenderTargetsAndSizes_PtexLimit_Patch);
+    	Log(INFO, true, "Increasing shadow map resolution for projected textures...");
+		// Increase the resolution shadow maps without tools mode.
+    	Memory::ReplacePattern("client", Signature::CClientShadowMgr_CalculateRenderTargetsAndSizes_ShadowRes, Signature::CClientShadowMgr_CalculateRenderTargetsAndSizes_ShadowRes_Patch); 
+	
+    	// Log(INFO, true, "Patching all projected textures to have volumetrics...");
+    	// CShadowMgr::DrawVolumetrics
+    	// TODO: Make volumetric intensity customizable.
+    	// Memory::ReplacePattern("engine", "0F 85 47 0C 00 00 80 BF 10 02 00 00 00 0F 84 3A 0C 00 00", "0F 84 47 0C 00 00 80 BF 10 02 00 00 00 0F 85 3A 0C 00 00"); // Make volumetrics work for projected textures.
+	}
+	catch (const std::exception& ex)
+	{
+		Log(INFO, false, "Failed to perform patch operations! Exception: \"%s\"", ex.what());
+		assert(false && "Patch operations failure!");
+		return false;
+	}
+
+	return true;
+}
+
+bool Patches::DisablePatches()
+{
+	try
+	{
+		Log(INFO, true, "Un-patching linked portal doors...");
+		Memory::ReplacePattern("server", "EB 14 87 04 05 00 00 8B 16", "0F B6 87 04 05 00 00 8B 16");
+
+		Log(INFO, true, "Un-patching max runtime for VScript...");
+		Memory::ReplacePattern("vscript", "00 00 00 00 00 00 E0 3F", "00 00 00 E0 51 B8 9E 3F");
+
+		Log(INFO, true, "un-patching max amount of projected textures at once and auto disabling of projected textures...");
+		Memory::ReplacePattern("server", "E9 9D 00 00 00 84 95 00 00 00", "8B F0 3B F3 0F 84 95 00 00 00");
+		Memory::ReplacePattern("client", "B8 08 00 00 00 90 90 90 5F", "F7 D8 1B C0 83 E0 07 40 5F");
+
+		Log(INFO, true, "Increasing shadow map resolution for projected textures...");
+		Memory::ReplacePattern("client", "0F 94 C3 89 8E", "0F 95 C3 89 8E");
+	}
+	catch (const std::exception& ex)
+	{
+		Log(INFO, false, "Failed to perform un-patch operations! Exception: \"%s\"", ex.what());
+		assert(false && "Un-patch operations failure!");
+		return false;
+	}
+
+	return true;
+}
+
+bool Hooks::EnableHooks()
+{
+	MH_Initialize();
+	
+	CUGCFileRequestManager::h_Update->SetFunc<void*>(
+		Memory::Scan<void*>(MODULE_CLIENT, "55 8B EC 81 EC 48 01 00 00 57"));
+	
+	for (const auto hook : Hook::GetHooks())
+	{
+		Log(INFO, false, "HOOKED: %s", hook->GetName().c_str());
+		hook->Enable();
+	}
+	
+	// Hook the death think function so players can be spawned immediate when the p2sm_multiplayer_instantrespawn ConVar is on.
+	// Log(INFO, true, "Hooking CPortal_Player::PlayerDeathThink...");
+	// MH_CreateHook(
+	// 	Memory::Scan<void*>(MODULE_SERVER, "53 8B DC 83 EC 08 83 E4 F0 83 C4 04 55 8B 6B ? 89 6C 24 ? 8B EC A1 ? ? ? ? F3 0F 10 40 ? F3 0F 58 05 ? ? ? ? 83 EC 28 56 57 6A 00 51 8B F1 F3 0F 11 04 24 E8 ? ? ? ? 6A 03"),
+	// 	&CPortal_Player__PlayerDeathThink_hook, reinterpret_cast<void**>(&CPortal_Player__PlayerDeathThink_orig)
+	// );
+	//
+	// // Hook flashlight functions.
+	// Log(INFO, true, "Hooking CPortal_Player::FlashlightTurnOn...");
+	// MH_CreateHook(
+	// 	Memory::Scan<void*>(MODULE_SERVER, "A1 ? ? ? ? 8B 50 ? 83 7A ? ? 75"),
+	// 	&CPortal_Player__FlashlightTurnOn_hook, reinterpret_cast<void**>(&CPortal_Player__FlashlightTurnOn_orig)
+	// );
+	// Log(INFO, true, "Hooking CPortal_Player::FlashlightTurnOff...");
+	// MH_CreateHook(
+	// 	Memory::Scan<void*>(MODULE_SERVER, "A1 ? ? ? ? 8B 50 ? 83 7A ? ? 74 ? 8B 81"),
+	// 	&CPortal_Player__FlashlightTurnOff_hook, reinterpret_cast<void**>(&CPortal_Player__FlashlightTurnOff_orig)
+	// );
+	
+	// Stop workshop map downloads by not returning false on the download request.
+	//!! TEMP TO FIX ORIGINAL HOOK THAT SUDDENLY BROKE
+	// Log(INFO, true, "Hooking CWorkshopManager::CreateFileDownloadRequest...");
+	// MH_CreateHook(
+	// 	Memory::Scan<void*>(MODULE_CLIENT, "55 8B EC 81 EC 48 01 00 00 57"),
+	// 	&CUGCFileRequestManager__Update_hook, reinterpret_cast<void**>(&CUGCFileRequestManager__Update_orig)
+	// );
+
+	// Log(INFO, true, "Hooking CEnvProjectedTexture::EnforceSingleProjectionRules...");
+	// MH_CreateHook(
+	// 	Memory::Scan<void*>(CLIENT, "55 8B EC 8B 45 ? 8B 55 ? 50 8B 45 ? 52 8B 55 ? 50 8B 45 ? 52 8B 55 ? 50 8B 45"),
+	// 	&CWorkshopManager__CreateFileDownloadRequest_hook, reinterpret_cast<void**>(&CWorkshopManager__CreateFileDownloadRequest_orig)
+	// );
+	
+	MH_EnableHook(MH_ALL_HOOKS);
+
+	return true;
+}