[CGMZ] Preloader (Patreon)

Preload image files, audio files, and fonts on game start. You can also load things before they are needed during gameplay via plugin commands. Files that are loaded ahead of time can be used instantly, removing the slight delay when using a file for the first time in your game.

! SEE BOTTOM OF POST FOR UPDATES !

Hi all, introducing [CGMZ] Preloader!

This plugin allows you to load image, audio, and font files ahead of time so they are ready instantly when you try to use them. Normally, when trying to use resources in your game there is a slight loading delay. This is typically not very noticeable on pc, but can be significant on web deploys or mobile. Preloading removes this loading delay by making sure they are already loaded when you go to use them.

Easy To Use

To use this plugin, set the files you want to preload in the plugin parameters, and then use the image, audio, or font as you normally would. This plugin handles the rest. These files stay preloaded throughout your game so you can use them without needing to worry about waiting for them to load.

Loading Delay

When you use a file, it first needs to be loaded. This introduces a slight delay, which is typically fine but can be problematic in some cases. For example, if you need a fluid animation you may not want the first showing of the animation to stutter when images are first loaded. Another example may be for timing things to happen to the music in the background, which can become desynced if your audio takes time to load.

Files preloaded with this plugin will no longer have this loading delay, so you can sync things to the music perfectly or make sprite sheet animations fluid on the first play through.

Caution: Memory Usage

Please note that loading files stores them in memory. There are hardware limits to how much you can store in memory. You typically will not need to worry about this when preloading only a few of your most important files, but it can become an issue if you try to preload everything.

Therefore, it is recommended to only preload things that you absolutely must have no loading delay. In most cases, a slight loading delay is not noticeable and you do not need to preload the asset.

Support

Casper Gaming provides quick support to any user who needs it. You can leave a comment below with your question or issue, I try to check my Patreon at least once a day. For even quicker support, you can come into the Casper Gaming Discord and ask for help in the #support channel.

Quick Facts

✅ RPG Maker MZ✅ No obfuscation✅ No AI used at any point in the creation of this plugin

Roadmap

This plugin handles basic preloading currently, but there are some things I want to add to make it even better. These are as follows:

Smart Preload features

Manual Cache Control

Load Scene with progress bar before title

As always, Casper Gaming plugins are made much better through user suggestions. If you have an idea for a feature you'd like to see implemented that is not already covered above, please let me know. You can leave suggestions in the comments below or in the #suggestions channel of the Casper Gaming Discord.

Happy RPG Making!

This version adds some plugin commands to preload font, image, or audio files. Previously, this plugin preloaded everything at game start. However, sometimes you might not need everything you want to preload to be preloaded at that time. This now allows you to preload things as needed, which should cut down on how much you need to have preloaded on game start. Note that you should still be wary of preloading too many things.

This version adds some plugin commands to unload your image or audio files. Unloading fonts was not added as they are already quite small, so there is not likely to be any harm of leaving fonts loaded. Unloading images and audio can free up quite a bit of space, especially if you know those will not be needed in the future.

This is mostly adding the infrastructure for unloading preloaded images and audio, for a future update that will automatically handle the loading and unloading of these resources.