data.json Configuration

ALE Psych reads mods/<mod-name>/data.json at launch to override engine defaults. Only define the keys your mod needs; unspecified values fall back to built-in defaults.

Example File

Path: mods/<mod-name>/data.json

{
        "developerMode": false,
        "mobileDebug": false,
        "scriptsHotReloading": false,

        "verbose": false,
        "allowDebugPrint": true,

        "initialState": "TitleState",
        "freeplayState": "FreeplayState",
        "storyMenuState": "StoryMenuState",
        "masterEditorState": "MasterEditorState",
        "mainMenuState": "MainMenuState",
        "optionsState": "OptionsState",

        "pauseSubState": "PauseSubState",
        "gameOverScreen": "GameOverSubState",
        "transition": "FadeTransition",

        "loadDefaultWeeks": true,

        "title": "My ALE Psych Mod",
        "icon": "appIcon",
        "width": 1280,
        "height": 720,

        "bpm": 102.0,

        "discordID": "1309982575368077416",

        "discordButtons": [
        {
        "label": "ALE Psych Website",
        "url": "https://ale-psych-crew.github.io/ALE-Psych-Website/"
        },
        {
        "label": "Mod Page",
        "url": "https://example.com/my-mod"
        }
        ],

        "modID": "modtemplate"
        }
    

Supported Keys

Development and Debug

• developerMode (Bool, default: false ): Enables dev tooling, hot reload, and debug helpers.
• mobileDebug (Bool, default: false ): Requires developerMode = true ; simulates touch controls on desktop.
• scriptsHotReloading (Bool, default: false ): Auto-reloads Lua scripts in dev mode on desktop.
• verbose (Bool, default: false ): Emits extra engine logs; avoid for production builds.
• allowDebugPrint (Bool, default: true ): Sends logs to the in-game Debug Print window when present.

Menu Flow

• initialState (String, default: "TitleState" ): Boot entry point.

• freeplayState , storyMenuState , masterEditorState , mainMenuState , optionsState : Menu and editor destinations.

• loadDefaultWeeks (Bool, default: true ): Set to false to exclude vanilla Story/Freeplay weeks.

Substates

• pauseSubState (String, default: "PauseSubState" )
• gameOverScreen (String, default: "GameOverSubState" )
• transition (String, default: "FadeTransition" ): Must inherit from MusicBeatSubstate .

Window and Presentation

• title (String, default: "Friday Night Funkin': ALE Psych" )
• icon (String, default: "appIcon" ): PNG only; omit the extension.
• width , height (Int): Window resolution in pixels.
• bpm (Float, default: 102.0 ): Default global BPM for menus and transitions.

Integration

• discordButtons (Array of Objects, optional): Defines clickable buttons in Discord Rich Presence.

  • Each entry must contain:
    • label (String): The text displayed on the button.
    • url (String): The destination link must begin with https:// or http:// , rotocol‑less URLs will not work unless the URL uses https:// or http:// .
  • Up to two buttons are supported by Discord.

• discordID (String, default: "1309982575368077416" ): Discord Rich Presence application ID.

Save Data and Mod Identity

• modID (String, optional): Namespaces save files to AlejoGDOfficial/ALEPsych/<modID>/ so saves remain stable even if the mod folder is renamed. Omit or set to null for default behavior.