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 `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.
2. Run `git clone https://github.com/FunkinCrew/funkin.git` to clone the base repository.
3. Run `cd funkin` to enter the cloned repository's directory.
4. 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.
5. Run `haxelib --global install hmm` and then `haxelib --global run hmm setup` to install hmm.json
6. Run `hmm install` to install all haxelibs of the current branch
7. Run `haxelib run lime setup` to set up lime
8. Perform additional 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
9. If you are targeting for native, you may need to run `lime rebuild <PLATFORM>` and `lime rebuild <PLATFORM> -debug`
10. `lime test <PLATFORM>` to build and launch the game for your platform (for example, `lime test windows`)

## Build Flags

There are several useful build flags you can add to a build to affect how it works. A full list can be found in `project.hxp`, but here's information on some of them:

- `-debug` to build the game in debug mode. This automatically enables several useful debug features.
    - This includes enabling in-game debug functions, disables compile-time optimizations, enabling asset redirection (see below), and enabling the VSCode debug server (which can slow the game on some machines but allows for powerful debugging through breakpoints).
    - `-DGITHUB_BUILD` will enable in-game debug functions (such as the ability to time travel in a song by pressing `PgUp`/`PgDn`), without enabling the other stuff
- `-DFEATURE_POLYMOD_MODS` or `-DNO_FEATURE_POLYMOD_MODS` to forcibly enable or disable modding support.
- `-DREDIRECT_ASSETS_FOLDER` or `-DNO_REDIRECT_ASSETS_FOLDER` to forcibly enable or disable asset redirection.
    - This feature causes the game to load exported assets from the project's assets folder rather than the exported one. Great for fast iteration, but the game
- `-DFEATURE_DISCORD_RPC` or `-DNO_FEATURE_DISCORD_RPC` to forcibly enable or disable support for Discord Rich Presence.
- `-DFEATURE_VIDEO_PLAYBACK` or `-DNO_FEATURE_VIDEO_PLAYBACK` to forcibly enable or disable video cutscene support.
- `-DFEATURE_CHART_EDITOR` or `-DNO_FEATURE_CHART_EDITOR` to forcibly enable or disable the chart editor in the Debug menu.
- `-DFEATURE_STAGE_EDITOR` to forcibly enable the experimental stage editor.
- `-DFEATURE_GHOST_TAPPING` to forcibly enable an experimental gameplay change to the anti-mash system.

# 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 run ` git config --global http.postBuffer 4096M`.
- Make sure your game directory has an `assets` folder! If it's missing, copy the path to your `funkin` folder and run `cd 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**.
small compiling guide 2024-02-10 18:06:27 +00:00			`# Compiling Friday Night Funkin'`

			`0. Setup`
Made the Windows documentation more clear. 2024-02-11 16:01:33 +00: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 04:52:52 +00: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 17:37:21 +00: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...`
Wrong slashes lol 2024-07-09 19:55:04 +00:00			1. Run `cd the\directory\you\want\the\source\code\in` to specify which folder the command prompt is working in.
Add cd step for improved clarity 2024-07-09 19:54:29 +00:00			- For example, `cd C:\Users\YOURNAME\Documents` would instruct the command prompt to perform the next steps in your Documents folder.
			2. Run `git clone https://github.com/FunkinCrew/funkin.git` to clone the base repository.
Add second cd step after cloning 2024-07-09 23:22:43 +00:00			3. Run `cd funkin` to enter the cloned repository's directory.
			4. Run `git submodule update --init --recursive` to download the game's assets.
Make downloading the assets submodule a separate step. 2024-06-16 22:48:01 +00:00			`- 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 second cd step after cloning 2024-07-09 23:22:43 +00:00			5. Run `haxelib --global install hmm` and then `haxelib --global run hmm setup` to install hmm.json
			6. Run `hmm install` to install all haxelibs of the current branch
			7. Run `haxelib run lime setup` to set up lime
Update compilation guide 2024-09-11 10:52:46 +00:00			`8. Perform additional platform setup`
Made the Windows documentation more clear. 2024-02-11 16:01:33 +00: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 18:06:27 +00: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`
Update compilation guide 2024-09-11 10:52:46 +00:00			9. If you are targeting for native, you may need to run `lime rebuild <PLATFORM>` and `lime rebuild <PLATFORM> -debug`
			10. `lime test <PLATFORM>` to build and launch the game for your platform (for example, `lime test windows`)

			`## Build Flags`

			There are several useful build flags you can add to a build to affect how it works. A full list can be found in `project.hxp`, but here's information on some of them:

			- `-debug` to build the game in debug mode. This automatically enables several useful debug features.
			`- This includes enabling in-game debug functions, disables compile-time optimizations, enabling asset redirection (see below), and enabling the VSCode debug server (which can slow the game on some machines but allows for powerful debugging through breakpoints).`
			- `-DGITHUB_BUILD` will enable in-game debug functions (such as the ability to time travel in a song by pressing `PgUp`/`PgDn`), without enabling the other stuff
			- `-DFEATURE_POLYMOD_MODS` or `-DNO_FEATURE_POLYMOD_MODS` to forcibly enable or disable modding support.
			- `-DREDIRECT_ASSETS_FOLDER` or `-DNO_REDIRECT_ASSETS_FOLDER` to forcibly enable or disable asset redirection.
			`- This feature causes the game to load exported assets from the project's assets folder rather than the exported one. Great for fast iteration, but the game`
			- `-DFEATURE_DISCORD_RPC` or `-DNO_FEATURE_DISCORD_RPC` to forcibly enable or disable support for Discord Rich Presence.
			- `-DFEATURE_VIDEO_PLAYBACK` or `-DNO_FEATURE_VIDEO_PLAYBACK` to forcibly enable or disable video cutscene support.
			- `-DFEATURE_CHART_EDITOR` or `-DNO_FEATURE_CHART_EDITOR` to forcibly enable or disable the chart editor in the Debug menu.
			- `-DFEATURE_STAGE_EDITOR` to forcibly enable the experimental stage editor.
			- `-DFEATURE_GHOST_TAPPING` to forcibly enable an experimental gameplay change to the anti-mash system.
moved to Troubleshooting category 2024-05-10 02:07:03 +00:00
Add cd step for improved clarity 2024-07-09 19:54:29 +00:00			`# Troubleshooting - GO THROUGH THESE STEPS BEFORE OPENING ISSUES ON GITHUB!`
moved to Troubleshooting category 2024-05-10 02:07:03 +00:00
			- 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 remote-tracking branch 'public/develop' into rewrite/master 2024-07-12 00:58:42 +00:00			- Make sure your game directory has an `assets` folder! If it's missing, copy the path to your `funkin` folder and run `cd the\path\you\copied`. Then follow the guide starting from Step 4.
Add second cd step after cloning 2024-07-09 23:22:43 +00:00			- 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.