Merge pull request #43 from CallOfCreator/keybinds

Implement Keybind API

MiraAPI.Example/Buttons/Freezer/FreezeButton.cs

@@ -6,6 +6,7 @@ using MiraAPI.Hud;
 using MiraAPI.Modifiers;
 using MiraAPI.Utilities;
 using MiraAPI.Utilities.Assets;
+using Rewired;
 using UnityEngine;
 
 namespace MiraAPI.Example.Buttons.Freezer;
@@ -19,6 +20,8 @@ public class FreezeButton : CustomActionButton<PlayerControl>
     public override int MaxUses => (int)OptionGroupSingleton<FreezerRoleSettings>.Instance.FreezeUses;
 
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
+    public override KeyboardKeyCode Defaultkeybind => KeyboardKeyCode.T;
+    public override ModifierKey Modifier1 => ModifierKey.Control;
 
     protected override void OnClick()
     {

MiraAPI.Example/Buttons/MeetingButton.cs

@@ -2,6 +2,7 @@
 using MiraAPI.Hud;
 using MiraAPI.Modifiers;
 using MiraAPI.Utilities.Assets;
+using Rewired;
 using UnityEngine;
 
 namespace MiraAPI.Example.Buttons;
@@ -15,6 +16,9 @@ public class MeetingButton : CustomActionButton
     public override int MaxUses => 3;
 
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
+    public override KeyboardKeyCode Defaultkeybind => KeyboardKeyCode.P;
+    public override ModifierKey Modifier1 => ModifierKey.Control;
+    public override ModifierKey Modifier2 => ModifierKey.Shift;
 
     public override bool Enabled(RoleBehaviour? role)
     {

MiraAPI.Example/Buttons/NeutralKillerButton.cs

@@ -3,6 +3,7 @@ using MiraAPI.Example.Roles;
 using MiraAPI.GameEnd;
 using MiraAPI.Hud;
 using MiraAPI.Utilities.Assets;
+using Rewired;
 using UnityEngine;
 
 namespace MiraAPI.Example.Buttons;
@@ -12,6 +13,7 @@ public class NeutralKillerButton : CustomActionButton
     public override string Name => "Win Game";
     public override float Cooldown => 0f;
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
+    public override KeyboardKeyCode Defaultkeybind => KeyboardKeyCode.K;
     protected override void OnClick()
     {
         CustomGameOver.Trigger<NeutralKillerGameOver>([PlayerControl.LocalPlayer.Data]);

MiraAPI.Example/Buttons/Teleporter/TeleportButton.cs

@@ -5,6 +5,7 @@ using MiraAPI.GameOptions;
 using MiraAPI.Hud;
 using MiraAPI.Utilities.Assets;
 using Reactor.Utilities;
+using Rewired;
 using UnityEngine;
 
 namespace MiraAPI.Example.Buttons.Teleporter;
@@ -21,7 +22,7 @@ public class TeleportButton : CustomActionButton
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.TeleportButton;
     public override Color TextOutlineColor => new Color32(221, 176, 152, 255);
     public static bool IsZoom { get; private set; }
-
+    public override KeyboardKeyCode Defaultkeybind => KeyboardKeyCode.M;
     public override bool Enabled(RoleBehaviour? role)
     {
         return role is TeleporterRole;

MiraAPI/Hud/CustomActionButton.cs

@@ -5,6 +5,7 @@ using MiraAPI.Events.Mira;
 using MiraAPI.Patches;
 using MiraAPI.Utilities;
 using MiraAPI.Utilities.Assets;
+using Rewired;
 using UnityEngine;
 using UnityEngine.Events;
 using UnityEngine.UI;
@@ -52,6 +53,28 @@ public abstract class CustomActionButton
     /// </summary>
     public virtual int MaxUses => 0;
 
+    /// <summary>
+    /// Gets or sets the current key binding for this button.
+    /// </summary>
+    public abstract KeyboardKeyCode Defaultkeybind { get; }
+
+    /// <summary>
+    /// The first optional modifier key (e.g., Control, Shift, Alt) that must be held with the main key to activate the button.
+    /// </summary>
+    public virtual ModifierKey Modifier1 => ModifierKey.None;
+
+    /// <summary>
+    /// The second optional modifier key.
+    /// Set to <see cref="ModifierKey.None"/> if unused.
+    /// </summary>
+    public virtual ModifierKey Modifier2 => ModifierKey.None;
+
+    /// <summary>
+    /// The third optional modifier key.
+    /// Set to <see cref="ModifierKey.None"/> if unused.
+    /// </summary>
+    public virtual ModifierKey Modifier3 => ModifierKey.None;
+
     /// <summary>
     /// Gets the button's text outline color.
     /// </summary>

MiraAPI/Keybinds/KeybindManager.cs

@@ -0,0 +1,116 @@
+using System;
+using System.Collections.Generic;
+using Rewired;
+
+namespace MiraAPI.Keybinds
+{
+    /// <summary>
+    /// Lets you register and manage mod keybinds with conflict checks and rebinding support.
+    /// </summary>
+    public static class KeybindManager
+    {
+        /// <summary>
+        /// Stores all info for a registered keybind.
+        /// </summary>
+        public class KeybindEntry
+        {
+            /// <summary>Unique identifier for this keybind.</summary>
+            public string Id;
+
+            /// <summary>Text shown in the Among Us rebinding menu to describe this keybind.</summary>
+            public string Description;
+
+            /// <summary>
+            /// The method that runs when this keybind is pressed.
+            /// </summary>
+            public Action Handler;
+
+            /// <summary>
+            /// The key currently assigned to this keybind.
+            /// </summary>
+            public KeyboardKeyCode Key;
+
+            /// <summary>
+            /// If true, this keybind will be checked for conflicts with other exclusive keybinds using the same key.
+            /// </summary>
+            public bool Exclusive;
+
+            /// <summary>
+            /// The first optional modifier key (e.g., Control, Shift, Alt) that must be held with the main key.
+            /// </summary>
+            public ModifierKey Modifier1 = ModifierKey.None;
+
+            /// <summary>
+            /// The second optional modifier key, if needed. Set to <c>ModifierKey.None</c> if unused.
+            /// </summary>
+            public ModifierKey Modifier2 = ModifierKey.None;
+
+            /// <summary>
+            /// The third optional modifier key, if needed. Set to <c>ModifierKey.None</c> if unused.
+            /// </summary>
+            public ModifierKey Modifier3 = ModifierKey.None;
+        }
+
+        private static readonly List<KeybindEntry> Registered = new();
+
+        /// <summary>
+        /// Registers a new mod keybind.
+        /// </summary>
+        /// <param name="id">Unique identifier for the keybind.</param>
+        /// <param name="description">Description to display in UI.</param>
+        /// <param name="key">Default key to use if no rebind exists.</param>
+        /// <param name="handler">Method to invoke when the keybind is pressed.</param>
+        /// <param name="exclusive">If true, conflicts with other exclusive keybinds on the same key.</param>
+        /// <param name="modifier1">Optional first modifier key (e.g., <c>Control</c>, <c>Shift</c>, <c>Alt</c>) that must be held with the main key.</param>
+        /// <param name="modifier2">Optional second modifier key. Use <c>ModifierKey.None</c> if unused.</param>
+        /// <param name="modifier3">Optional third modifier key. Use <c>ModifierKey.None</c> if unused.</param>
+        /// <returns> Returns the key that was registered for this keybind. </returns>
+        public static KeyboardKeyCode Register(string id, string description, KeyboardKeyCode key, Action handler, bool exclusive = true, ModifierKey modifier1 = ModifierKey.None, ModifierKey modifier2 = ModifierKey.None, ModifierKey modifier3 = ModifierKey.None)
+        {
+            Registered.Add(new KeybindEntry
+            {
+                Id = id,
+                Description = description,
+                Key = key,
+                Handler = handler,
+                Exclusive = exclusive,
+                Modifier1 = modifier1,
+                Modifier2 = modifier2,
+                Modifier3 = modifier3,
+            });
+
+            return key;
+        }
+
+        /// <summary>
+        /// Returns all conflicts where exclusive keybinds use the same key.
+        /// </summary>
+        /// <returns>A list of pairs of keybinds that conflict.</returns>
+        public static List<(KeybindEntry, KeybindEntry)> GetConflicts()
+        {
+            var conflicts = new List<(KeybindEntry, KeybindEntry)>();
+            for (int i = 0; i < Registered.Count; i++)
+            {
+                for (int j = i + 1; j < Registered.Count; j++)
+                {
+                    var a = Registered[i];
+                    var b = Registered[j];
+                    if (a.Key == b.Key && a.Exclusive && b.Exclusive)
+                    {
+                        conflicts.Add((a, b));
+                    }
+                }
+            }
+            return conflicts;
+        }
+
+        /// <summary>
+        /// Returns all currently registered keybind entries.
+        /// </summary>
+        /// <returns>A list of all registered keybind entries.</returns>
+        public static List<KeybindEntry> GetEntries()
+        {
+            return Registered;
+        }
+    }
+}

MiraAPI/Patches/GameStartManagerPatch.cs

@@ -0,0 +1,36 @@
+using HarmonyLib;
+using MiraAPI.Keybinds;
+using UnityEngine;
+
+namespace MiraAPI.Patches;
+
+/// <summary>
+/// Checks keybind conflicts in the lobby and disables secondary ones.
+/// </summary>
+[HarmonyPatch(typeof(GameStartManager))]
+public static class GameStartManagerPatch
+{
+    public static bool conflictShown = false;
+
+    [HarmonyPatch(nameof(GameStartManager.Start))]
+    [HarmonyPostfix]
+    public static void StartPostfix(GameStartManager __instance)
+    {
+        if (conflictShown) return;
+
+        var conflicts = KeybindManager.GetConflicts();
+        if (conflicts.Count == 0) return;
+
+        conflictShown = true;
+
+        var message = "The following keybinds are disabled due to conflicts:\n\n";
+
+        foreach (var (a, b) in conflicts)
+        {
+            message += $"• <color=#FF5555>{b.Description}</color> (conflicts with {a.Description})\n";
+            b.Handler = null;
+        }
+
+        HudManager.Instance.ShowPopUp(message.TrimEnd());
+    }
+}

MiraAPI/Patches/HudManagerPatches.cs

@@ -1,7 +1,11 @@
-using HarmonyLib;
+using System;
+using System.Collections;
+using HarmonyLib;
 using MiraAPI.Hud;
+using MiraAPI.Keybinds;
 using Reactor.Utilities;
 using Reactor.Utilities.Extensions;
+using Rewired;
 using UnityEngine;
 using Object = UnityEngine.Object;
 
@@ -123,4 +127,26 @@ public static class HudManagerPatches
             }
         }
     }
+
+    [HarmonyPatch(nameof(HudManager.Update))]
+    [HarmonyPostfix]
+    public static void StartPostfix()
+    {
+        if (AmongUsClient.Instance.GameState != InnerNet.InnerNetClient.GameStates.Started) return;
+        if (PlayerControl.LocalPlayer.Data.IsDead) return;
+
+        foreach (var entry in KeybindManager.GetEntries())
+        {
+            var player = ReInput.players.GetPlayer(0);
+            var keyboard = player.controllers.Keyboard;
+
+            if (player.GetButtonDown(entry.Id) &&
+               (entry.Modifier1 == ModifierKey.None || keyboard.GetModifierKey(entry.Modifier1)) &&
+               (entry.Modifier2 == ModifierKey.None || keyboard.GetModifierKey(entry.Modifier2)) &&
+               (entry.Modifier3 == ModifierKey.None || keyboard.GetModifierKey(entry.Modifier3)))
+            {
+                entry.Handler?.Invoke();
+            }
+        }
+    }
 }

