February 18, 2021
A beginner's guide to understanding how plugins work in RPG Maker MV / MZ.
Do you want to use Plugins in RPG Maker MZ but don't know where to start? This tutorial series is for you! You can click here to read part 1.
If you just need a quick summary of what you can do with plugins and how to use them hiddenone created a great article that can be read over here.
Some plugins can be controlled through Plugin Commands, which are special event commands that will change how a plugin functions once they are activated. For example, here we have the TextPicture plugin installed:
To use this plugin, you must use Plugin Commands when creating your event pages. On page 3 of the event commands list, you will find the Plugin Command option.
Clicking this will allow you to select the plugin you wish to use a Plugin Command for, which will then populate the list of available commands.
For the TextPicture plugin, you can select a command called ‘Set Text Picture’ in order to make the plugin function as intended. Selecting a command will populate the list of arguments below, where you can make changes to how the plugin functions. Any changed arguments will then take effect after this event command has been initiated.
Some plugins have many more Plugin Commands available than this which will perform different tasks, as well as some that change numerous arguments and parameters. You can view them as Event Commands for Plugin Developers. Here is an example of developers can provide you:
Another way that some plugins function is through the use of notetags. In RPG Maker MZ, certain areas of the database such as skills, items, equipment, classes, etc. have a notetag box for each unique entry. Ordinarily, the contents of this box have no effect on your game, and some users opt to store developer information in them for future reference. However, some plugins make use of the Notetag box to allow the user to customize certain database entries. Plugins with well-written documentation or information in the ‘Help’ box will tell you which Notetags you are able to use, and where to put them.
Here is the plugin called AddAutoToActorCommand by Sasuke Kannazuki:
The information under ‘Help’ demonstrates how you can use the notetag <NoAutoCommand> in an Actor’s notetag box to prevent the plugin’s features from taking an effect on them. Generally, Notetags will be formatted in this way with an open < and closed > pointy bracket surrounded text. Often, these Notetags will also be adjustable by the user so that they may include strings, variables and other information that can be used to customize the plugin.
Here is how the working Notetag looks in the database:
You can use multiple Notetags for database entries, so long as there is no conflict between plugins. Some plugins may also require you to use multiple Notetags to customize your database with. It is recommended that you place different Notetags on a separate line for each new Notetag, as this is a much cleaner way of working and makes issues easier to troubleshoot in future.
When using plugins for RPG Maker MZ, some of them may require you to use Notetags in specific parts of the database or events. Here is where you will find each Notetag box:
The Notetags for events can be added in the box next to the event’s name.
For example: this might be used for plugins that give an event an aesthetic effect such as a shadow, a glow, or a label. Or it may be used for anything that affects an event’s behaviour, such as how they interact with the player.
Sometimes, Notetags can be placed into the Event Editor through ‘Comment’ which can be found on the bottom left of event command page 1.
This can sometimes add more flexibility when using plugins, as opposed to the previously mentioned Notetag box.
The Notetags for maps can be added in the box to the right of parallax backgrounds. For example: this might be used for plugins that change things to do with your map such as regions, tilesets or encounter rates.
The Notetags for actors can be found in the bottom right of the actors tab. For example: this might be used for plugins that change an actor’s parameters such as stats.
The Notetags for classes can be found in the bottom right of the classes tab. For example: this might be used for plugins that change how certain classes can interact in battle or on the map.
The Notetags for skills can be found in the bottom right of the skills tab. For example: this might be used for plugins that affect how certain skills can be used in battle or from the menu.
The Notetags for items can be found in the bottom right of the items tab. For example: this might be used for plugins that provide complex item crafting features.
The Notetags for weapons can be found in the bottom right of the weapons tab. For example: this might be used for plugins that affect how a weapon appears in the menu, such as name colors, icon overlays, etc.
The Notetags for armors can be found in the bottom right of the armors tab. For example: this might be used for plugins that affect how an armor appears in the menu, such as name colors, icon overlays, etc.
The Notetags for enemies can be found in the bottom right of the enemies tab. For example: this might be used for plugins that add more complexity to battle rewards and item drops.
The Notetags for armors can be found in the bottom right of the armors tab. For example: this might be used for plugins that affect how an armor appears in the menu, such as name colors, icon overlays, etc.
The Notetags for states can be found in the bottom right of the states tab. For example: this might be used for plugins that add more complexity to how the player can remove an actor’s state.
As the RPG Maker MZ software updates and changes, or plugin developers add new features to their work, you may find that you will need to update or patch plugins to the latest version.
In order to do this without deleting the parameters you have already set, you must not remove the old plugin from your Plugin Manager. It is also recommended that you make a backup copy of your project before updating any software or plugins.
First, add the new .js file to your plugins folder in *\js\plugins. Next, locate the plugin in the Plugin Manager. Right click the plugin in the list, and click ‘Refresh’. Be sure to save your project before playtesting, as the playtest may not always recognize plugin updates without being saved first.
◆ Important Note: Depending on the plugin you are updating, you may also find that you might need to reopen and save the plugin parameters. This is due to a slight limitation in the software’s framework, but the plugin should work correctly after this.
This is the end of the Beginner's Guide to Plugins! If you wish to make your own plugins, may these links help you achieve that goal!
