Patch Notes (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.


Introduction

This plugin grants your players the ability to access Patch Notes from the
game itself. Being able to tell your players what you've changed from inside
the game can make all the difference in the player experience. This plugin
lets players access Patch Notes from the title screen, the main menu, or
from a Plugin Command ran inside the game.

Instructions

Place your Patch Notes file (could be either a HTML or TXT file) inside the
base directory of your game project. By default, this filename is set to
'patchnotes.txt' in the Plugin Parameters, so change that if you intend to
use a different filename or file type.

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 Patch
Notes command in a place you'd like, use the following format:

      Name: Yanfly.Param.PatchCmd
    Symbol: PatchNotes
      Show: $gameSystem.isShowPatchNotesCommand()
   Enabled: true
       Ext:
 Main Bind: this.commandPatchNotes.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 Patch
file is done for your game.

Plugin Commands

  OpenPatchNotes
  - This will open up the Patch file or URL for your game.

  ShowMenuPatchNotesCommand
  - Will make the 'PatchNotes' command show up in the main menu.

  HideMenuPatchNotesCommand
  - Will make the 'PatchNotes' command hidden in the main menu.