Friday Night Funkin'

The funkin.ui.loading.preload package powers the HTML5 preloader screen. It is responsible for preparing the game environment by downloading, caching, and parsing essential assets and scripts.

Note: This preloader is specifically designed for HTML5. It is not used on desktop platforms; desktop versions use the splash loader instead because of how Lime handles asset loading compared to HaxeFlixel.

Use JavaDoc-style code comments for public functions to ensure clarity. It is recommended to use the CodeDox extension for VSCode to support this. Comments should include descriptions for parameters and return values.

/**
 * Finds the largest deviation from the desired time inside this VoicesGroup.
 *
 * @param targetTime	The time to check against.
 * 					If none is provided, it checks the time of all members against the first member of this VoicesGroup.
 * @return The largest deviation from the target time found.
 */
public function checkSyncError(?targetTime:Float):Float

When creating a branch in your fork, select the base branch based on the files you are modifying:

• develop branch: Use this if you are modifying game code (.hx files) or any other non-documentation file. When in doubt, use develop.
• main branch: Use this only if you are modifying documentation (.md files) or GitHub configuration files (.yml files or anything in the .github folder).

Important: Do not use your fork's default main branch for your PR. Instead, create a dedicated branch for your changes (e.g., docs/fix-typo or minor-bugfix).

The following hotkeys are available regardless of the current game state. Note that most of these require a debug build of the game to function.

• INSERT: Perform immediate memory garbage collection.
• F2: Enable the Flixel debug overlay (supports partial scripting).
• F3: Take a screenshot and save it to the local screenshots directory. (Works in non-debug builds).
• F4: Forcibly switch to the Main Menu without transitions.
• F5: Hot reload scripts and data files, then restart the current state. This processes changes to files in the assets folder. Note: This may not reset song charts or song scripts due to a known bug, but will reset stage layout and character animation data.
• CTRL-ALT-SHIFT-L: Force a crash with a detailed crash log and stack trace.

JSON formatting is handled by the esbenp.prettier-vscode extension (Prettier). Configuration is managed via a .prettierrc.js file.

Formatting Behavior:

• Prettier attempts to place expressions on a single line if they fit.
• If an object is manually formatted as multi-line, Prettier will keep it multi-line.
• To force Prettier to collapse a short multi-line object into a single line, you may need to use regex replacement to remove the first newline in the object.

Before reporting a bug or suggesting an enhancement, ensure you meet the following criteria to ensure the report is valid:

1. Version: You must be playing the latest version of the game.
   • Android: v0.8.5
   • All other platforms: v0.8.4
2. Environment: Play without any mods installed.
3. Source: Use the official versions from Newgrounds or itch.io.

Variations allow a single song to have different gameplay experiences (e.g., different music or characters for 'Nightmare' mode) without duplicating everything.

To implement variations:

1. In the default variation's playData.songVariations array, include the IDs of the variations you want to support.
2. For each variation ID (e.g., erect), provide the corresponding files in the ZIP:
   • <songid>-metadata-<variation>.json (Optional)
   • <songid>-chart-<variation>.json (Optional)
   • Voices-<charid>-<variation>.ogg (Optional)
3. If a variation uses a different instrumental, specify it in the variation's metadata using playData.characters.instrumental.