Lua Script API

VS Code Extension

It's highly recommended for you to install it, as it makes everything easier for you to code in LUA as you don't have to memorize the functions.

Made by Snirozu, also check DotZZ's Unofficial Lua Script API while I still didn't update the Official one, huge props to them (We are not associated).

Running a script

There's six types of LUA Scripts you can run:

• A Stage Script, it will only run if the song's stage has been set to the same as its name, it should have the same name as your stage's .json file and should be located inside mods/stages/
• A Note Type Script, it will only run if the said Note Type is being used on the chart, it should be located inside mods/custom_notetypes/
• An Event Script, it will only run if the said Event is being used on the chart, it should be located inside mods/custom_events/
• Song's Script(s), they should be saved inside the song's chart folder, it will only run on this specific song, no matter the difficulty, stage or whatever else.
• Character Script, it will only be run if the specified character is used on the current song. You can use variables dadName, boyfriendName and gfName to check the current character used's name. (if dadName == 'pico' for example)
• Global Script, it should be saved in mods/Your-Mod-Name/scripts/, it will run in all songs/difficulties, with no exceptions.

MOD FOLDER TEMPLATE

• Mod Template

API Documentation (OUTDATED)

• Variables
• General Functions
• Tweens and Timers
• Value Setting and Getting Functions
• Functions for Dialogues and Cutscenes
• Custom Sprites/Objects
• Precaching Stuff

Example Scripts

Important:

• Template Script with all Callbacks explained
• Template Mod Folder Now's already included inside mods/modTemplate.zip of your Psych Engine build

Cutscenes Examples:

• Video/Dialogue Example - Video and Dialogue on Bopeebo (Story Mode)
• Drag 'n' Drop Dialogue Script (Story Mode) - Put it inside your chart's folder

Note Types and Events:

• Example of a Custom Event - Opponent Fade
• Example of a Custom Note Type TXT - Put it in "custom_notetypes/Orange Note.txt"

Stages:

• Custom Stage Examples - Recreations of Base Game's Stages in LUA

Others:

• Tween Example - Boyfriend gets bigger on his turn
• Animated Sprite Example - Dad clone behind Dad that only bops his head
• Usage of setPropertyFromClass - Game Over Modifications