Merge branch 'rewrite/master' into rewrite/weekend-1-gameplay-shaderdev

README.md

@@ -13,7 +13,7 @@ This game was made with love to Newgrounds and it's community. Extra love to Tom
 
 **PLEASE USE THE LINKS ABOVE IF YOU JUST WANT TO PLAY THE GAME**
 
-To learn how to install the necessary dependencies and compile the game from source, please check out our [building the game]() guide.
+To learn how to install the necessary dependencies and compile the game from source, please check out our [building the game](/docs/compiling.md) guide.
 
 # Contributing
 

docs/COMPILING.md

@@ -0,0 +1,19 @@
+# Compiling Friday Night Funkin'
+
+0. Setup
+    - Download Haxe from [Haxe.org](https://haxe.org)
+1. 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-secret.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.
+2. Install `hmm` (run `haxelib --global install hmm` and then `haxelib --global run hmm setup`)
+3. Install all haxelibs of the current branch by running `hmm install`
+4. 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
+5. If you are targeting for native, you likely need to run `lime rebuild PLATFORM` and `lime rebuild PLATFORM -debug`
+6. `lime test PLATFORM` !