Welcome to the PsychWiki section wiki!

Frequently Asked Questions

Coding

Q: Where do I place my scripts?

It should be inside the mods folder in a specific folder, each folder will execute the script in different scenario.

• scripts - A global folder, will execute the script(s) globally in any song of the mod.
• data - It should be inside another folder which is the song's name, will execute the script in said song.
• stages - It should be inside another folder which is the stage's name, will execute the script in said stage.
• custom_events - The script should be named after the event, will execute the script in an event.
• custom_notes - The script should be named after the note-type, will execute the script on a note-type.

Q: Where can I learn Lua?

Try reading the lua coding docs in here, essentially explains the basics of it. I'd recommended if you're a newbie!

Q: Where can I learn Haxe?

Try reading here, it's a bit harder the Lua. Very essential for scripting in source-code or HScripting.

Compiling

Q: I'm trying to compile the game, but it keeps failing!

Try changing the version of your libraries/downloading an older version of Haxe, click here to see versions that are confirmed to work..

Q: I'm using the Downloaded Build, the Engine can't find an specific file!

Make sure you've put your file(s) inside the mods folder, not assets folder.

Psych API

Q: How do i make a Custom Character?

A: Read this.

Q: Where do i save Menu Characters? Where do i save Weeks?

A: Read about it here.

Q: Where do i save Dialogue Portraits? Where do i save my custom Dialogue? And how do i make the dialogue play on a Song??

A: Read about it here.

Q: How can i create a Custom Event?

A: Read this.

Q: How can I create a custom credit?

Firstly create a file which is credits.txt, inside the mods/data global folder or mods/MyMod/data folder.

• A Title should have the name: Title
• Each line should have the syntax: name::iconname::description::link::colorHex

Example:

Main Credits
Shadow Mario::shadowmario::Main Programmer of Psych Engine::https://ko-fi.com/shadowmario::FFDD33
BBPanzu::bb-panzu::Assistant Programmer of Psych Engine::https://twitter.com/bbsub3::FFDD33

Q: How can I add Custom Achievements/Awards?

Copy this text and paste it in YourModFolder/data/achievements.json You can drop your achievement images in YourModFolder/images/achievements/, be sure to read the readme file inside it if you extracted the Mod Template zip.

Q: How can I add Settings to my Mod?

Copy this text and paste it in YourModFolder/data/settings.json