Repository navigation
Adding a New Achievement
github-actions[bot] edited this page Aug 5, 2025
·
9 revisions
Firstly, you need a json file for your achievement. Copy this template:
{
"name": "Name",
"desc": "Description",
"hint": "Hint"
}It should be located in assets/achievements/[achievement-name].json.
Then, for your achievement to actually be loaded, navigate to assets/achievements/achList.txt and add it there.
Now, you simply need an icon for your achievement. Your icon should be in assets/images/achievements/[name].png.
I recommend that the image's size should be a square, preferably 150 x 150.
To actually be able to unlock your custom achievement, you can do it through scripting.
Examples:
HScript:
var condition:Bool = false;
var allowEndSong:Bool = false;
function update(elapsed:Float) {
if (game.score >= 1000000)
condition = true;
}
function endSong() {
if (!allowEndSong && condition) {
Achievements.unlock('road_to_a_million', {
date: Date.now(),
song: PlayState.song.song
}, {
trace('achievement unlocked successfully!');
});
allowEndSong = true;
return Function_Stop;
} else
return Function_Continue;
}Lua:
function update(elapsed)
if combo >= 100 and misses == 0 then
unlockAchievement("pro_gaming")
end
end