lunarcloud/chief-mint-godot

Godot add-on to help define, track, and display in-game achievements

Chief Mint: Godot Achievements

This Godot 3 add-on helps you define, track, and display in-game achievements.

"Local File Storage" achievements are good for an self-distributed or Itch release, where there is no platform-native system.

Other platforms, such as Steam, should be easy to implement (Pull-Requests welcomed) - you just need to extend "ChiefMintSource".

In Editor

First, setup where you want your mint definitions to live, and what your editor source script/path will be.

Then, Define all of your achievements (mints), and save them.

In Game

You can use or create a variant of the simple notification UI, "ChiefMintSimpleUI".

During the course of your game's logic, you will want to grab the Chief Mint Singleton, and register some progress on that event.

chief-mint-godot's Issues

Display When Mints have unsaved changes

Currently no way to know if you need to save the mints.

Gotta update the definitions list when they're changed.

UI needs to enforce a Minimum Number of Mints

• If no mints exist yet, add the completion mint and one common mint labelled "unknown".
• Remove the delete button for Completion mint
• If the user deletes the last non-completion mint, create a new common mint labelled "unknown".

Implement Mint Icons

• Add to UI
• Add to resource definition
• Create example icons for example mints def

Include Rarity Levels

• Enum
  • Completion / Platinum (only one)
  • Rare / Gold
  • Uncommon / Silver
  • Common / Bronze
• UI
  • Platinum - unchangeable
  • Regular - switch between 3 other values
  • Icons
• Resource Format

Replace UI button text with icons

var save_icon_texture = theme.get_icon("Save", "EditorIcons")

https://www.reddit.com/r/godot/comments/olxx10/when_im_building_the_ui_for_my_project_is_there_a/

Implement In-Game Singleton

• Singleton
• Local Source
• 2D UI Example

Label this tool as "For Godot 3"

So we avoid confusion with Godot 4 support that may later be added.

Rarity doesn't save

it's reset to 0

Probably solved by implementing the def changed signal updating the list.