Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.12 KB

README.md

File metadata and controls

18 lines (14 loc) · 1.12 KB

Rewired Extension Module

Rewired Extension Module is a CoreLib submodule that allows to register new Rewired key binds. Users will be able to rebind them to what they want.

Usage example:

Make sure to call CoreLibMod.LoadModules(typeof(RewiredExtensionModule)); to in your mod EarlyInit() function, before using the module. This will load the submodule.

Now in your plugin EarlyInit() method write:

RewiredExtensionModule.AddKeybind("KeyBindID", "My Amazing Key Bind", KeyboardKeyCode.C, ModifierKey.Control);

KeyBindID must be a unique identifier, which was not already added. Description is automatically added as a I2 term. Last parameter is optional and allows the default binding to be a key combination.

If you need to translate your key bind description to more languages use verbose version:

RewiredExtensionModule.AddKeybind("KeyBindID", new Dictionary<string, string> { { "en", "My Amazing Key Bind" }, { "zh-CN", "My Amazing Key Bind (In Chinese)" }, /*...*/ }, KeyboardKeyCode.C, ModifierKey.Control);

Or use localization folder from Mod SDK with the following term: ControlMapper/KeyBindID