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 use this plugin, please start by setting up the audio you want your player to collect and be able to play back in the Tracks plugin parameter in the Plugin Manager. This is required setup, as otherwise you will not be able to collect any tracks for the jukebox.
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - Calls the Jukebox scene to play discovered music tracks.

Discover - Discovers (or undiscovers) a music track in the jukebox. Used for manual control over the tracks that are discovered.

Clear Saved Tracks - If allowing the player to permanently change map autoplay music via the jukebox, this plugin command can clear that data to go back to the default autoplay from the editor for the map.
IntegrationsThis plugin has special functionality when used with the following CGMZ Plugins:

[CGMZ] Scene Backgrounds - Show a custom background image in the inn shop scene. This can be a scrolling parallax image and can also handle weather.

[CGMZ] Window Backgrounds - Show a custom background image in the inn shop windows. This can be a scrolling parallax image or a static background image.

[CGMZ] Window Settings - Set the window's tone, padding, skin, background style, and more for each window in the scene.

[CGMZ] Controls Window - Show a window letting the player know what the controls are for the scene. This window automatically switches between gamepad and keyboard controls depending on the player's last input.
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_Jukebox.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 flavor text, headers, and images
  • Converted some parameters to be individual per-scene arguments

Back to Plugin