From ae8dc93f6bf96ae7d469b37272513ce4c0d6c671 Mon Sep 17 00:00:00 2001
From: daniel11420 <15311104+daniel11420@users.noreply.github.com>
Date: Wed, 7 Apr 2021 20:50:12 +0200
Subject: [PATCH] Add files via upload

---
 BUILDING.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 BUILDING.md

diff --git a/BUILDING.md b/BUILDING.md
new file mode 100644
index 0000000..620debc
--- /dev/null
+++ b/BUILDING.md
@@ -0,0 +1,60 @@
+# Building Friday Night Funkin': Kade Engine
+
+**Please note**: these instructions are for compiling/building the game. If you just want to play Kade Engine, **play in your browser or download a build instead**: **[play in browser](https://funkin.puyo.xyz) ⋅ [latest stable release](https://github.com/KadeDev/Kade-Engine/releases/latest) ⋅ [latest development build (windows)](https://ci.appveyor.com/project/KadeDev/kade-engine-windows/build/artifacts) ⋅ [latest development build (linux)](https://ci.appveyor.com/project/KadeDev/kade-engine-linux/build/artifacts)**. If you want to build the game yourself, continue reading.
+
+**Also note**: you should be familiar with the commandline. If not, read this [quick guide by ninjamuffin](https://ninjamuffin99.newgrounds.com/news/post/1090480).
+
+**Also also note**: To build for *Windows*, you need to be on *Windows*. To build for *Linux*, you need to be on *Linux*. You can build for html5/browsers on any platform.
+
+## Dependencies
+ 1. [Install Haxe 4.1.5](https://haxe.org/download/version/4.1.5/). You should use 4.1.5 instead of the latest version because the latest version has some problems with Friday Night Funkin': Kade Engine.
+ 2. After installing Haxe, [Install HaxeFlixel](https://haxeflixel.com/documentation/install-haxeflixel/).
+ 3. Install `git`.
+	 - Windows: install from the [git-scm](https://git-scm.com/downloads) website.
+	 - Linux: install the `git` package: `sudo apt install git` (ubuntu), `sudo pacman -S git` (arch), etc... (you probably already have it)
+ 4. Install and set up the necessary libraries:
+	 - `haxelib install lime 7.9.0`
+	 - `haxelib install openfl`
+	 - `haxelib install flixel`
+	 - `haxelib run lime setup`
+	 - `haxelib run lime setup flixel`
+	 - `haxelib install flixel-tools`
+	 - `haxelib run flixel-tools setup`
+	 - `haxelib install flixel-addons`
+	 - `haxelib install flixel-ui`
+	 - `haxelib install hscript`
+	 - `haxelib install newgrounds`
+	 - `haxelib git faxe https://github.com/uhrobots/faxe`
+	 - `haxelib git polymod https://github.com/larsiusprime/polymod.git`
+	 - `haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc`
+### Windows-only dependencies (only for building *to* Windows. Building html5 on Windows does not require this)
+If you are planning to build for Windows, you also need to install **Visual Studio Code 2019**. While installing it, *don't click on any of the options to install workloads*. Instead, go to the **individual components** tab and choose the following:
+-   MSVC v142 - VS 2019 C++ x64/x86 build tools
+-   Windows SDK (10.0.17763.0)
+-   C++ Profiling tools
+-   C++ CMake tools for windows
+-   C++ ATL for v142 build tools (x86 & x64)
+-   C++ MFC for v142 build tools (x86 & x64)
+-   C++/CLI support for v142 build tools (14.21)
+-   C++ Modules for v142 build tools (x64/x86)
+-   Clang Compiler for Windows
+-   Windows 10 SDK (10.0.17134.0)
+-   Windows 10 SDK (10.0.16299.0)
+-   MSVC v141 - VS 2017 C++ x64/x86 build tools
+-   MSVC v140 - VS 2015 C++ build tools (v14.00)
+
+This will install about 22 GB of crap, but is necessary to build for Windows.
+
+## Cloning the repository
+Since you already installed `git` in a previous step, we'll use it to clone the repository.
+1. `cd` to where you want to store the source code (i.e. `C:\Users\username\Desktop` or `~/Desktop`)
+2. `git clone https://github.com/KadeDev/Kade-Engine.git`
+3. `cd` into the source code: `cd Kade-Engine`
+4. (optional) If you want to build a specific version of Kade Engine, you can use `git checkout` to switch to it (i.e. `git checkout 1.4-KE`) (remember that versions 1.4 and older cannot build to Linux or HTML5)
+	- You should **not** do this if you are planning to contribute, as you should always be developing on the latest version.
+## Building
+Finally, we are ready to build.
+
+- Run `lime build <target>`, replacing `<target>` with the platform you want to build to (`windows`, `linux`, `html5`) (i.e. `lime build windows`)
+- The build will be in `Kade-Engine/export/<target>/bin`, with `<target>` being the target you built to in the previous step. (i.e. `Kade-Engine/export/windows/bin`)
+	- Only the `bin` folder is necessary to run the game. The other ones in `export/<target>` are not.