Keyboard Config (YEP) - Revision history

Yanfly at 11:07, 13 June 2020

2020-06-13T11:07:37Z

Yanfly at 14:00, 30 October 2019

2019-10-30T14:00:51Z

Yanfly at 18:07, 27 June 2019

2019-06-27T18:07:15Z

Yanfly at 17:24, 27 June 2019

2019-06-27T17:24:17Z

Yanfly at 02:08, 22 June 2019

2019-06-22T02:08:42Z

Yanfly: Created page with "{{MvPlugin |preview = https://www.youtube.com/watch?v=bvHOrQMz3fo |link1 = 2019-06-21T15:39:41Z Created page with "{{MvPlugin |preview = <youtube>https://www.youtube.com/watch?v=bvHOrQMz3fo</youtube> |link1 = <html><iframe src="https://itch.io/embed/399642" height="167" width="552" framebo..." New page<div>{{MvPlugin |preview = <youtube>https://www.youtube.com/watch?v=bvHOrQMz3fo</youtube> |link1 = <html><iframe src="https://itch.io/embed/399642" height="167" width="552" frameborder="0"></iframe></html> |link2 = [http://yanfly.moe/plugins/en/YEP_KeyboardConfig.js Mirror] }} [[Category:RPG Maker MV Utility Plugins]] {{Yanfly Engine Plugins}} == Help File == <nowiki> ============================================================================ Introduction ============================================================================ 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. ============================================================================ Button Common Event - Comment Tags ============================================================================ 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 Settings - Adding the New Options ============================================================================ 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. --------- Settings: --------- Name: \i[83]Keyboard Config Help Description: Configure the game's keyboard settings. Symbol: keyConfig Show/Hide: if (Imported.YEP_KeyboardConfig) { show = !Utils.isMobileDevice(); } else { show = false; } Enable: enabled = true; Ext: ext = 0; ---------- Functions: ---------- 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; this.resetTextColor(); this.changePaintOpacity(this.isCommandEnabled(index)); this.drawOptionsName(index); Process OK Code: this.playOkSound(); SceneManager.push(Scene_KeyConfig); 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. ============================================================================ Changelog ============================================================================ 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! </nowiki></div> </article> </main></body></html>

@@ Line 1: / Line 1: @@
 {{MvPlugin
 |preview  =  <youtube>https://www.youtube.com/watch?v=bvHOrQMz3fo</youtube>
 |link2 = <html><iframe src="https://itch.io/embed/507967" height="167" width="552" frameborder="0"></iframe></html>
 |link3 = <html><iframe src="https://itch.io/embed/398158" height="167" width="552" frameborder="0"></iframe></html>

← Older revision		Revision as of 17:24, 27 June 2019
Line 142:		Line 142:
	- Finished Plugin!		- Finished Plugin!
	</nowiki>		</nowiki>
		+
		+	<!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
		+	<!-- [[Category: RPG Maker MV Core Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Battle Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Item Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Skill Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Equip Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Status Menu Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Gameplay Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Movement Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Quest Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Options Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Eventing Plugins]] -->
		+	<!-- [[Category: RPG Maker MV Utility Plugins]] -->
		+	[[Category: RPG Maker MV Mechanical Plugins]]
		+	[[Category: RPG Maker MV Visual Plugins]]
		+	[[Category: RPG Maker MV Menu Plugins]]
		+	<!-- [[Category: RPG Maker MV Message Plugins]] -->
		+	[[Category: RPG Maker MV Quality of Life Plugins]]
		+	<!-- [[Category: RPG Maker MV Plugin Tips & Tricks]] -->
		+	<!-- [[Category: Action Sequences (MV)]] -->
		+	<!-- [[Category: Comment Tags (MV)]] -->
		+	<!-- [[Category: Main Menu Manager Integration (MV)]] -->
		+	<!-- [[Category: Notetags (MV)]] -->
		+	<!-- [[Category: Options Core Integration (MV)]] -->
		+	<!-- [[Category: Plugin Commands (MV)]] -->
		+	<!-- [[Category: Script Calls (MV)]] -->
		+	<!-- [[Category: Text Codes (MV)]] -->

@@ Line 2: / Line 2: @@
 |preview  =  <youtube>https://www.youtube.com/watch?v=bvHOrQMz3fo</youtube>
 |link1  =  <html><iframe src="https://itch.io/embed/399642" height="167" width="552" frameborder="0"></iframe></html>
-|link2  =  [http://yanfly.moe/plugins/en/YEP_KeyboardConfig.js Mirror]
+|link2 = <html><iframe src="https://itch.io/embed/507967" height="167" width="552" frameborder="0"></iframe></html>
 }}

@@ Line 27: / Line 27: @@
 </nowiki>
-== Button Common Event - Comment Tags ==
+{{Comment Tags MV}}
   <nowiki>
@@ Line 54: / Line 54: @@
 </nowiki>
-== Options Core Settings - Adding the New Options ==
+{{Options Core Integration MV}}
   <nowiki>

@@ Line 1: / Line 1: @@
 {{MvPlugin
-|preview = <youtube>https://www.youtube.com/watch?v=bvHOrQMz3fo</youtube>
+|preview  =  <youtube>https://www.youtube.com/watch?v=bvHOrQMz3fo</youtube>
-|link1 = <html><iframe src="https://itch.io/embed/399642" height="167" width="552" frameborder="0"></iframe></html>
+|link1  =  <html><iframe src="https://itch.io/embed/399642" height="167" width="552" frameborder="0"></iframe></html>
-|link2 = [http://yanfly.moe/plugins/en/YEP_KeyboardConfig.js Mirror]
+|link2  =  [http://yanfly.moe/plugins/en/YEP_KeyboardConfig.js Mirror]
 }}
@@ Line 9: / Line 9: @@
 {{Yanfly Engine Plugins}}
-== Help File ==
+== Introduction ==
   <nowiki>
 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
@@ Line 29: / Line 25: @@
 Note: If you are using Button Common Events, place this plugin beneath
 Button Common Events in the plugin parameter list.
-============================================================================
+== Button Common Event - Comment Tags ==
 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,
@@ Line 56: / Line 52: @@
    properly, there needs to be a Button Common Event bound for this common
    event as well.
-============================================================================
+== Options Core Settings - Adding the New Options ==
 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.
@@ Line 123: / Line 119: @@
 Load Config Code:
 // Empty. Provided by this plugin.
-============================================================================
+== Changelog ==
 Version 1.04:
 - Compatibility update with YEP_OptionsCore.js.