Subscribe to download
Custom Hotkeys

Allow mod authors to use remappable keybinds.
I made this mod to prevent hotkey conflicts before they start and promptly made my only mod that uses a hotkey use it.

Open your player menu and click the binding buttons to change them, you can cancel with escape.
Unbind things with right click.

Requires Bubbet's UI Elements for the namespacer, which is used to make this a clientside only mod attached to the musiccoordinator.lua

Registering the hotkey:
Register your hotkey in the player/client/customhotkeys.lua using the function RegisterHotkey(key_id, translatable_name, default_key, translatable_tooltip, category
Where key_id is the id of the key and is used in the callback later(when receiving messages about its press)
Translatable name is the label that shows up in the binding window as displayed in the screenshot
default key is a table that must have a "key" entry that is a number or entry from KeyboardKey(which is also a number)

ex: {key = KeyboardKey._V} with optional keys for shift, alt, control, and hold_time which is in seconds.
If you wanted your key unbound by default pass {key = -1}

translatable_tooltip: A string to be displayed when hovering over the text displayed(translatable_name)
category: A string to place similar binds in the same grouping

Receiving the messages about press:
In your scripts initialize register the player callback "CustomHotkeys_YOUR_KEY_ID_HERE" and pair it to a function.

ex: Player():registerCallback("CustomHotkeys_select_valuable", "callbackFunction")

Then the callback will be sent two parameters on press/release/hold. The type, which is defined in lib/customhotkeys_enums.lua and the hud state at the time, since it uses a onPostRenderHud callback to listen for key presses.