Installation

In order to get up and running Heaps you’ll need to install Haxe (the language), Visual Studio Code (the editor) and Heaps itself (the engine).

Installing Haxe

Heaps works on Haxe 3.4.2+, though it is recommanded to install Haxe 4+ to enjoy new language features and support the HashLink compiler target. Download Haxe 4+

Installing Heaps using haxelib

** In your command line interface of choice, run:

  1. haxelib install heaps

Note that in some cases you might need to log out and log back into your computer for haxlib to be recognized as a command. You can also install directly from github to get the latest, bleeding-edge version of Heaps.

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

Installing Visual Studio Code

The recommended editor for creating Heaps applications is Visual Studio Code: Visual Studio Code Reload label that should be showing, or hit Ctrl+Shift+P and type “Reload Window”, then hit Enter)

Installing Haxe extensions on vscode

This step will setup Haxe language support for vscode, the easier generation of comments and debuggers for some compilation targets. Extension panel (fourth icon on the left side bar of VSCode), search haxe and install Haxe Extension Pack that will contain everything you need for Haxe support.

Optional (Install the Hashlink VM)

HashLink, a Haxe virtual machine axed on high performance and quick compilation.

HashLink Virtual Machine On OSX, you will have to follow the instructions laid out (tutorial).

Update Haxe

Haxe 4+. To confirm your current version of Haxe, type

Install additional libraries

haxelib install in the command line, install the following items:

  • hlopenal for OpenAL support
  • hldx for DirectX support
  • hlsdl for SDL/GL support
    1. haxelib install hlopenalhaxelib install hlsdlhaxelib install hldx

    Verify the installation

    hl command from your terminal: