Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Beta R7
Made for RPG Maker MZ 1.10.0
REQUIRED: All [CGMZ] Plugins require [CGMZ] Core placed above them in the Plugin Manager.
Quick Start GuideTo get started using this plugin, follow the below steps:

1) Fill out your treasure map data in the Maps parameter.

2) Call the Treasure Maps scene in your events using the Call Scene plugin command.

3) Manipulate map status using plugin commands for discovering, advancing stage, or completing the map as needed throughout your events.

4) The plugin handles the rest
Text CodesIn the toast text options, you can use custom text codes from this plugin:

%name
Using the above text code will substitute in the treasure map's name.

%icon
Using the above text code will substitute in the treasure map's name.
Script CallsYou can use the following script call to get the amount of completed treasure maps:
$cgmz.countCompletedTreasureMaps();

You can also prepare the scene, if you want to display undiscovered maps in it, by adding the following line after pushing the scene to the stack:
SceneManager.prepareNextScene(true);
Plugin CommandsThis plugin supports the following plugin commands:

Call Scene
This will call the treasure map scene

Discover Map
This will change the given map's discovery status

Advance Stage
This will advance the given map's stage by 1

Complete Map
This will mark a map as complete

Is Map Discovered
Sets a switch to ON/OFF based on discovered status of a map

Is Map Completed
Sets a switch to ON/OFF based on completion status of a map

Get Map Stage
Sets a variable to the stage of the given treasure map
Saved GamesThis plugin is partially compatible with saved games. This means you can:

✓ Add this plugin to a saved game and it will work as expected.
✘ Modifying plugin parameters is not fully supported. The following will not work correctly in previously saved games: You can add new maps and they will show in saved games, but modifying id/discover status or deleting maps is not supported. Saved games will act as if the map still exists and has not been modified.
✓ Remove the plugin with no issue to save data.
Filename

The filename for this plugin MUST remain CGMZ_TreasureMaps.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 BetaR2
  • Added an icon property to treasure maps
  • Added parameters to change the header line gradient color
  • Added option to change the windowskin for each window
  • Added option to have the list window on the right
  • Added option to disable touch ui space
  • Added toast for when a map's stage is updated
  • Bug fix for display window scrolling with list window
  • Bug fix for list window not resetting text color between map names
  • Standardized Toast parameter setup
  • This plugin now warns instead of crashing upon detecting invalid JSON
Version BetaR3
  • Added toast options per-map, with option to fall back to defaults
  • Added padding, back opacity, and tone parameters for each window
  • Changed description parameter type to multiline string
Version BetaR4
  • Added more customization options for display window headers
  • Added option to prevent selecting the map in the display window
  • Added [CGMZ] Scene Backgrounds integration
  • Added [CGMZ] Controls Window integration
  • Fixed bug with treasure map image file not being found on Android
  • Fixed bug with non-standard window padding causing minor scrolling issues
  • List Window Width parameter type changed
  • Order with [CGMZ] Toast Manager no longer important
Version BetaR5
  • Added new and updated marker text
  • Added Blank Line and Custom Space display option
  • Removed allow select map parameter
Version BetaR6
  • Added completed name / icon
  • Added [CGMZ] Window Backgrounds integration
  • Added [CGMZ] Window Settings integration
  • Improved [CGMZ] Toast Manager integration
Version BetaR7
  • Added option to show undiscovered maps in scene
  • Added Danger Level and Location flavor parameters
  • Added [CGMZ] Rumble Integration

Back to Plugin