Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/FunkinCrew/Funkin/llms.txt

Use this file to discover all available pages before exploring further.

This guide covers solutions to common issues encountered when compiling Friday Night Funkin’. Always check here before opening an issue on GitHub.
DO NOT open an issue on GitHub for compilation problems without first consulting this guide.

​
General Issues

Symptom: Output containing WARNING or (WDeprecated)Solution: These will not disrupt compilation and can be safely ignored.
Symptom: This version of hxcpp … Would you like to do this now [y/n]Solution: Type y into the console and press Enter.
Symptom: Macro error with a very long stack traceSolution: Restart Visual Studio Code.
This is caused by Polymod somewhere, and seems to only occur when there’s another compile error in the program. There is a bounty up for fixing this.
Symptom: Build fails with Get Thread Context FailedSolution: Turn off other expensive applications while building.
Symptom: Error thrown by json2object: Type not found: T1Solution: Make sure the data type of @:default is correct.
flixel.util.typeLimit.OneOfTwo isn’t supported by json2object.
Symptom: Class lists not properly generated. Try cleaning out your export folder, restarting your IDE, and rebuilding your project.Solution: This is a bug specific to HTML5. Follow the steps listed:
  1. Delete the export folder
  2. Restart your IDE
  3. Rebuild the project
Symptom: LINK : fatal error LNK1201: error writing to program database ''; check for insufficient disk space, invalid path, or insufficient privilegeSolution: The PDB file in your export folder is in use or exceeds 4 GB. Delete the export folder and build again.

​
Git and Repository Issues

Symptom: error: RPC failed; curl 92 HTTP/2 stream 0 was not closed cleanly: PROTOCOL_ERROR (err 1)Solution: This error happens due to poor network connectivity. Run this in your terminal:
git config --global http.postBuffer 4096M
Then try cloning again.
Symptom: Repository is missing an assets folder, or assets folder is emptySolution: You did not clone the repository correctly! The assets are in a Git submodule.Navigate to your funkin folder:
cd path/to/funkin
Then run:
git submodule update --init --recursive
Symptom: Various compilation issues caused by library conflictsSolution: Delete the .haxelib folder and reinstall libraries:
# Remove the .haxelib folder
rm -rf .haxelib

# Reinstall hmm
haxelib --global install hmm
haxelib --global run hmm setup

# Reinstall all libraries
hmm install

# Set up Lime
haxelib run lime setup

​
Lime-Specific Issues

Symptom: Segmentation fault or crash after Done mapping time changes: [SongTimeChange(0ms,102bpm)]Solution: Caused by using official Lime instead of Funkin’s fork. Reinstall Lime via hmm:
hmm reinstall -f lime
Make sure you reinstall via hmm to guarantee you get Funkin’s version of Lime.
Symptom: Uncaught exception - Could not find lime.ndll. … Advanced users may run "lime rebuild cpp" instead.Solution varies by platform:

​
Linux

The binaries’ GLibC version might be more recent than your system supports. Run:
cd .haxelib/lime/git
git submodule init
git submodule sync
git submodule update
cd ../../..

# Install development packages (Ubuntu/Debian)
sudo apt install libgl1-mesa-dev libglu1-mesa-dev g++ g++-multilib \
  gcc-multilib libasound2-dev libx11-dev libxext-dev libxi-dev \
  libxrandr-dev libxinerama-dev libpulse-dev

# Rebuild Lime
lime rebuild cpp -64 -release -clean
The package names and install command may differ on non-Debian distros.

​
All Platforms

If binaries are missing, download pre-built binaries from Funkin’s Lime.Copy them to .haxelib/lime/git/ndll/<PLATFORM>64/, where <PLATFORM> is:
  • Windows
  • Linux
  • Mac

​
Platform-Specific Issues

​
Windows

Symptom: Compiler can’t find MSVC toolsSolution: Download and install Visual Studio Build Tools.Select Individual Components and install:
  • MSVC v143 VS 2022 C++ x64/x86 build tools
  • Windows 10/11 SDK

​
Linux

Symptom: Compilation fails due to missing VLC librariesSolution: Install libVLC development packages:Ubuntu/Debian:
sudo apt install libvlc-dev libvlccore-dev libvlccore9
Other distros: See hxvlc documentation

​
Mac

Symptom: Compiler can’t find development toolsSolution: Install Xcode Command Line Tools:
xcode-select --install

​
Mobile (Android/iOS)

See the Mobile Compilation Guide for platform-specific troubleshooting.

​
Runtime Issues

Possible causes:
  • Missing or corrupted assets
  • Incorrect build flags
  • Platform incompatibility
Solutions:
  1. Verify assets were downloaded correctly (check git submodule)
  2. Try a clean build: Delete export folder and rebuild
  3. Check you’re using the correct platform flags
Symptom: Missing textures, sounds, or other assets during gameplaySolution:If using -DREDIRECT_ASSETS_FOLDER:
  • This flag makes the game load assets from assets/ instead of export/
  • Make sure assets exist in the source assets/ folder
Otherwise:
  • Assets should be in export/[debug|release]/[platform]/bin/assets/
  • Check that the build completed successfully
  • Try a clean build
Symptom: Game runs slowly or stuttersSolutions:
  1. Build in release mode (without -debug flag)
  2. Disable logging: -DNO_FEATURE_LOG_TRACE
  3. Enable optimizations (automatic in release mode)
  4. Close other applications
  5. Update graphics drivers

​
Still Having Issues?

1

Search existing issues

Check if someone else has reported the same problem:Search GitHub Issues →
2

Check discussions

Look for similar questions in Discussions:Browse Discussions →
3

Open a new issue

If you’ve tried everything and still can’t compile, open a Compiling Help issue:Open Issue →Make sure to include:
  • Your operating system and version
  • The complete error message
  • The command you ran
  • What you’ve already tried

​
Quick Reference

​
Clean Build

When in doubt, try a clean build: 
# Delete export folder
rm -rf export

# Rebuild Lime
lime rebuild <platform>
lime rebuild <platform> -debug

# Build again
lime test <platform>

​
Reinstall Libraries

If libraries are causing issues: 
# Remove local libraries
rm -rf .haxelib

# Reinstall everything
haxelib --global install hmm
haxelib --global run hmm setup
hmm install
haxelib run lime setup

​
Next Steps

Compilation Guide

Return to the main compilation guide

Contributing

Learn how to contribute code

Style Guide

Follow code conventions

GitHub Issues

Search or report issues

Build docs developers (and LLMs) love

Get started for freeTalk to us