Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Alpha R2
Made for RPG Maker MZ 1.9.0
The BasicsTo get started, add the files you would like to preload to the image, audio, etc. plugin parameters. These will then be loaded when the player starts the game. Files that are already loaded can be used instantly instead of needing to wait up to a few seconds while the file loads if you wait until it is requested to load it (default behavior).

Some files are preloaded by default, so you do not need to preload those separately. These include most of the graphics in the system folder.
FontsFonts are typically small and not many are used, so they are always loaded at the start of the game and there should be no need to worry about font memory management due to this.
Images and AudioImage and audio files can be quite large. Preloading too many may lead to players' computers not being able to have them loaded all at once, especially on lower end hardware. For this reason, you should be careful to not preload too many things. In most cases, a small loading delay is not going to be noticeable by your player.
Plugin CommandsThis plugin comes with the following plugin commands:

Preload Image
Preloads an image file as needed during gameplay.

Preload Audio
Preloads an audio file as needed during gameplay.

Preload Font
Preloads a font file as needed during gameplay.
Saved GamesThis plugin is fully compatible with saved games. This means you can:

✓ Add this plugin to a saved game and it will work as expected.
✓ Change any plugin params and changes will be reflected in saved games.
✓ Remove the plugin with no issue to save data.
Filename

The filename for this plugin MUST remain CGMZ_Preloader.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.

Known Issues

This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.

Compatibility

This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.

Version HistoryVersion AlphaR2
  • Added plugin command to preload font file
  • Added plugin command to preload an image file
  • Added plugin command to preload an audio file

Back to Plugin