Fork Heaps on GitHub
Menu

Installation

In order to get up and running Heaps you'll need to make a decision about how you would like to run and debug your project.

Installing Haxe and Heaps

1. Download and setup Haxe:

    Haxe 3.4.2+

If you plan on testing with HashLink, however, you will need to download the Latest Haxe 4 Preview from the website.

2. Download and setup Heaps by running:

haxelib install heaps

Installing Visual Studio Code + Haxe support

The recommended editor for creating Heaps applications is Visual Studio Code:

1. Download and setup VSCode:

    Visual Studio Code

2. Install Haxe Extension Pack:

Click on the 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.

Restart VSCode once installation is complete (you can click the Reload label that should be showing)

Additional steps for Heaps and HashLink VM

In addition to use Heaps.io with HashLink (also known as HL), you need to install:

  • HashLink Virtual Machine
  • On OSX, you will have to follow the instructions laid out here to get set up with Hashlink, as the process is a little different.
  • Instead of Haxe 3.4 you need latest Haxe 4 preview
  • Some additional libraries should be installed with haxelib install <lib> command
  • Install Haxelib hldx for DirectX support
  • Install Haxelib hlopenal for OpenAL support
  • Install Haxelib hlsdl for SDL/GL support

Once you've downloaded the HashLink binary you'll want to add it to your system PATH (tutorial)

Once everything is setup, you should be able to run hl command from your terminal:

image