Rpg Maker Developers Group

Original Source

• Original title: Custom Keyboard Mapping - A plugin to fully customize keybindings
• Original author: Flechi
• Original date: January 7, 2023
• Source thread: https://forums.rpgmakerweb.com/threads/custom-keyboard-mapping-a-plugin-to-fully-customize-keybindings.153867/
• Source forum path: Game Development Engines > RPG Maker Javascript Plugins > JS Plugin Releases (RMMZ)

Summary

Hi! Custom Keyboard Mapping is my latest plugin for RPG Maker MZ that allows the player to configure their keybindings by pressing any key on their keyboard. You can also define the default keybindings in the plugin parameters. DOWNLOAD: https://github.com/davidmcasas/RPGMakerMZ-CustomKeyboardMapping {

Archived First Post

Hi!

Custom Keyboard Mapping is my latest plugin for RPG Maker MZ that allows the player to configure their keybindings by pressing any key on their keyboard. You can also define the default keybindings in the plugin parameters.

DOWNLOAD: https://github.com/davidmcasas/RPGMakerMZ-CustomKeyboardMapping

What differentiates this plugin from other keyboard configuration plugins?
Other plugins display a list or table of keys to bind, so keybinding is actually limited to the displayed keys.
This plugin asks you to press the key you want to bind, so you can press literally any key on your keyboard that is recognized as a JavaScript keyCode, including special characters from regional keyboards or even multimedia keys. Then the user can select the action to bind to the pressed key.

Features
- Custom actions: In the plugin parameters you can customize which actions commands are available to bind. Here you can enter custom input actions used by your game. By default this plugin includes all RPGM MZ actions, except for "debug".
- Custom default mapping: In the plugin parameters you can customize the default keyboard mapping. RPGM MZ default mapping is set by default.
- Safeguard Keys: With this parameter you can prevent the user from editing unwanted keys. Enter & Arrow keys are included by default.
- Prevent Default: With this parameter you can prevent the default action of specific keys. By default, this plugin prevents F1, F5, F11 and F12. This helps to liberate keys for your game.
- Custom Texts: You can customize all the texts shown by the plugin, including specific key names (english names are shown by default).

Limitations
- ESC key cannot be edited, as it's used to cancel the "Press key" prompt.
- This plugin does not allow to edit gamepad or mouse. I don't think I'll add gamepad support to this plugin, but maybe I'll create a separate a plugin to edit gamepad if someone really needs it.
- This plugin does not allow to use keyboard combinations (such as Ctrl + C). If needed, you should handle action combinations in your plugins and game logic.
- This plugin does not allow to bind multiple actions to the same key. If needed, you should create an action that is handled as multiple actions by your plugins.

License
You may use this plugin for free in any commercial or non-commercial project. Credits are appreciated but not required.

Bug Report
If you come across any problem with this plugin, let me know in this thread or create an issue on Github. Please understand that I wrote this plugin to work with the vanilla RPGM MZ CoreScript. I cannot guarantee to fix problems related to use with other plugins.

Thanks!

Features Mentioned

• Custom actions: In the plugin parameters you can customize which actions commands are available to bind. Here you can enter custom input actions used by your game. By default this plugin includes all RPGM MZ actions, except for "debug".
• Custom default mapping: In the plugin parameters you can customize the default keyboard mapping. RPGM MZ default mapping is set by default.
• Safeguard Keys: With this parameter you can prevent the user from editing unwanted keys. Enter & Arrow keys are included by default.
• Prevent Default: With this parameter you can prevent the default action of specific keys. By default, this plugin prevents F1, F5, F11 and F12. This helps to liberate keys for your game.
• Custom Texts: You can customize all the texts shown by the plugin, including specific key names (english names are shown by default).
• Limitations
• ESC key cannot be edited, as it's used to cancel the "Press key" prompt.
• This plugin does not allow to edit gamepad or mouse. I don't think I'll add gamepad support to this plugin, but maybe I'll create a separate a plugin to edit gamepad if someone really needs it.
• This plugin does not allow to use keyboard combinations (such as Ctrl + C). If needed, you should handle action combinations in your plugins and game logic.
• This plugin does not allow to bind multiple actions to the same key. If needed, you should create an action that is handled as multiple actions by your plugins.

Downloads / Referenced Files

License / Terms Note

License You may use this plugin for free in any commercial or non-commercial project. Credits are appreciated but not required. Bug Report If you come across any problem with this plugin, let me know in this thread or create an issue on Github. Please understand that I wrote this plugin to work with the vanilla RPGM MZ CoreScript. I cannot guarantee to fix problems related to use with other plugins.