Download OpenFL

How to Install OpenFL

OpenFL is a cross-platform library that supports multiple programming languages. To access all compilation targets supported by OpenFL, including native C++, choose Haxelib (Option 1) below. For projects targeting web browsers only, consider npm (Option 2) to use additional languages — including JavaScript or TypeScript.

Option 1: Haxelib

OpenFL is available on Haxelib and supports HTML5, native desktop, mobile, AIR, and Flash targets — all from a single toolset using the Haxe language.

To get started:

• Install Haxe globally
• Ensure Haxe and Neko are up to date
• Run these commands in your terminal:

haxelib install openfl
haxelib run openfl setup

To verify the installation:

openfl

Run a Sample

List available samples:

openfl create

Try building the DisplayingABitmap sample:

openfl create DisplayingABitmap
cd DisplayingABitmap
openfl test html5

Next Steps

Choose a code editor or build your first project.

Option 2: NPM

If you're building a web-only project, OpenFL is also available on npm. This method supports TypeScript, ES6/ES5 JavaScript, and Haxe — but not native desktop/mobile builds.

To get started:

• Install Node.js and npm
• Install Yeoman and the OpenFL generator:

npm install -g yo generator-openfl

Create and run a new project:

mkdir NewProject
cd NewProject
yo openfl

Run a Sample

Pick a sample project depending on your language:

• TypeScript
• Haxe
• ES6 JavaScript
• ES5 JavaScript
• ActionScript

Then install and run:

git clone https://github.com/openfl/openfl-samples-ts
cd openfl-samples-ts/features/display/DisplayingABitmap
npm install
npm start

Next Steps

We recommend Visual Studio Code for editing NPM-based OpenFL projects.

Need Help?

If you run into issues installing OpenFL, visit our friendly Community Forum or join us on Discord. We're here to help!