Psych Engine Documentation

The engine includes an achievement system. To learn how to implement or modify achievements, you can examine the example implementation in the source code:

• Check Achievements.hx for the achievement definitions.
• Search for checkForAchievement in PlayState.hx to see how they are triggered during gameplay.

Psych Engine uses a priority system for assets. If you want to change a base game asset (for example, an image located in assets/shared/images or assets/base_game/images), you must place your edited version in the corresponding path within your mod folder.

Specifically, to override images, place them in mods/images. The engine will automatically handle the redirection from the base game path to your mod path.

To begin developing a mod for Psych Engine, it is recommended to extract modTemplate.zip to provide a baseline structure.

If you prefer not to use the template, you can add or edit specific files manually by re-creating the original file path within your mod folder. The engine will prioritize files found in the mods/ directory over the base game files.

To install the specific Microsoft Visual Studio components required for compiling on Windows, you can use curl in a command prompt, or run the provided setup script.

Option 1: Command Line Run the following commands to download and install the VC tools and Windows 10 SDK:

curl -# -O https://download.visualstudio.microsoft.com/download/pr/3105fcfe-e771-41d6-9a1c-fc971e7d03a7/8eb13958dc429a6e6f7e0d6704d43a55f18d02a253608351b6bf6723ffdaf24e/vs_Community.exe
vs_Community.exe --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows10SDK.19041 -p

Option 2: Setup Script Run msvc-windows.bat located in the setup folder in the repository root.

For detailed information on engine features and scripting, refer to the following official resources:

• General Wiki: https://github.com/ShadowMario/FNF-PsychEngine/wiki
• Lua Script API: https://shadowmario.github.io/psychengine.lua/

Follow these steps to configure the environment and build the game from the repository root:

1. Configure Haxelib:

   • Run haxelib setup. When prompted for the repository name, enter .haxelib.
   • Mac/Linux users: You must first create a directory for your libraries: mkdir ~/haxelib && haxelib setup ~/haxelib.

2. Run Setup Script: Navigate to the setup folder and execute the appropriate script for your OS:

   • Windows: windows.bat
   • Mac/Linux: unix.sh Wait until you see the message "Finished!".

3. Compile the Game: Run the following command in the root directory: lime test cpp.

Note: The first compilation typically takes 5 to 10 minutes depending on your hardware.

To install Psych Engine, you must follow the specific build instructions provided in the repository's documentation.

Refer to the Build Instructions for the complete setup and compilation process.

You can organize images, characters, weeks, stages, sounds, and other JSON files using one of two patterns depending on your preference:

1. Shared approach: Place all assets in assets/shared/.
2. Week-specific approach: Place assets in assets/week_assets/your-week-folder/.

When adding content to the engine, place your files in the following directories:

• Charts: assets/shared/data/
• Songs: assets/songs/

Before building, ensure you have the following dependencies installed based on your operating system:

• All Platforms: git and Haxe (version 4.3.4 or greater).
• Windows: Microsoft Visual Studio Community 2022.
• Linux: VLC.
• Mac: (No additional specific dependencies listed beyond git and Haxe).

To add or customize the images displayed in the Story Menu week selection, place your Week name images in the directory used by the story menu.

If you are using the base game structure, you can find reference examples in assets/base_game/shared/images/storymenu to ensure your images follow the correct naming convention and format.