mirror of https://github.com/FunkinCrew/Funkin.git synced 2024-11-14 19:25:16 -05:00

Hundrec 9f17478a3a Add ZIP button warning and restructured sentences

Each step should be easier to follow with this structure

2024-07-10 18:08:54 -04:00

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 git clone --recurse-submodules https://github.com/FunkinCrew/funkin.git to clone the repository with the necessary assets submodule
- 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.
Run haxelib --global install hmm and then haxelib --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
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.