mirror of https://github.com/FunkinCrew/Funkin.git synced 2024-11-22 23:57:50 -05:00

Hundrec 2916bd6ff7 Reorder download Git step in compiling guide

Moved “download Git” from the middle of the guide to the setup step
Should prevent errors with Git before installing Git

2024-07-01 15:41:07 -04:00

Compiling Friday Night Funkin'

Setup
- Download Haxe from Haxe.org
- Download Git from git-scm.com
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 run git submodule update --init --recursive to get the assets in a foolproof way.
Install hmm (run haxelib --global install hmm and then haxelib --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
If you are targeting for native, you may need to run lime rebuild PLATFORM and lime 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 run git config --global http.postBuffer 4096M.