Installation

Thank you for giving Firmament Engine a try!

This document will guide you through the installation process, which is pretty easy.

Installing Prerequisites

Firmament requires a working Haxe/OpenFL environment. You can install both Haxe for your platform, and the OpenFL tools and libraries easily using OpenFL's installer and following the directions here: http://www.openfl.org/documentation/setup/install-haxe/

That's it! You should have Haxe and OpenFL installed on your machine now.

Installing Firmament Via Haxelib

 

Be sure to install the prerequisites first (above)

 

By far, the easiest way to install Firmament is with Haxe's built-in package system, Haxelib.

Here's how:

  1. Open your command prompt. If you don't know how to do that, try this:
    1. If on windows vista or later, hit the windows button, type 'cmd' and hit enter.
    2. If on a mac, hit command+space, type 'terminal' and hit enter
  2. Run the following command in your terminal: 

    haxelib install firmament
  3. Haxelib will do its thing, download firmament and any dependencies, and then drop you back to the command prompt.

That's it! You should now have a full Firmament Game Engine installation.

Where to go from here

The next step should be creating your first project.