Release v4.5: raw mouse modes 0/1/2, Wine/PH3 path, internal menu RMF renames

Author: d3nd3

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v4.5
+
+- Raw mouse: `_sofbuddy_rawmouse` is now a mode switch (0=off, 1=4.4-style, 2=PH3-style). Mode 1 dispatches WM_INPUT and processes in DispatchMessageA; on Wine we skip raw_mouse_poll() there to avoid double-count. Mode 2 uses two-range PeekMessageA so the message loop does not run when only WM_INPUT is queued; on Windows we use GetRawInputBuffer only in IN_MouseMove/IN_MenuMouse PRE (PH3-style); on Wine we drain WM_INPUT in PRE then poll. PeekMessageA/GetMessageA override hooks and raw_mouse_drain_wm_input() added; README documents modes and relation to PH3.
+- Internal menus: SoF Buddy RMF assets renamed from sb_* to shorter names (e.g. sb_perf → cpu, sb_input → input, sb_http → network, sb_tweaks_perf → profiles, sb_scaling → ui_scale).
+- Docs: README menu.png hero image; raw_mouse and internal_menus README updates. Update-from-zip scripts (Windows/Linux) refinements.
+
 ## v4.4
 
 - Raw mouse: reworked raw input pipeline to buffer and drain high-Hz `WM_INPUT` via `GetRawInputBuffer`, skip zero-delta packets, and keep the game's original mouse cvars/flow intact while sourcing movement from hardware deltas instead of OS cursor position.

README.md

@@ -106,7 +106,7 @@
 - **`F12`** (or **`bind <key> sofbuddy_menu sof_buddy`**) — **Open the SoF Buddy menu. Use this. It’s the main entry point for all settings, updater, and profiles.**
 - `sofbuddy_list_features` — Print compiled features (and whether they are on/off).
 - `sofbuddy_menu <name>` — Open an embedded internal menu page (examples: `loading`, `sof_buddy`).
-- `sofbuddy_menu <menu>/<page>` — Open a specific embedded page (e.g. `sofbuddy_menu sof_buddy/sb_perf`).
+- `sofbuddy_menu <menu>/<page>` — Open a specific embedded page (e.g. `sofbuddy_menu sof_buddy/cpu`).
 - `sofbuddy_apply_menu_hotkey` — Re-apply bind from `_sofbuddy_menu_hotkey` (default `F12`).
 - `sofbuddy_apply_profile_comp` — Apply competitive/low-visual profile preset.
 - `sofbuddy_apply_profile_visual` — Apply visual/high-fidelity profile preset.

VERSION

@@ -1 +1 @@
-4.4
+4.5

build/generated_detours.cpp

@@ -165,6 +165,14 @@ namespace detour_DispatchMessageA {
     tDispatchMessageA oDispatchMessageA = nullptr;
 }
 
