Skip to content
This repository has been archived by the owner on Aug 4, 2023. It is now read-only.

8BitOSC/PsychEngine-Lua-Achievements

Repository files navigation

PSYCH ENGINE 0.6.1+ REQUIRED!!

hi what is this

psych engine lua achievements: what the devs could never do

how add achievement1!?1?1?1?1?1?1!!!?1?1?!1!?

in your mod's folder (so PsychEngine/mods/Your Mod), make a folder called achievements

then make a file called achievements.txt

the file follows this format:

Name|Image/Save Data Tag|Description|Hidden (true/false)

each line is another achievement

you can name everything whatever you want except for hidden, which is either true or false

if hidden is true, the achievement will not be visible until you unlock it

images time

now, make a folder in images, also called achievements

inside this folder, you can make an image file and name it the same as the tag you put into achievements.txt

if you need a base for your image, you can use this template.

now you've made an achievement, and-

image

oh. right. it's locked.

unlocking achievements

to unlock an achievement, use callOnLuas('unlockAchievement', {"achievement-tag", getPropertyFromClass('Paths', 'currentModDirectory'), false})

if you want to unlock an achievement at the end of a song, use this template

and boom, your achievement should be unlocked!

image