MiraAPI/Patches/Keybinds/KeybindsPatch.cs

@@ -0,0 +1,20 @@
+using HarmonyLib;
+using MiraAPI.Keybinds;
+using MiraAPI.Utilities;
+using Rewired;
+
+namespace MiraAPI.Patches.Keybinds
+{
+    [HarmonyPatch(typeof(InputManager_Base), nameof(InputManager_Base.Awake))]
+    public static class KeybindMenuPatch
+    {
+        [HarmonyPrefix]
+        private static void StartPrefix(InputManager_Base __instance)
+        {
+            foreach (var entry in KeybindManager.GetEntries())
+            {
+                __instance.userData.RegisterModBind(entry.Id, entry.Description, entry.Key, modifier1: entry.Modifier1, modifier2: entry.Modifier2, modifier3: entry.Modifier3);
+            }
+        }
+    }
+}

MiraAPI/PluginLoading/MiraPluginManager.cs

@@ -11,12 +11,14 @@ using MiraAPI.GameEnd;
 using MiraAPI.GameOptions;
 using MiraAPI.GameOptions.Attributes;
 using MiraAPI.Hud;
+using MiraAPI.Keybinds;
 using MiraAPI.Modifiers;
 using MiraAPI.Presets;
 using MiraAPI.Roles;
 using MiraAPI.Utilities;
 using Reactor.Networking;
 using Reactor.Utilities;