+namespace detour_PeekMessageA {
+    tPeekMessageA oPeekMessageA = nullptr;
+}
+
+namespace detour_GetMessageA {
+    tGetMessageA oGetMessageA = nullptr;
+}
+
 namespace detour_GL_BuildPolygonFromSurface {
     ManagerType& GetManager() {
         static ManagerType* instance = nullptr;
@@ -605,6 +613,28 @@ namespace detour_DispatchMessageA {
     }
 }
 
+namespace detour_PeekMessageA {
+    ManagerType& GetManager() {
+        static ManagerType* instance = nullptr;
+        if (!instance) {
+            static char storage[sizeof(ManagerType)];
+            instance = new(storage) ManagerType();
+        }
+        return *instance;
+    }
+}
+
+namespace detour_GetMessageA {
+    ManagerType& GetManager() {
+        static ManagerType* instance = nullptr;
+        if (!instance) {
+            static char storage[sizeof(ManagerType)];
+            instance = new(storage) ManagerType();
+        }
+        return *instance;
+    }
+}
+
 namespace detour_GL_BuildPolygonFromSurface {
     void __cdecl hkGL_BuildPolygonFromSurface(void* msurface_s) {
         ManagerType& mgr = GetManager();
@@ -858,6 +888,18 @@ namespace detour_GetCursorPos {
     }
 }
 
+namespace detour_GetMessageA {
+    BOOL __stdcall hkGetMessageA(LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax) {
+        return ::getmessagea_override_callback(lpMsg, hWnd, wMsgFilterMin, wMsgFilterMax, oGetMessageA);
+    }
+}
+
+namespace detour_PeekMessageA {
+    BOOL __stdcall hkPeekMessageA(LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax, UINT wRemoveMsg) {
+        return ::peekmessagea_override_callback(lpMsg, hWnd, wMsgFilterMin, wMsgFilterMax, wRemoveMsg, oPeekMessageA);
+    }
+}
+
 namespace detour_R_DrawFont {
     void __cdecl hkR_DrawFont(int screenX, int screenY, char* text, int colorPalette, char* font, bool rememberLastColor) {
         ::hkR_DrawFont(screenX, screenY, text, colorPalette, font, rememberLastColor, oR_DrawFont);

build/generated_detours.h

@@ -1097,3 +1097,67 @@ namespace {
     static AutoDetour_DispatchMessageA g_AutoDetour_DispatchMessageA;
 }
 
+namespace detour_PeekMessageA {
+    using tPeekMessageA = BOOL(__stdcall*)(LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax, UINT wRemoveMsg);
+    extern tPeekMessageA oPeekMessageA;
+    using ManagerType = TypedSharedHookManager<BOOL, LPMSG, HWND, UINT, UINT, UINT>;
+    ManagerType& GetManager();
+    
+    BOOL __stdcall hkPeekMessageA(LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax, UINT wRemoveMsg);
+}
+
+namespace {
+    struct AutoDetour_PeekMessageA {
+        AutoDetour_PeekMessageA() {
+            using namespace detour_PeekMessageA;
+            if (!GetDetourSystem().IsDetourRegistered("PeekMessageA")) {
+                void* addr_PeekMessageA = nullptr;
+                {
+                    HMODULE hMod = GetModuleHandleA("user32.dll");
+                    if (hMod) addr_PeekMessageA = reinterpret_cast<void*>(GetProcAddress(hMod, "PeekMessageA"));
+                }
+                GetDetourSystem().RegisterDetour(
+                    addr_PeekMessageA,
+                    reinterpret_cast<void*>(detour_PeekMessageA::hkPeekMessageA),
+                    reinterpret_cast<void**>(&detour_PeekMessageA::oPeekMessageA),
+                    "PeekMessageA",
+                    DetourModule::Unknown,
+                    static_cast<size_t>(0));
+            }
+        }
+    };
+    static AutoDetour_PeekMessageA g_AutoDetour_PeekMessageA;
+}
+
+namespace detour_GetMessageA {
+    using tGetMessageA = BOOL(__stdcall*)(LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax);
+    extern tGetMessageA oGetMessageA;
+    using ManagerType = TypedSharedHookManager<BOOL, LPMSG, HWND, UINT, UINT>;
+    ManagerType& GetManager();
+    
+    BOOL __stdcall hkGetMessageA(LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax);
+}
+
+namespace {
+    struct AutoDetour_GetMessageA {
+        AutoDetour_GetMessageA() {
+            using namespace detour_GetMessageA;
+            if (!GetDetourSystem().IsDetourRegistered("GetMessageA")) {
+                void* addr_GetMessageA = nullptr;
+                {
+                    HMODULE hMod = GetModuleHandleA("user32.dll");
+                    if (hMod) addr_GetMessageA = reinterpret_cast<void*>(GetProcAddress(hMod, "GetMessageA"));
+                }
+                GetDetourSystem().RegisterDetour(
+                    addr_GetMessageA,
+                    reinterpret_cast<void*>(detour_GetMessageA::hkGetMessageA),
+                    reinterpret_cast<void**>(&detour_GetMessageA::oGetMessageA),
+                    "GetMessageA",
+                    DetourModule::Unknown,
+                    static_cast<size_t>(0));
+            }
+        }
+    };
+    static AutoDetour_GetMessageA g_AutoDetour_GetMessageA;
+}
+

build/generated_registrations.h

@@ -16,6 +16,7 @@ extern LRESULT dispatchmessagea_override_callback(const MSG* msg, detour_Dispatc
 extern void drawteamicons_pre_callback(float*& targetPlayerOrigin, char*& playerName, char*& imageNameTeamIcon, int& redOrBlue);
 extern void fs_initfilesystem_override_callback(detour_FS_InitFilesystem::tFS_InitFilesystem original);
 extern BOOL getcursorpos_override_callback(LPPOINT lpPoint, detour_GetCursorPos::tGetCursorPos original);
+extern BOOL getmessagea_override_callback(LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax, detour_GetMessageA::tGetMessageA original);
 extern void gl_buildpolygonfromsurface_pre_callback(void*& msurface_s);
 extern void* gl_findimage_post_callback(void* result, char* filename, int imagetype, char mimap, char allowPicmip);
 extern void hd_textures_RefDllLoaded(char const* name);
@@ -42,7 +43,9 @@ extern void http_maps_qcommon_frame_post_callback(int msec);
 extern void http_maps_qcommon_frame_pre_callback(int& msec);
 extern void http_maps_reconnect_f_pre_callback();
 extern void in_menumouse_callback(void* cvar1, void* cvar2);
+extern void in_menumouse_pre_callback(void*& cvar1, void*& cvar2);
 extern void in_mousemove_callback(void* cmd);
+extern void in_mousemove_pre_callback(void*& cmd);
 extern void internal_menus_EarlyStartup();
 extern void internal_menus_M_PushMenu_post(char const* menu_file, char const* parentFrame, bool lock_input);
 extern void internal_menus_M_PushMenu_pre(char const*& menu_file, char const*& parentFrame, bool& lock_input);
@@ -54,6 +57,7 @@ extern void lightblend_RefDllLoaded(char const* name);
 extern void mediaTimers_EarlyStartup();
 extern void mediaTimers_PostCvarInit();
 extern void new_system_bug_EarlyStartup();
+extern BOOL peekmessagea_override_callback(LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax, UINT wRemoveMsg, detour_PeekMessageA::tPeekMessageA original);
 extern void r_blendlightmaps_post_callback();
 extern void r_blendlightmaps_pre_callback();
 extern void raw_mouse_EarlyStartup();
@@ -160,6 +164,10 @@ inline void RegisterAllFeatureHooks() {
             100);
         PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] R_BlendLightmaps post callbacks: %zu\n", mgr.GetPostCallbackCount());
     }
+    detour_IN_MouseMove::GetManager().RegisterPreCallback(
+        "raw_mouse", "in_mousemove_pre_callback",
+        [](void*& cmd) { in_mousemove_pre_callback(cmd); },
+        100);
     {
         auto& mgr = detour_IN_MouseMove::GetManager();
         PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] IN_MouseMove manager at 0x%p\n", &mgr);
@@ -169,6 +177,10 @@ inline void RegisterAllFeatureHooks() {
             100);
         PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] IN_MouseMove post callbacks: %zu\n", mgr.GetPostCallbackCount());
     }
+    detour_IN_MenuMouse::GetManager().RegisterPreCallback(
+        "raw_mouse", "in_menumouse_pre_callback",
+        [](void*& cvar1, void*& cvar2) { in_menumouse_pre_callback(cvar1, cvar2); },
+        100);
     {
         auto& mgr = detour_IN_MenuMouse::GetManager();
         PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] IN_MenuMouse manager at 0x%p\n", &mgr);

detours.yaml

@@ -454,3 +454,37 @@ functions:
     params:
       - type: const MSG*
         name: msg
+
+  - name: PeekMessageA
+    module: Unknown
+    identifier: "PeekMessageA"
+    return_type: BOOL
+    calling_convention: __stdcall
+    detour_len: 0
+    params:
+      - type: LPMSG
+        name: lpMsg
+      - type: HWND
+        name: hWnd
+      - type: UINT
+        name: wMsgFilterMin
+      - type: UINT
+        name: wMsgFilterMax
+      - type: UINT
+        name: wRemoveMsg
+
+  - name: GetMessageA
+    module: Unknown
+    identifier: "GetMessageA"
+    return_type: BOOL
+    calling_convention: __stdcall
+    detour_len: 0
+    params:
+      - type: LPMSG
+        name: lpMsg
+      - type: HWND
+        name: hWnd
+      - type: UINT
+        name: wMsgFilterMin
+      - type: UINT
+        name: wMsgFilterMax

hdr/version.h

@@ -7,4 +7,4 @@
     Increment version using: ./increment_version.sh
 */
 
-#define SOFBUDDY_VERSION "4.4"
+#define SOFBUDDY_VERSION "4.5"

rsrc/lin_scripts/update_from_zip.sh

@@ -51,7 +51,10 @@ else
     echo "Warning: could not delete ${ZIP_PATH}"
 fi
 echo
-echo "Searching for old configuration to prune..."
-find "${ROOT_DIR}" -type f -name "sofbuddy.cfg" -print -delete 2>/dev/null || true
+read -r -p "Start with fresh settings? [Y/n]: " ans
+if [[ ! "${ans,,}" =~ ^n(o)?$ ]]; then
+    echo "Searching for old configuration to prune..."
+    find "${ROOT_DIR}" -type f -name "sofbuddy.cfg" -print -delete 2>/dev/null || true
+fi
 echo
 echo "You can now launch SoF normally."

rsrc/win_scripts/update_from_zip.cmd

@@ -77,11 +77,15 @@ if /i "!EXTRACT_METHOD!"=="vbscript" (
     )
 )
 echo.
-echo Searching for old configuration to prune...
-for /r "%ROOT_DIR%" %%F in (sofbuddy.cfg) do (
-    if exist "%%F" (
-        echo   Removing: %%F
-        del /f /q "%%F" >nul 2>&1
+set "FRESH=Y"
+set /p "FRESH=Start with fresh settings? [Y/n]: "
+if /i not "!FRESH!"=="n" (
+    echo Searching for old configuration to prune...
+    for /r "%ROOT_DIR%" %%F in (sofbuddy.cfg) do (
+        if exist "%%F" (
+            echo   Removing: %%F
+            del /f /q "%%F" >nul 2>&1
+        )
     )
 )
 echo.