Friday Night Funkin' Documentation

Everything you need to compile the game, create mods, and contribute to the rhythm game sensation built with HaxeFlixel

Quick start

Get Friday Night Funkin' running on your machine in minutes

Download and install Haxe from [Haxe.org](https://haxe.org) and Git from [git-scm.com](https://www.git-scm.com). Make sure you have the required build tools for your platform. Clone the repository and initialize submodules to download game assets: ```bash theme={null} git clone https://github.com/FunkinCrew/funkin.git cd funkin git submodule update --init --recursive ``` Install hmm (Haxe Module Manager) and all required libraries: ```bash theme={null} haxelib --global install hmm haxelib --global run hmm setup hmm install haxelib run lime setup ``` Compile and launch the game for your platform: ```bash theme={null} lime test windows # or: lime test mac, lime test linux, lime test html5 ``` On first build, you may need to run `lime rebuild ` and `lime rebuild -debug` to compile native dependencies.

Explore by topic

Jump into the documentation that matches your goals

Compile the game from source, set up your development environment, and contribute code Create custom songs, characters, stages, and gameplay with Polymod and HScript Understand the core gameplay mechanics, character system, and stage architecture Master the Chart Editor, Stage Editor, and Animation Editor built into the game

Key features

What makes Friday Night Funkin' special

Rhythm-based gameplay

Hit arrows to the beat with precise timing, BPM changes, and complex charting patterns

Extensive modding support

Polymod framework with HScript scripting for custom songs, characters, stages, and mechanics

Multi-platform

Runs on Windows, Mac, Linux, HTML5, Android, and iOS with optimized builds for each

Built-in editors

Chart Editor, Stage Editor, and Animation Editor for creating and editing game content

API reference

Explore the core classes and systems that power Friday Night Funkin'

Conductor, PlayState, Assets, Preferences FunkinSound, VoicesGroup, audio visualization Characters, stages, notes, events

Ready to start building?

Compile the game, create your first mod, or dive into the codebase to contribute

Quickstart guide Contributing guide

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.