[CGMZ] Achievements

[casper667]

CGMZ Achievements
By: Casper Gaming
Last Update: March 10, 2023
Latest Version: 1.5.0​

Adds an achievements system including achievement points, secret achievements, difficulty, and more. Achievements offer automatic tracking as well as manual unlocking. Achievements can also have rewards such as items or gold, or even switches/variables. This plugin works well with CGMZ Toast Manager for pop ups when an achievement is earned. This plugin also allows for achievements based off of CGMZ Encyclopedia and Bestiary completion percentage.

• Add an achievement system with automatic tracking
• Secret achievements with different descriptions for before/after earn
• Achievement Points (optional)
• Rewards can include items, switches, variables, and more
• Criteria can include items, switches, variables, currency, and more

Spoiler: Screenshots

An achievement that has been earned

A secret achievement

An achievement with automatic tracking and a gauge progress tracker

An achievement with a lot of criteria/rewards

Achievement window can scroll if needed to show additional information

Import into plugin manager and enable the plugin. Some customization options available. Further instructions in plugin.

Plugin (along with all my other plugins) can be found here: https://www.caspergaming.com/plugins/cgmz/achievements/
Requires CGMZ Core (v1.2+) plugin: https://www.caspergaming.com/plugins/cgmz/core/
To easily add this plugin to the menu, use my Menu Command Window: https://www.caspergaming.com/plugins/cgmz/menucommandwindow/
To enable pop up messages when the user earns an achievement, use my Toast Manager: https://www.caspergaming.com/plugins/cgmz/toastmanager/
This plugin also supports achievements for completion percentages in my Encyclopedia and Bestiary: https://www.caspergaming.com/plugins/cgmz/encyclopedia/
This plugin also supports achievements for my Profession system:
https://www.caspergaming.com/plugins/cgmz/professions/

https://www.caspergaming.com/terms-of-use/

Spoiler: Version History

Version 1.0
- Initial Release

Version 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

 

[BrentBAM]

Thanks for this! Adding achievements always give something extra to do in a game.

 

[AeroPergold]

I got an error that said:

TypeError
Cannot read property 'isSecret' of undefined​

 

[casper667]

@AeroPergold could you press F8 in game to open the developer tools console and let me know what the full error trace is?

 

[AeroPergold]

@AeroPergold could you press F8 in game to open the developer tools console and let me know what the full error trace is?

So I fixed it by adding an achievement, as for doing the F8 thing, when it spits out the error it doesn't tell me anything in the console. But I think it just gives an error because there are no achievements to load if there is no achievement data.

 

[casper667]

@AeroPergold Well, I am glad to hear you were able to fix the issue. I was able to reproduce it if I opened the achievement window with no achievements set up. I will add a check for this in the next version so that it at least won't crash in that case.

 

[AeroPergold]

@AeroPergold Well, I am glad to hear you were able to fix the issue. I was able to reproduce it if I opened the achievement window with no achievements set up. I will add a check for this in the next version so that it at least won't crash in that case.

I'm glad to have found this weird quirk. Thank you for making a plan to fix it as well as making the plugin itself.

 

[casper667]

Hi all, released an update today which fixes the crash if no achievements are set up and also adds support for my CGMZ Professions plugin:

Version 1.1.0:
- Fixed crash if there are no achievements
- Added support for CGMZ Professions

 

[AeroPergold]

Hi all, released an update today which fixes the crash if no achievements are set up and also adds support for my CGMZ Professions plugin:

Version 1.1.0:
- Fixed crash if there are no achievements
- Added support for CGMZ Professions

Oh cool! But rhetorical question but what does professions do?

 

[casper667]

@AeroPergold I am not sure I understand the question, but CGMZ Professions is another plugin of mine that adds professions or skills that you can level up like cooking/mining/etc.

CGMZ - Professions

Creates a profession system for your game. Discover professions, gain experience, and level up. Profession data is easily accessed and can be used for things like restricting the player from harvesting resources if their level is not high enough, or many other uses.

www.caspergaming.com

 

[casper667]

Hi all,

Added a demo for this plugin today, in case anyone was confused on how to use it. The demo is playable in-browser or can be downloaded from the plugin's main page on my website: https://www.caspergaming.com/plugins/cgmz/achievements/

 

[AeroPergold]

So I'm not sure if this is a bug or I'm using these two plugins wrong but:

I have achievements that can be earned by completing the bestiary from the encyclopedia plugin.
But for some reason the bestiary achievements won't be achieved even if the requirements are met (i.e. the achievement for completing 5% won't be obtained despite being 5% of the bestiary is completed.)

Sorry if this reads in a fashion that would give Godzilla a stroke.

 

[casper667]

@AeroPergold Are these achievements set to "automatic tracking" in the parameters?

Edit: Nevermind, I see the issue. It is with the encyclopedia plugin. An update will be released shortly to fix this.

 

[AeroPergold]

@AeroPergold Are these achievements set to "automatic tracking" in the parameters?

Edit: Nevermind, I see the issue. It is with the encyclopedia plugin. An update will be released shortly to fix this.

Sorry for not getting back but yes its set to automatic...But no matter, you figured it out.

Also Thanks for the fix.

 

[TheGameAfter]

Hi casper667, hope you doing well.

So I'm trying out your plugins, I can't find clear info on 'How to create a new Achievement', should I put a script in the item, not a tag like with your 'crafting' plugin or there is another way? what scrtip/not tag to put? can't find it anywhere in the plugin info (only 'check/call' script).

 

[TheGameAfter]

One more question: I also want to use it with your other plugins related to this one (Professions, Encyclopedia, CGMV TOAST), so how do I add an achievement I create to the specific 'Professions' category I made (in the 'Professions' parameters).

 

[casper667]

@TheGameAfter You set achievements up in the plugin parameters, there is a parameter at the top of the list called "Achievements". You'll be able to set up a lot of things such as any profession requirements there as well.

 

[TheGameAfter]

@TheGameAfter You set achievements up in the plugin parameters, there is a parameter at the top of the list called "Achievements". You'll be able to set up a lot of things such as any profession requirements there as well.

Ok, my bad, I did set it up before asking, however, the script I use was for 'recipe' (crafting), oops, works now, thanks.

 

[casper667]

Hi all,
Small bugfix today for variable tracking in the window when using "=".

Version 1.1.1:
- Fixed bug with variable tracking when using the "=" operator

 

[Divided]

I get a bug where I use the Toast Manager for the notification and sound, the sound only comes out of the right audio channel.