Keyboard Config (YEP)

From Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from, Æ,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



This is a plugin created for RPG Maker MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.

Masterarbeit Writer

Yanfly Engine Plugins

This plugin is a part of the Yanfly Engine Plugins library.


This plugin allows players to change their keyboard configuration from the
in-game Options menu provided that they're using a computer to play the
game and not from a mobile device. The "Keyboard Config" option will send
the player to a different screen where they can assign actions to each of
the allowed keys on the keyboard.

Certain measures are made to prevent the player from locking himself or
herself in the configuration screen. These measures are that the Enter keys
and arrow keys cannot be changed. Almost every other key is capable of being
changed to something of the player's liking.

Note: If you are using Button Common Events, place this plugin beneath
Button Common Events in the plugin parameter list.

Comment Tags


Comment Tags are similar to Notetags. RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with an event or common event. Comment Tags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Comment Tags declared by the related plugin.

Here is a list of Comment Tag(s) that you may use.

If you're using Button Common Events, you can make certain Common Events
able to be bound to the keyboard using Comment Tags. To make a Comment Tag,
use a Comment Event inside of your Common Event, and insert the following to
achieve the desired effect:

Comment Tag:

  <Config Key: text>
  This is the text displayed on the keyboard if this common event is bound
  to a keyboard key. If this text isn't used, then the text displayed will
  be the common event's name.

  <Config Text: text>
  This is the text displayed when selecting a key to bind for the keyboard
  key. This is the text displayed in the selection list. If this text isn't
  used, then the text displayed will be the common event's name.

  <Config Required>
  This makes the common event required to be bound on the keyboard before
  the player can exit the configuration menu. In order for this to work
  properly, there needs to be a Button Common Event bound for this common
  event as well.

Options Core Integration

To integrate options from this plugin into Yanfly's Options Core, use the settings below:

If you are using YEP_OptionsCore.js, you can add a new Option using this
plugin. Here's the following code/parameter settings you can use with it.


\i[83]Keyboard Config

Help Description:
Configure the game's keyboard settings.


if (Imported.YEP_KeyboardConfig) {
  show = !Utils.isMobileDevice();
} else {
  show = false;

enabled = true;

ext = 0;


Make Option Code:
this.addCommand(name, symbol, enabled, ext);

Draw Option Code:
var rect = this.itemRectForText(index);
var statusWidth = this.statusWidth();
var titleWidth = rect.width - statusWidth;

Process OK Code:

Cursor Right Code:
// Empty. Provided by this plugin.

Cursor Left Code:
// Empty. Provided by this plugin.

Default Config Code:
// Empty. Provided by this plugin.

Save Config Code:
// Empty. Provided by this plugin.

Load Config Code:
// Empty. Provided by this plugin.


Version 1.04:
- Compatibility update with YEP_OptionsCore.js.

Version 1.03:
- Bug fixed that prevented the plugin from working if specific other plugins
weren't present.

Version 1.02:
- Updated for RPG Maker MV version 1.5.0.

Version 1.01:
- Compatibility update with Button Common Events.
- Added <Config Key: text>, <Config Text: text>, and <Config Required>
comment tags. These tags work together with Button Common Events.

Version 1.00:
- Finished Plugin!