mirror of
https://github.com/FunkinCrew/Funkin.git
synced 2024-12-04 21:31:15 -05:00
2.9 KiB
2.9 KiB
Compiling Friday Night Funkin'
- Setup
- Download Haxe from Haxe.org
- Download Git from git-scm.com
- Do NOT download the repository using the Download ZIP button on GitHub or you may run into errors!
- Instead, open a command prompt and do the following steps...
- Run
cd the\directory\you\want\the\source\code\in
to specify which folder the command prompt is working in.- For example,
cd C:\Users\YOURNAME\Documents
would instruct the command prompt to perform the next steps in your Documents folder.
- For example,
- Run
git clone https://github.com/FunkinCrew/funkin.git
to clone the base repository. - Run
cd funkin
to enter the cloned repository's directory. - Run
git submodule update --init --recursive
to download the game's assets.- NOTE: By performing this operation, you are downloading Content which is proprietary and protected by national and international copyright and trademark laws. See the LICENSE.md file for the Funkin.assets repo for more information.
- Run
haxelib --global install hmm
and thenhaxelib --global run hmm setup
to install hmm.json - Run
hmm install
to install all haxelibs of the current branch - Run
haxelib run lime setup
to set up lime - 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 - GO THROUGH THESE STEPS BEFORE OPENING ISSUES ON GITHUB!
- 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
. - Make sure your game directory has an
assets
folder! If it's missing, copy the path to yourfunkin
folder and runcd the\path\you\copied
. Then follow the guide starting from Step 4. - Check that your
assets
folder is not empty! If it is, go back to Step 4 and follow the guide from there. - The compilation process often fails due to having the wrong versions of the required libraries. Many errors can be resolved by deleting the
.haxelib
folder and following the guide starting from Step 5.