Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: 1.8.2
Made for RPG Maker MZ 1.9.0
Failed AchievementsIf an achievement is failed, it will no longer check for automatic completion. However, you can still manually complete failed achievements via plugin command. Failed achievements do not show criteria, but can show rewards based on plugin parameter Show Rewards After Fail.
ColorsIf using CGMZ Infinite Colors, you will not be able to select the custom colors via the plugin parameters. In this case, please switch to the text input at the top of the parameter and manually type the color index number.
Date FormatsThe following numbers correspond to the following date formats:
0: MM/DD/YYYY
1: DD/MM/YYYY
2: YYYY/MM/DD
3: Month DD, YYYY
4: DD Month YYYY
5: Mon. DD, YYYY
6: DD Mon. YYYY
7: MM/DD
8: DD/MM
IntegrationsYou can use [CGMZ] Menu Command Window to easily add the Achievements scene to the main menu. To do so, use the following JavaScript:

SceneManager.push(CGMZ_Scene_Achievements);

[CGMZ] Toast Manager
This plugin has additional functionality when using CGMZ Toast Manager. CGMZ Toast allows for the display of a pop-up window on the map screen when an achievement is earned. Settings for this are configured in the Toast Manager plugin with preset id entered here. You can use %name to be replaced by the achievement name.

[CGMZ] Encyclopedia
This plugin has additional functionality when using CGMZ Encyclopedia. CGMZ Encyclopedia can be used for achievements, such as "Discover the entire encyclopedia"

[CGMZ] Professions
This plugin has additional functionality when using CGMZ Professions. CGMZ Professions can be used to create achievements such as "Attain level 5 in the Mining profession"
Plugin CommandsThis plugin supports the following plugin commands:
Earn Achievement by Name - This earns the achievement with the name provided, case sensitive

Earn Achievement by ID - This earns the achievement with the provided ID. IDs are the order the achievements are listed in the plugin manager and start at 1

Call Scene - This calls the achievement scene

Change Description - This will let you change the pre and post description of an achievement

Change Secret - This will let you change the secret property of an achievement

Fail Achievement - Marks an achievement as failed

Check Achievement - Check the status of an achievement. 0 = in progress, 1 = earned, 2 = failed

Reinitialize - This will reset all achievement progress as if you had started a new game
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 cannot modify or delete achievements in saved games. The saved game will act as if the achievement has not been modified or deleted.
✓ Remove the plugin with no issue to save data.
Filename

The filename for this plugin MUST remain CGMZ_Achievements.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.0
  • Fixed crash if there are no achievements
  • Added support for CGMZ Professions
Version 1.1.1
  • Fixed bug with variable tracking when using the "=" operator
Version 1.2.0
  • Added ability to use text codes in achievement descriptions
  • New achievements should now be automatically recognized by saved games
  • Added ability to change pre and post descriptions
  • Added option to change the label / header text color
  • Added option to change text alignment of list window
  • Added option to change text alignment of totals window
  • Fixed bug with toast audio on achievement earn
  • Fixed bug with padding on list window
  • Removed plugin command to manually recognize new achievements in saved game
Version 1.2.1
  • Fixed crash when not using CGMZ Encyclopedia
Version 1.2.2
  • Fixed bug with variable achievements not auto completing when they should
Version 1.2.3
  • Fixed crash with achievements that had switch/variable rewards
Version 1.3.0
  • Added ability to choose which order & info to display for achievements
  • Added param for Points text in total window (separate from Display window)
  • Added param to display total achievements possible in total window
  • Added param to display total points possible in total window
  • Added text params for achievement requirement text (on progress bar)
  • Documentation Updated
Version 1.4.0
  • Added categories of achievements
  • Added plugin command to change an achievement's secret property
  • Added param for transparent windows in achievement scene
  • Added param to use a custom background image in achievement scene
  • Updated color parameters to use the new color selector for plugins
Version 1.5.0
  • Added common event as reward for achievement
  • Added ability to mark an achievement as failed via Plugin Command
  • Added some display window options for failed achievements
  • Added option to fill space where touch UI buttons would be
Version 1.5.1
  • Added Spanish language help documentation
  • Fix bug where some text would not fit on small resolution sizes
  • Removed deprecated CGMZ Core functions from this plugin
  • Date Format now takes user locale into account
  • Text codes now work in the Totals window among other areas
  • Now warns instead of crash when invalid JSON detected
Version 1.6.0
  • Added custom reward text lines (must be manually awarded)
  • Added windowskin, tone, padding, back opacity options for each window
  • Added option to change header line gradient colors
  • Fixed bug rewards that only had a common event reward
  • Text codes now supported everywhere in plugin
  • Scene Background parameter now supports any image folder
  • Achievements no longer default to the Applause sound effect
  • Moved rewards, requirements, automatic, difficulty out of save data
Version 1.7.0
  • Added plugin command to check achievement status
  • Added option to show category earned/total in category window
  • Added control over reward and requirement display order
  • Added total window display style
  • Added list window width parameter
  • Added list window background image
  • Added list window on right option
  • Added total window separator text param
  • Variable Operator is now select parameter type
  • Order no longer matters with [CGMZ] Toast Manager
Version 1.7.1
  • Fixed bug with drawing item requirements twice in some cases
Version 1.8.0
  • Added actor criteria to achievements
  • Secret achievements can now hide all display info
  • Added [CGMZ] Currency System integration
  • Added [CGMZ] Scene Backgrounds integration
  • Added [CGMZ] Controls Window integration
  • Display window will now respond to font size changes
  • Removed the need to select achievements to manually scroll display window
Version 1.8.1
  • Added [CGMZ] Window Settings integration
  • Added [CGMZ] Window Backgrounds integration
Version 1.8.2
  • Added custom space display line item
  • [CGMZ] Toast Manager integration converted to preset
  • Achievement description type converted from note to multiline_string

Back to Plugin