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
Install dependencies
Download and install Haxe from Haxe.org and Git from git-scm.com. Make sure you have the required build tools for your platform. Clone the repository
Clone the repository and initialize submodules to download game assets:git clone https://github.com/FunkinCrew/funkin.git
cd funkin
git submodule update --init --recursive
Install Haxe libraries
Install hmm (Haxe Module Manager) and all required libraries:haxelib --global install hmm
haxelib --global run hmm setup
hmm install
haxelib run lime setup
Build and run
Compile and launch the game for your platform:lime test windows
# or: lime test mac, lime test linux, lime test html5
On first build, you may need to run lime rebuild <platform> and lime rebuild <platform> -debug to compile native dependencies.
Explore by topic
Jump into the documentation that matches your goals
Development
Compile the game from source, set up your development environment, and contribute code
Modding
Create custom songs, characters, stages, and gameplay with Polymod and HScript
Game systems
Understand the core gameplay mechanics, character system, and stage architecture
Tools
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’
Core systems
Conductor, PlayState, Assets, Preferences
Audio
FunkinSound, VoicesGroup, audio visualization
Gameplay
Characters, stages, notes, events
Ready to start building?
Compile the game, create your first mod, or dive into the codebase to contribute
