mirror of
https://github.com/FunkinCrew/Funkin.git
synced 2024-12-12 17:21:09 -05:00
1.7 KiB
1.7 KiB
Compiling Friday Night Funkin'
- Setup
- Download Haxe from Haxe.org
- Cloning the Repository: Make sure when you clone, you clone the submodules to get the assets repo:
git clone --recurse-submodules https://github.com/FunkinCrew/funkin.git
- If you accidentally cloned without the
assets
submodule (aka didn't follow the step above), you can rungit submodule update --init --recursive
to get the assets in a foolproof way.
- Install
hmm
(runhaxelib --global install hmm
and thenhaxelib --global run hmm setup
) - Install all haxelibs of the current branch by running
hmm install
- Setup lime:
haxelib run lime setup
- Platform setup
- For Windows, download the Visual Studio Build Tools
- When prompted, select "Individual Components" and make sure to download the following:
- MSVC v143 VS 2022 C++ x64/x86 build tools
- Windows 10/11 SDK
- Mac:
lime setup mac
Documentation - Linux:
lime setup linux
Documentation - HTML5: Compiles without any extra setup
- For Windows, download the Visual Studio Build Tools
- If you are targeting for native, you may need to run
lime rebuild PLATFORM
andlime rebuild PLATFORM -debug
lime test PLATFORM
! Add-debug
to enable several debug features such as time travel (PgUp
/PgDn
in Play State).
Troubleshooting
- During the cloning process, you may experience an error along the lines of
error: RPC failed; curl 92 HTTP/2 stream 0 was not closed cleanly: PROTOCOL_ERROR (err 1)
due to poor connectivity. A common fix is to rungit config --global http.postBuffer 4096M
.