+using UnityEngine;
 
 namespace MiraAPI.PluginLoading;
 
@@ -129,9 +131,16 @@ public sealed class MiraPluginManager
             CustomButtonManager.Buttons = new ReadOnlyCollection<CustomActionButton>(CustomButtonManager.CustomButtons);
 
             // Cache all the registered plugins into an array for easy access
-            RegisteredPlugins = [.._registeredPlugins.Values];
+            RegisteredPlugins = [.. _registeredPlugins.Values];
 
             ModifierManager.Modifiers = new ReadOnlyCollection<BaseModifier>(ModifierManager.InternalModifiers);
+
+            foreach (var button in CustomButtonManager.Buttons)
+            {
+                KeybindManager.Register($"{button.Name}_Keybind", $"Keybind for {button.Name}", button.Defaultkeybind, button.ClickHandler, modifier1: button.Modifier1, modifier2: button.Modifier2, modifier3: button.Modifier3);
+
+                Logger<MiraApiPlugin>.Info($"Registered keybind for button '{button.GetType().Name}' with default key {button.Defaultkeybind}.");
+            }
         };
     }
 

MiraAPI/Utilities/Extensions.cs

@@ -10,6 +10,8 @@ using MiraAPI.Networking;
 using MiraAPI.Roles;
 using MiraAPI.Voting;
 using Reactor.Utilities;
