Help File Access (YEP)

From Yanfly.moe Wiki
Jump to navigation Jump to search


System

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.

Download

Yanfly Engine Plugins

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

Click here if you want to help support Team Yanfly on Patreon.

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 Integration

To integrate access to a scene from this plugin into Yanfly's Main Menu Manager, use the settings below:

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

PluginCommandsMV.png

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MV.

Here is a list of Plugin Command(s) that you may use:

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.