Build.md

Building the game

Warning

A lot of the versions that were used for this engine are no longer the latest, you will have to do some expeditions to find the correct numbers. Sorry.

Step 1. Install git-scm if you don't have it already.

Step 2. Install Haxe

Step 3. Install HaxeFlixel

Step 4. Run these commands to install the libraries required:

haxelib install flixel
haxelib git flixel-addons https://github.com/HaxeFlixel/flixel-addons
haxelib install flixel-ui
haxelib install hscript
haxelib git hscript-improved https://github.com/YoshiCrafter29/hscript-improved
haxelib install polymod
haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc
haxelib git openfl https://github.com/openfl/openfl
haxelib git hxCodec https://github.com/polybiusproxy/hxCodec
haxelib git linc_luajit https://github.com/Leather128/linc_luajit.git
haxelib git flixelTextureAtlas https://github.com/Smokey555/Flixel-TextureAtlas.git

IMPORTANT: use the latest stable polymod not git please

Dependencies for compiling:

Windows

Install Visual Studio Community 2019, and while installing instead of selecting the normal options, only select these components in the 'individual components' instead (or the closest equivalents).

* MSVC v142 - VS 2019 C++ x64/x86 build tools
* Windows 10 SDK (Latest)

Linux (if you decide to try and use hxCodec while compiling which requires changes at the moment)

In your package manager, install the following packages:

sudo apt-get install libvlc-dev
sudo apt-get install libvlccore-dev
sudo apt-get install vlc-bin
sudo apt-get install luajit
``` (APT Example)

```sh
sudo pacman -S vlc
sudo pacman -S luajit
``` (Pacman Example)

Step 5. Run `lime test [platform]` in the project directory while replacing '[platform]' with your build target (usually `html5`, `windows`, `linux`, `mac`, or whatever platform you are building for).