+using Rewired;
+using Rewired.Data;
 using TMPro;
 using UnityEngine;
 
@@ -92,7 +94,7 @@ public static class Extensions
     /// <param name="timer">The current timer value.</param>
     /// <param name="maxTimer">The maximum timer value.</param>
     /// <param name="format">The format string to use for the timer text.</param>
-    public static void SetCooldownFormat(this ActionButton button, float timer, float maxTimer, string format="0")
+    public static void SetCooldownFormat(this ActionButton button, float timer, float maxTimer, string format = "0")
     {
         var num = Mathf.Clamp(timer / maxTimer, 0f, 1f);
         button.isCoolingDown = num > 0f;
@@ -113,7 +115,7 @@ public static class Extensions
     /// <param name="timer">The current timer value.</param>
     /// <param name="maxTimer">The maximum timer value.</param>
     /// <param name="format">The format string to use for the timer text.</param>
-    public static void SetFillUpFormat(this ActionButton button, float timer, float maxTimer, string format="0")
+    public static void SetFillUpFormat(this ActionButton button, float timer, float maxTimer, string format = "0")
     {
         var num = Mathf.Clamp(timer / maxTimer, 0f, 1f);
         button.isCoolingDown = num > 0f;
@@ -545,4 +547,49 @@ public static class Extensions
         renderer.material.SetColor(ShaderID.OutlineColor, color ?? Color.clear);
         renderer.material.SetColor(ShaderID.AddColor, color ?? Color.clear);
     }
+
+    // Inspired by: https://github.com/eDonnes124/Town-Of-Us-R/blob/master/source/Patches/Keybinds.cs#L29
+
+    /// <summary>
+    /// Registers a new mod keybind as a user-assignable button action in Rewired.
+    /// </summary>
+    /// <param name="userData">The Rewired user data to add the action to.</param>
+    /// <param name="actionName">The internal name of the action.</param>
+    /// <param name="description">Text shown in the rebinding UI.</param>
+    /// <param name="key">The default key to assign to this action.</param>
+    /// <param name="category">Category ID to group actions in Rewired (default is 0).</param>
+    /// <param name="elementIdentifierId">The element identifier ID (default is -1, meaning none specified).</param>
+    /// <param name="type">The <see cref="InputActionType"/> for this action (default is Button).</param>
+    /// <param name="modifier1">The first optional modifier key (e.g., <c>Control</c>, <c>Shift</c>, <c>Alt</c>) that must be held together with the main key.</param>
+    /// <param name="modifier2">The second optional modifier key. Set to <see cref="ModifierKey.None"/> if not used.</param>
+    /// <param name="modifier3">The third optional modifier key. Set to <see cref="ModifierKey.None"/> if not used.</param>
+    /// <returns>The action ID of the newly registered action.</returns>
+    public static int RegisterModBind(this UserData userData, string actionName, string description, KeyboardKeyCode key, int category = 0, int elementIdentifierId = -1, InputActionType type = InputActionType.Button, ModifierKey modifier1 = ModifierKey.None, ModifierKey modifier2 = ModifierKey.None, ModifierKey modifier3 = ModifierKey.None)
+    {
+        userData.AddAction(category);
+
+        var action = userData.GetAction(userData.actions.Count - 1)!;
+
+        action.name = actionName;
+        action.descriptiveName = description;
+        action.categoryId = category;
+        action.type = type;
+        action.userAssignable = true;
+
+        var map = new ActionElementMap
+        {
+            _elementIdentifierId = elementIdentifierId,
+            _actionId = action.id,
+            _elementType = ControllerElementType.Button,
+            _axisContribution = Pole.Positive,
+            _keyboardKeyCode = key,
+            _modifierKey1 = modifier1,
+            _modifierKey2 = modifier2,
+            _modifierKey3 = modifier3,
+        };
+        userData.keyboardMaps[0].actionElementMaps.Add(map);
+        userData.joystickMaps[0].actionElementMaps.Add(map);
+
+        return action.id;
+    }
 }

