Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin


Quick InfoVersion: 1.1.0
Made for RPG Maker MZ 1.9.0

The BasicsThe Screenshots folder will automatically be created if it does not exist. For web-hosted games, the game will prompt the user to download the screenshot.

Background Color ParameterBy default, some things rendered by the engine are somewhat transparent. Also by default, the HTML of the page has a background color of black. This bg color is not captured by the screenshot as the screenshot captures only what is rendered by the engine. You can add this bg color back in using the background color parameter. If you're not sure, it is suggested to leave it as "black". Set to blank if you want to preserve the transparency.

Plugin CommandsThis plugin supports the following plugin commands:
Take Screenshot - Takes a screenshot as if the player had pressed the Print Screen key. Also has an optional parameter to name the screenshot. If no filename is provided, it will be the default timestampe filename. Note: The filename should not contain spaces.

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_Screenshots.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.0.1
  • Removed Filesystem Functions (moved to CGMZ Core 1.7.0+)
Version 1.0.2
  • Added option to name screenshot filename differently
  • Added Spanish Language support
Version 1.0.3
  • Removed deprecated CGMZ Temp functions
Version 1.1.0
  • Added keyboard screenshot button
  • Added gamepad screenshot button

Back to Plugin