Add custom keybinds

Code/client/Events/KeyPressEvent.h

@@ -0,0 +1,14 @@
+#pragma once
+
+/**
+ * @brief Dispatched when VirtualKey is pressed.
+ */
+struct KeyPressEvent
+{
+    KeyPressEvent(const uint16_t acKeyCode)
+        : VirtualKey(acKeyCode)
+    {
+    }
+
+    uint16_t VirtualKey{};
+};

Code/client/Services/Debug/DebugService.cpp

@@ -161,9 +161,11 @@ void DebugService::OnUpdate(const UpdateEvent& acUpdateEvent) noexcept
     static std::atomic<bool> s_f7Pressed = false;
     static std::atomic<bool> s_f6Pressed = false;
 
-    if (GetAsyncKeyState(VK_F3) & 0x01)
+    // Bool state handled via KeybindService due to sometimes missing the key state changes
+    if (m_debugKeyPressed)
     {
         m_showDebugStuff = !m_showDebugStuff;
+        m_debugKeyPressed = false;
     }
 
 #if (!IS_MASTER)
@@ -201,7 +203,7 @@ void DebugService::OnUpdate(const UpdateEvent& acUpdateEvent) noexcept
         {
             s_f8Pressed = true;
 
-            //PlaceActorInWorld();
+            // PlaceActorInWorld();
         }
     }
     else
@@ -226,6 +228,7 @@ static bool g_enableWeatherWindow{false};
 static bool g_enableCombatWindow{false};
 static bool g_enableCalendarWindow{false};
 static bool g_enableDragonSpawnerWindow{false};
+static bool g_enableKeybindWindow{false};
 
 void DebugService::DrawServerView() noexcept
 {
@@ -315,13 +318,24 @@ void DebugService::OnDraw() noexcept
         ImGui::EndMenu();
     }
 #endif