MiraAPI/Utilities/Helpers.cs

@@ -1,7 +1,11 @@
-using System.Collections;
+using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
+using Il2CppSystem.IO;
+using MiraAPI.Keybinds;
+using Rewired;
 using TMPro;
 using UnityEngine;
 using Object = UnityEngine.Object;
@@ -19,7 +23,7 @@ public static class Helpers
     /// <returns>A list of alive players.</returns>
     public static List<PlayerControl> GetAlivePlayers()
     {
-        return [.. GameData.Instance.AllPlayers.ToArray().Where(x => !x.IsDead && !x.Disconnected && x.Object).Select(x=>x.Object)];
+        return [.. GameData.Instance.AllPlayers.ToArray().Where(x => !x.IsDead && !x.Disconnected && x.Object).Select(x => x.Object)];
     }
 
     /// <summary>
@@ -36,10 +40,10 @@ public static class Helpers
             case 100:
                 return true;
             default:
-            {
-                var num = Random.RandomRangeInt(1, 101);
-                return num <= probability;
-            }
+                {
+                    var num = UnityEngine.Random.RandomRangeInt(1, 101);
+                    return num <= probability;
+                }
         }
     }
 
@@ -398,6 +402,25 @@ public static class Helpers
     public static string RandomString(int length, string chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")
     {
         return new string(Enumerable.Repeat(chars, length)
-            .Select(s => s[Random.RandomRangeInt(0, s.Length)]).ToArray());
+            .Select(s => s[UnityEngine.Random.RandomRangeInt(0, s.Length)]).ToArray());
+    }
+
+    /// <summary>
+    /// Finds and returns an unused KeyCode that is not equal to the excluded key.
+    /// </summary>
+    /// <param name="exclude">The KeyCode to skip during the search.</param>
+    /// <returns>
+    /// The first available KeyCode not currently used by any registered keybind,
+    /// or KeyCode.None if none are available.
+    /// </returns>
+    public static KeyboardKeyCode FindAvailableKey(KeyboardKeyCode exclude)
+    {
+        foreach (KeyboardKeyCode key in Enum.GetValues(typeof(KeyboardKeyCode)))
+        {
+            if (key == exclude) continue;
+            bool used = KeybindManager.GetEntries().Exists(e => e.Key == key);
+            if (!used) return key;
+        }
+        return KeyboardKeyCode.None;
     }
 }