Funkin/docs/COMPILING.md

# Compiling Friday Night Funkin'

0. Setup
    - Download Haxe from [Haxe.org](https://haxe.org)
    - Download Git from [git-scm.com](https://www.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...
1. Run `git clone https://github.com/FunkinCrew/funkin.git` to clone the base repository.
2. 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](https://github.com/FunkinCrew/funkin.assets/blob/main/LICENSE.md) repo for more information.
2. Run `haxelib --global install hmm` and then `haxelib --global run hmm setup` to install hmm.json
3. Run `hmm install` to install all haxelibs of the current branch
4. Run `haxelib run lime setup` to set up lime
5. Platform setup
   - For Windows, download the [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe)
        - 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](https://lime.openfl.org/docs/advanced-setup/macos/)
    - Linux: [`lime setup linux` Documentation](https://lime.openfl.org/docs/advanced-setup/linux/)
    - HTML5: Compiles without any extra setup
6. If you are targeting for native, you may need to run `lime rebuild PLATFORM` and `lime rebuild PLATFORM -debug`
7. `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`.
small compiling guide 2024-02-10 13:06:27 -05:00			`# Compiling Friday Night Funkin'`

			`0. Setup`
Made the Windows documentation more clear. 2024-02-11 11:01:33 -05:00			`- Download Haxe from [Haxe.org](https://haxe.org)`
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-06-15 00:52:52 -04:00			`- Download Git from [git-scm.com](https://www.git-scm.com)`
Add ZIP button warning and restructured sentences Each step should be easier to follow with this structure 2024-06-15 13:37:21 -04:00			`- 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...`
Make downloading the assets submodule a separate step. 2024-06-16 18:48:01 -04:00			1. Run `git clone https://github.com/FunkinCrew/funkin.git` to clone the base repository.
			2. 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](https://github.com/FunkinCrew/funkin.assets/blob/main/LICENSE.md) repo for more information.`
Add ZIP button warning and restructured sentences Each step should be easier to follow with this structure 2024-06-15 13:37:21 -04:00			2. Run `haxelib --global install hmm` and then `haxelib --global run hmm setup` to install hmm.json
			3. Run `hmm install` to install all haxelibs of the current branch
			4. Run `haxelib run lime setup` to set up lime
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-06-15 00:52:52 -04:00			`5. Platform setup`
Made the Windows documentation more clear. 2024-02-11 11:01:33 -05:00			`- For Windows, download the [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe)`
			`- 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`
small compiling guide 2024-02-10 13:06:27 -05:00			- Mac: [`lime setup mac` Documentation](https://lime.openfl.org/docs/advanced-setup/macos/)
			- Linux: [`lime setup linux` Documentation](https://lime.openfl.org/docs/advanced-setup/linux/)
			`- HTML5: Compiles without any extra setup`
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-06-15 00:52:52 -04:00			6. If you are targeting for native, you may need to run `lime rebuild PLATFORM` and `lime rebuild PLATFORM -debug`
			7. `lime test PLATFORM` ! Add `-debug` to enable several debug features such as time travel (`PgUp`/`PgDn` in Play State).
moved to Troubleshooting category 2024-05-09 22:07:03 -04:00
			`# 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`.
Merge branch 'develop' into rewrite/master 2024-06-09 15:30:14 -04:00