A2 Building Kade Engine - kadedevteam/Kade-Engine-Offical GitHub Wiki

Building Kade-Engine

Note: This is for building kade-engine BY SCRATCH, if you just want to play kade play it with a stable build or in your browser!

Another Note: you must be familer with the commandLine, IF not then check out this sick guide by ninjamuffin

Required Programs

  1. Install Haxe 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.
  3. instal git
    • Windows: install from the git-scm 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:

VS DEPENDECIES

If you are planning to build for Windows, you also need to install Visual Studio 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`
  • MSVC v141 - VS 2017 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)`

This will install about 7 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.

Bulding

Now we shall build!

  • Run lime build , replacing with the platform you want to build to (windows, mac, linux, html5) (i.e. lime build windows)
  • The build will be in Kade-Engine/export/release//bin, with being the target you built to in the previous step. (i.e. Kade-- - - - e-- engine/export/release/windows/bin)
  • Incase you added the -debug flag the files will be inside Kade-Engine/export/debug//bin
  • Only the bin folder is necessary to run the game. The other ones in export/release/ are not.

Kade-Engine Should open after all the code has been written (If not check out the troubleshooting page on this wiki)

⚠️ **GitHub.com Fallback** ⚠️