Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: 1.1.0
Made for RPG Maker MZ 1.9.0
The BasicsThis plugin allows you to associate sound files with an id, which you can then use a plugin command to play the sound file associated with that id. This will help you create a consistent sound if you use the same sound in multiple places. It can also help change sounds played in multiple maps at once, since you can just change the sound file in the plugin parameters instead of needing to change it in every event it is used.
Plugin CommandsThis plugin supports the following plugin commands:
Play BGM - Plays the BGM associated with the provided ID.

Play BGS - Plays the BGS associated with the provided ID.

Play ME - Plays the ME associated with the provided ID.

Play SE - Plays the SE associated with the provided ID.

Play Sound - Generic command which will play the sound based on provided ID, either as a BGM, BGS, ME, or SE, whatever the sound is set up as in the Plugin Manager

Play Random Sound - Takes a list of sound ids, and randomly selects one to play. You can also mix different types, and it will play the sound id as whatever type it is in the plugin parameters.
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_SoundIDs.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 Beta
  • Added plugin command to play a random sound from a list of sound ids
  • This plugin now warns on invalid JSON instead of crash
Version 1.0.0
  • Added console warnings for blank sound ids
Version 1.0.1
  • Updated error message texts
Version 1.1.0
  • Added variance to volume
  • Added variance to pitch
  • Added variance to pan

Back to Plugin