Documentation
Quick InfoVersion: Alpha R3
Made for RPG Maker MZ 1.9.0
Main FeaturesNEW OPTIONS
By default RPG Maker only provides a few options. This plugin expands that to include some new ones that are easily set up by typing in a custom symbol. These include fullscreen, stretch mode, and master volume so far with more planned in future updates.
CATEGORIES
Add categories of options such as Video, Audio, Gameplay, etc. A more modern looking options scene that gamers will be familiar with. Within each category, you can have non-selectable spaces and headers in the options, getting away from the RPG Maker default feel where everything is selectable even if it has no function connected to it.
Default OptionsIf you would like to re-create the default options, you can easily do so by setting the Symbol to the default option symbol. These are:
bgmVolume - The BGM Volume option
bgsVolume - The BGS Volume option
meVolume - The ME Volume option
seVolume - The SE Volume option
alwaysDash - The Always Dash option
commandRemember - The Command Remember option
touchUI - The Touch UI option
Note that when using these symbols, you can still modify the number string or on/off text, they will just behave as the original options did.
Special SymbolsSome symbols have special meaning when used. These are:
fullscreen - Will toggle the game between windowed and fullscreen mode.
stretch - Will toggle the stretch mode of the game window
masterVolume - Will apply to all volume settings (multiplicative)
Plugin CommandsThis plugin does not currently have any plugin commands.
Integrations[CGMZ] Scene Backgrounds - Add a custom background image, including an image that can scroll or show weather.
[CGMZ] Window Backgrounds - Add a custom background image for your options windows. This can include a scrolling image that activates only when the window is active.
[CGMZ] Window Settings - Control the window style, tone, padding, opacity, windowskin, and more for each window in the plugin with no code required.
[CGMZ] Controls Window - Add a window that shows the player gamepad or keyboard controls, depending on their 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_Options.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 option to not use category window
- Added custom options
- Added plugin command to get option values
- Added plugin command to set option values
- Added JS Option type
- Added text line display type parameter
- Added [CGMZ] Window Settings integration