Modding Achievements

Here, there's a quick tutorial of how to use achievements, as probably so much people don't know how it works

Adding achievements using mod folder

If you are looking on the mods folders, you can see a achievements folder, it is where you will put your achievement file.

The file should be a .json (if you don’t know how to create a json file, click here) file, with these written:

{
	"name": "Achievement Name",
	"icon": "Icon Name",
	"description": "Achievement Description",
	"unlocksAfter": "",
	"hidden": false,
        "customGoal": false
}

Wondering what each thing is?

• name: (String) the name of your achievement, CAUTION: This is not the achievement save tag, the achievement save tag is the "icon" thing!

• icon: (String) the name of your icon image (and the achievement save tag!) will have (and you'll need to put that in images/achievements)

• description: (String) is the description of the achievements once it’s finished

• unlocksAfter: (String) what week will be unlocked once that week is completed (use the week file name!!) unless you use custom goal, so you'll need to add what does it need to unlock

• hidden: (Bool) is for if your achievement should be hidden until you unlock it (only choose between false or true!!!)

• customGoal: (Bool) is if your achievements should not unlock after a week completed (so you'll need to precise what will it make it unlock, and then set "unlocksAfter" to null!)