Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: 1.3.1
Made for RPG Maker MZ 1.9.0
The BasicsBullet points are optional. If you do not want to display a bullet point before each change, leave the option blank.

Bullet points can be numbered. If you want changes to be numbered, set the bullet option to "num". Otherwise, the text entered for the bullet option will be displayed before each change in the changelog. For example, "- " will display a - with a space after it before each change.
IntegrationsYou can use [CGMZ] Title Command Window to easily add the changelog scene to your game title screen. To do so, use the JavaScript command below:

this._commandWindow.close();
SceneManager.push(CGMZ_Scene_Changelog);

You can use [CGMZ Menu] Command Window to easily add the changelog scene to your game menu. To do so, use the JavaScript command below:

SceneManager.push(CGMZ_Scene_Changelog);


Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - Calls the changelog scene
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_Changelog.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 1.1
  • Added plugin command to call the changelog scene from anywhere
  • Added ability to add an image above each entry
  • Increased how far the window can scroll for really long changelogs
Version 1.2.0
  • Added ability to change alignment of date / log entries
  • Added ability to use character codes in text
  • Removed wrap text option - text now always wraps
  • Removed command from title screen, use CGMZ Title Command Window or similar plugin to add changelog option to the title screen
Version 1.2.1
  • Added Spanish language help documentation
  • This plugin now warns instead of crashes when invalid JSON detected
Version 1.2.2
  • Added windowskin, tone, padding, back opacity, back type options
  • Added [CGMZ] Scene Backgrounds integration
  • Added [CGMZ] Window Backgrounds integration
  • Added [CGMZ] Controls Window integration
  • Window title no longer drawn if empty
  • Changelog window improved for custom font sizes
Version 1.3.0
  • Added window width parameter
  • Added changelog separation parameter
  • Images can now come from any folder
Version 1.3.1
  • Added [CGMZ] Window Settings integration

Back to Plugin