+    if (ImGui::BeginMenu("Keybinds"))
+    {
+        ImGui::MenuItem("Show keybinds menu", nullptr, &g_enableKeybindWindow);
+        if (ImGui::Button("Reset all binds to default"))
+        {
+            m_world.GetKeybindService().ResetKeybinds(KeybindService::Keybind::All);
+        }
+
+        ImGui::EndMenu();
+    }
     if (ImGui::BeginMenu("Debuggers"))
     {
         ImGui::MenuItem("Quests", nullptr, &g_enableQuestWindow);
         ImGui::MenuItem("Entities", nullptr, &g_enableEntitiesWindow);
         ImGui::MenuItem("Server", nullptr, &g_enableServerWindow);
         ImGui::MenuItem("Party", nullptr, &g_enablePartyWindow);
         ImGui::MenuItem("Dragon spawner", nullptr, &g_enableDragonSpawnerWindow);
+        ImGui::MenuItem("Keybinds", nullptr, &g_enableKeybindWindow);
 
 #if (!IS_MASTER)
         ImGui::MenuItem("Network", nullptr, &g_enableNetworkWindow);
@@ -368,6 +382,8 @@ void DebugService::OnDraw() noexcept
         DrawPartyView();
     if (g_enableDragonSpawnerWindow)
         DrawDragonSpawnerView();
+    if (g_enableKeybindWindow)
+        DrawKeybindView();
 
 #if (!IS_MASTER)
     if (g_enableNetworkWindow)

Code/client/Services/Debug/Views/KeybindView.cpp

@@ -0,0 +1,143 @@
+#include <Services/DebugService.h>
+#include <Services/KeybindService.h>
+
+#include "World.h"
+
+#include <imgui.h>
+
+TiltedPhoques::String ConvertWstringToString(const TiltedPhoques::WString& acWideString)
+{
+    if (acWideString.empty())
+    {
+        return {};
+    }
+
+    int size_needed = WideCharToMultiByte(CP_UTF8, 0, acWideString.c_str(), static_cast<int>(acWideString.length()), NULL, 0, NULL, NULL);
+
+    TiltedPhoques::String str(size_needed, 0);
+    WideCharToMultiByte(CP_UTF8, 0, acWideString.c_str(), static_cast<int>(acWideString.length()), &str[0], size_needed, NULL, NULL);
+
+    return str;
+}
+
+TiltedPhoques::WString BindKey(const TiltedPhoques::WString& acKeyName, bool& aBindActive, const KeybindService::Keybind& acKeyType)
+{
+    auto& keybindService = World::Get().GetKeybindService();
+    TiltedPhoques::WString keyName = acKeyName;
+
+    ImGui::SameLine(0);
+    aBindActive = true;
+
+    for (uint16_t key = 255; key > 1; key--)
+    {
+        if (GetAsyncKeyState(key) & 0x8000)
+        {
+            if (key == VK_ESCAPE)
+            {
+                aBindActive = false;
+                break;
+            }
+            if (key == VK_LBUTTON || key == VK_RBUTTON)
+            {
+                continue;
+            }
+
+            aBindActive = false;
+
+            switch (acKeyType)
+            {
+            default: break;
+            case KeybindService::None: break;
+            case KeybindService::UI:
+                keybindService.BindKey(KeybindService::UI, key);
+                break;
+            case KeybindService::Debug:
+                keybindService.BindKey(KeybindService::Debug, key);
+                break;
+            case KeybindService::RevealPlayers:
+                keybindService.BindKey(KeybindService::RevealPlayers, key);
+                break;
+            }
+
+            break;
+        }
+    }
+
+    if (aBindActive)
+        ImGui::Text("Press a key...");
+    else
+    {
+        const auto& narrowString = ConvertWstringToString(keyName);
+        ImGui::Text("%s", narrowString.c_str());
+    }
+
+    return keyName;
+}
+
+
+void DebugService::DrawKeybindView()
+{
+    auto& keybindService = World::Get().GetKeybindService();
+
+    ImGui::SetNextWindowSize(ImVec2(350, 150), ImGuiCond_FirstUseEver);
+    ImGui::Begin("Keybinds");
+
+    if (IsRebinding())
+        ImGui::Text("Press Escape to cancel");
+
+    TiltedPhoques::WString uiKeyName = keybindService.GetKey(KeybindService::Keybind::UI).first;
+    if (ImGui::Button("Show/Hide STR UI", ImVec2(200, 30)) || m_rebindUI)
+    {
+        m_rebindUI = true;
+        m_rebindDebug = false;
+        m_rebindRevealPlayers = false;
+
+        uiKeyName = BindKey(uiKeyName, m_rebindUI, KeybindService::Keybind::UI);
+    }
+    else
+    {
+        ImGui::SameLine(0);
+        const auto& narrowString = ConvertWstringToString(uiKeyName);
+        ImGui::Text("%s", narrowString.c_str());
+
+        m_rebindUI = false;
+    }
+
+    TiltedPhoques::WString debugKeyName = keybindService.GetKey(KeybindService::Keybind::Debug).first;
+    if (ImGui::Button("Show/Hide Debug UI", ImVec2(200, 30)) || m_rebindDebug)
+    {
+        m_rebindDebug = true;
+        m_rebindUI = false;
+        m_rebindRevealPlayers = false;
+
+        debugKeyName = BindKey(debugKeyName, m_rebindDebug, KeybindService::Keybind::Debug);
+    }
+    else
+    {
+        ImGui::SameLine(0);
+        const auto& narrowString = ConvertWstringToString(debugKeyName);
+        ImGui::Text("%s", narrowString.c_str());
+
+        m_rebindDebug = false;
+    }
+
+    TiltedPhoques::WString revealKeyName = keybindService.GetKey(KeybindService::Keybind::RevealPlayers).first;
+    if (ImGui::Button("Reveal Players", ImVec2(200, 30)) || m_rebindRevealPlayers)
+    {
+        m_rebindRevealPlayers = true;
+        m_rebindUI = false;
+        m_rebindDebug = false;
+
+        debugKeyName = BindKey(debugKeyName, m_rebindRevealPlayers, KeybindService::Keybind::RevealPlayers);
+    }
+    else
+    {
+        ImGui::SameLine(0);
+        const auto& narrowString = ConvertWstringToString(revealKeyName);
+        ImGui::Text("%s", narrowString.c_str());
+
+        m_rebindRevealPlayers = false;
+    }
+
+    ImGui::End();
+}

Code/client/Services/DebugService.h

@@ -1,5 +1,7 @@
 #pragma once
 
+#include "KeybindService.h"
+
 #include <Actor.h>
 
 struct World;
@@ -30,6 +32,11 @@ struct DebugService
 
     void SetDebugId(const uint32_t aFormId) noexcept;
 
+    const KeybindService::Key& GetDebugKey() const noexcept { return m_debugKeybind; }
+    void SetDebugKey(const TiltedPhoques::SharedPtr<KeybindService::Key>& acpKey) noexcept { m_debugKeybind = *acpKey; }
+    bool IsRebinding() const noexcept { return m_rebindUI || m_rebindDebug || m_rebindRevealPlayers; }
+    void DebugPressed() noexcept { m_debugKeyPressed = !m_debugKeyPressed; }
+
 protected:
     void OnDraw() noexcept;
 
@@ -60,6 +67,7 @@ struct DebugService
     void DrawCombatView();
     void DrawCalendarView();
     void DrawDragonSpawnerView();
+    void DrawKeybindView();
 
 public:
     bool m_showDebugStuff = false;
@@ -80,6 +88,12 @@ struct DebugService
     String SubtitleText = "";
     uint32_t TopicID = 0;
 
+    KeybindService::Key m_debugKeybind{};
+    bool m_debugKeyPressed{false};
+    bool m_rebindUI{false};
+    bool m_rebindDebug{false};
+    bool m_rebindRevealPlayers{false};
+
     entt::scoped_connection m_updateConnection;
     entt::scoped_connection m_drawImGuiConnection;
     entt::scoped_connection m_dialogueConnection;