Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin


Quick InfoVersion: Alpha
Made for RPG Maker MZ 1.9.0

Quick Start GuideThe basic setup and usage of this plugin follows the below steps:

1. In the plugin parameters, set up your cheat code data by clicking on the Cheat Codes parameter under Main Config. Make sure your cheat codes have a unique id, which should not contain symbols or spaces. IDs do not have to be numbers, they just have to be unique.

2. Call the scene using plugin command "Call Scene" (or use the JS below to add the cheat code scene to the menu using a plugin that can add menu commands).

Problems? Check the below FAQ for common errors and how to fix them:
Cheat code is stuck locked / hidden / mystery?
To unlock a cheat code, either make it start unlocked in the cheat code setup or use the plugin command "Unlock Cheat Code" and type in the id you assigned to the cheat code. Note that IDs are case sensitive, "BIGHEAD" is different than "bighead" when typing a cheat code id in.

Cheat Code not turning on even when it is unlocked?
Make sure your cheat code has its Switch parameter set up.

Cheat Code turning on/off randomly?
Cheat codes work by turning on or off normal game switches (the Switch parameter in cheat code setup). You can also turn these on/off through your event commands, so if it is getting turned on or off randomly check that your event commands are not set to turn that switch on or off.

JavaScriptIf you want to add access to the cheat code to the main menu or somewhere else only available through JS, you can call the scene using the following JS script:

SceneManager.push(CGMZ_Scene_CheatCodes);


Plugin CommandsThis plugin supports the following plugin commands:

Call Scene
Opens the cheat code scene.

Unlock Cheat Code
Unlocks a cheat code by id.

IntegrationsThis plugin has additional features when used alongside the following [CGMZ] plugins:

[CGMZ] Scene Backgrounds
Show a custom background image in your cheat code scene, including video or scrolling animated parallax images. You can even carry the map weather over!

[CGMZ] Window Backgrounds
Show a custom background image in your cheat code window, including scrolling animated parallax images and some more animated options.

[CGMZ] Window Settings
Control the window background type, windowskin, padding, tone, and more. This plugin allows total control over most window customizations.

[CGMZ] Controls Window
Show the player the controls of the cheat code scene. Controls automatically swap between keyboard and gamepad controls depending on the last input type the player used, and buttons can be animated to show them being pressed.

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_CheatCodes.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.

Back to Plugin