YEP.134 – Help File Access – RPG Maker MV

Yanfly Engine Plugins is a plugin library made for RPG Maker MV, a wonderful piece of software to help you make that role playing game of your dreams. You can find out more about RPG Maker MV here.

You can grab the plugin here:
English Dropbox
English Mirror

Sample Help File

Support Team Yanfly on Patreon

It’s not surprising for streamlined games nowadays to have their own help manuals included with the game or accessible within the game. RPG Maker MV doesn’t provide anything like that by default, unfortunately. However, using this plugin, you can create ways to access the helpfile from within your game through either the F1 key or an in-game menu. 


Introduction


It’s not surprising for streamlined games nowadays to have their own help manuals included with the game or accessible within the game. RPG Maker MV doesn’t provide anything like that by default, unfortunately. However, using this plugin, you can create ways to access the helpfile from within your game through either the F1 key or an in-game menu.

This helpfile can be linked to a local HTML file within the directory or to a website URL online, such as a wiki page. This setting has to be changed in the ‘Help File Path’ plugin parameters.


Main Menu Manager – Positioning the Help Command


For those using the Main Menu Manager and would like to position the Help command in a place you’d like, use the following format:

Name: Yanfly.Param.HelpCmd
Symbol: help
Show: $gameSystem.isShowHelpCommand()
Enabled: true
Ext:
Main Bind: this.commandHelp.bind(this)
Actor Bind:

Insert the above setup within a Main Menu Manager slot. Provided you copy the exact settings to where you need it, it will appear there while using all of the naming, enabling, disabling, hiding, and showing effects done by the plugin parameters.

Remember to turn off ‘Auto Add Menu’ from the plugin parameters.


Plugin Commands


You can use the following plugin commands to adjust how accessing the help file is done for your game.

Plugin Commands

OpenHelp
– This will open up the help file or URL for your game.

ShowMenuHelpCommand
– Will make the ‘Help’ command show up in the main menu.

HideMenuHelpCommand
– Will make the ‘Help’ command hidden in the main menu.


Happy RPG Making!


Happy RPG Making!


These plugins and Tips & Tricks ideas are made possible thanks to our creative patrons on Patreon! The majority of our Tips & Tricks, Plugins, and Lunatic Pack ideas are placed within the Patreon-exclusive Sample Project for quick and easy access! If you'd like to make a Plugin Suggestion, Yanfly's Patreon-based Suggestion Box a visit here:


If you have any bugs to report, visit the following link:


If you have any questions about Action Sequences, visit the following link:



Thank you!