Troubleshooting Plugins RPG Maker MZ

From Yanfly.moe Wiki
Revision as of 16:14, 20 January 2022 by Yanfly (talk | contribs) (Step 2: Make an empty project and try only the plugin there.)
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.


Troubleshooting.jpg

Yanfly.png This is an article written by Yanfly.


Are you getting errors in your RPG Maker MZ plugins and you don't know why? Follow the steps below:

Step 1: Read and Reread through the plugin instructions

Read through the plugin's instructions to make sure you are using the plugin correctly.

A lot of problems often come from thinking how a plugin should work versus how the plugin actually works.

Some plugins will also list which plugins they're compatible with.

If there's a list and a plugin is not listed there, chances are, there's a plugin incompatibility if it's a plugin from outside of the plugin library.

If you read the instructions and are still getting errors, continue onward to steps 2 through 6.

Step 2: Make an empty project and try only the plugin there.

This step ONLY applies to you IF you are troubleshooting VisuStella MZ plugins.

THIS IS NOT FOR YANFLY ENGINE PLUGINS NOR ANY MV RELATED PLUGINS!

Create an empty project in RPG Maker MZ. Do NOT add anything custom to it aside from the plugin and required plugin(s).

Make sure the plugin and parent plugin(s) are updated as well!

If it doesn't work there, report it to the plugin developer team by doing as such:

  1. Create an empty RPG Maker MZ project
  2. Include the plugin and any of the required plugins inside of it. REMOVE ALL NON-VISUSTELLA MZ PLUGINS! VisuStella MZ is not responsible for plugin incompatibilities outside of the VisuStella MZ library.
  3. MAKE SURE THE PLUGIN IS UPDATED! This goes for any other plugins in the empty project, too.
  4. Exclude any other plugins that are unrelated to the problem.
  5. Recreate the problem for the plugin developer team. MAKE SURE the project works. If it doesn't work due to missing graphical or audio resources, put them in!
  6. Write down the steps needed for the plugin developer team to reproduce the problem.
  7. Upload the project online to share with the plugin developer team. VisuStella uses Google Drive to check projects.
  8. Report it to the plugin developer team.
If it works there, that means you are having a conflict in your own game. Continue onward to steps 3 through 6.

Step 3: Make sure your plugins are placed in the proper order.

Order matters! Lower Tier plugins toward the top, higher tiers toward the bottom. Watch the above video for more clarity.

If the problem persists, continue onward to steps 4 through 6.


Step 4: It's probably a compatibility problem.

If you're still having problems, it's probably a compatibility problem.

Turn off your plugins one by one to find the problem's source.

When things start working, after turning off a specific plugin, then that plugin is the trouble maker.

If none of the plugins are causing the problem, then continue onward to steps 5 and 6.


Step 5: It's probably related to the RPG Maker MZ version difference.

It's probably related to the RPG Maker MZ's base code version difference if you've turned off all but the one plugin.

Follow these steps to update your project's base code:

  1. Back up your project in case you have to revert it. THIS STEP IS EXTREMELY IMPORTANT!
  2. Open up your project in RPG Maker MZ.
  3. Select Game > Update Corescript > and select the most current version to update.
  4. Press OK.
If the latest version of RPG Maker MZ doesn't help, continue onward to step 6.


Step 6: Stop using the plugin.

That's what we recommend because it just simply won't work with your game.

Forcing it is pointless because your game survived without it before and can survive without it after.

If it is a monetized plugin, you may ask the developer for a refund after providing proof that it does not work even in an empty project.

Upon doing so, delete the plugin from your computer.