Back Part 1 – Installing Haxe + Heaps 5 | ♥ 5

For this guide, I will presume that all Haxe related files will be installed in the c:\HaxeToolkit\ directory. Make sure to update the paths if you install your files somewhere else!

Haxe

Installing

Haxe is a cool programming language that can compile to multiple platforms. It’s free and open-source.

Install it (including Neko) to a folder like: c:\HaxeToolkit

Important: for the next sections of this tutorial, I’ll assume Haxe is installed in this folder.

After the setup, you should get 2 folders:

  • c:\HaxeToolkit\haxe: the compiler and all the standard libraries
  • c:\HaxeToolkit\neko: the Neko VM which is used internally.

Does it work?

  • Open a command line,
  • Type haxe, you should see something like that:

If you get a “file not found” error:

  1. reboot,
  2. check again,
  3. if it still doesn’t work, re-install.

Hashlink

Installing

Hashlink (HL) is Haxe virtual machine. We use it to build cross-platform titles.

Install it to the Haxe toolkit folder: c:\HaxeToolkit\hl

Important: you must add all the Hashlink (hl.exe) folder to your PATH environment variable (how?).

Does it work?

From a command line, type hl:

If it doesn’t work:

  1. reboot,
  2. check again,
  3. if you get an error, type where hl,
  4. if you get an unknown command error, check your PATH environment variable.

Installing Heaps

HeapsIO is a free open-source 2D/3D engine used in large game projects, like Dead Cells, Northgard or Evoland 2.

The engine is actually a library of Haxe (ie. an Haxelib) which can be installed easily using the bundled haxelib.exe tool.

From a command line, run the following command:

haxelib git heaps https://github.com/HeapsIO/heaps.git 

Important: we won’t use the default haxelib install heaps command here, because the official GIT version is much more up-to-date than the haxelib repo.

Installing other important Haxe libs

From a command line, for DirectX support in HashLink:

haxelib install hldx

For OpenGL/SDL support in HashLink:

haxelib install hlsdl

You can check the installed libs by typing:

haxelib list

Working with VSCode (recommended)

VScode is a nice IDE that features full Haxe integration if you install the dedicated extension. Out of the box, you’ll get code completion, easier project setup, debugging & much more.

Please note that you can do that from the extension panel. See below:

Use the built-in extension browser to get latest Haxe Extension Pack

Making a game

Now everything is ready, we can take care of the most interesting part: making an actual game using my GameBase.

Leave a Reply

Your email address will not be published.

  1. Mig:

    God frigging damn it, I'll go bang my head on the wall… Solved! Thank you Sébastien! My firstborn will be named after you!

    December 11, 2020 at 19:02
  2. Mig:

    Okay, but I've checked several sites and none say the variable name.
    I've added HLPATH to C:\HaxeToolkit\hashlink which is where my hl.exe is, rebooted several times but does not recognize… is HLPATH the name?

    December 11, 2020 at 16:33
    • Sébastien Bénard:

      Hi! You should simply add your "C:\HaxeToolkit\hashlink" path to the PATH environment variable (not HLPATH).

      December 11, 2020 at 18:07
  3. Danny:

    Thanks for this tutorial, would love to see more stuff on heaps from you in the future :)

    February 21, 2020 at 11:23
  4. kynan:

    This is awesome, Thanks.

    February 14, 2020 at 14:17