Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The "Open Flash Library" for fast 2D development
Haxe Other

README.md

MIT License Haxelib Version Build Status


Introduction

OpenFL (Open Flash Library) is a fast, open-source implementation of the industry-standard Flash API. Unlike the Adobe implementation, OpenFL uses hardware rendering, compiles to native C++ for target platforms and reaches many more platforms than Adobe AIR. OpenFL is also 100% compatible with Flash Player, so you can still target Flash in the browser, or even AIR if you want.

Also unlike Adobe Flash, OpenFL uses the Haxe programming language. Before Adobe abandoned the "ActionScript Next" project, they detailed the pitfalls of ActionScript, and how they felt the language needed to improve. If you have a history performing ActionScript 3 development, you can almost approach Haxe as if it were ActionScript 4. It is powerful, flexible, has many more features and the first version of Haxe (with AVM2 support) was even released before Flash CS3 (with ActionScript 3 support) -- Haxe (and before it, MTASC) has a long history of supporting Flash.

Platforms

We are in the process of moving to a portable codebase. Existing releases of OpenFL support:

  • Windows
  • Mac
  • Linux
  • iOS
  • Android
  • BlackBerry
  • Tizen
  • Firefox OS
  • HTML5
  • Flash

The new codebase supports the following:

  • Windows
  • Mac
  • Linux
  • HTML5
  • Flash

With other platforms being added again before the final release.

Libraries

OpenFL is compatible with many libraries, ported from ActionScript or written originally in Haxe, including:

OpenFL also powers other platforms, such as Stencyl 3.

In order to support SWF assets, you can use the OpenFL SWF library, but many developers use image assets or libraries for spritesheet/tilesheet assets instead, as they can perform faster on mobile.

Code Editors

Plugins have been written for many code editors, but the most popular editors used for Haxe and OpenFL development are:

Easy Deployment

OpenFL is powered by Lime, which includes powerful command-line tools to make cross-platform deployment sensible.

"openfl test " is usually all that is required to build, package, install and run your project on the platform of your choice, assuming you have the standard target SDK installed (such as Xcode or Visual Studio C++). Lime includes "setup" commands to even help the install of these standard tools.

3D Support

The Flash API is ideal for 2D development. If you would like to create original 3D content, you might enjoy using Lime. You can also mix OpenGL content in OpenFL using OpenGLView API.

The Away Foundation is also developing an OpenFL version of Away3D.

Native Extensions

When you target a native platform, the output is true native C++, enabling deep integration with platform features and third-party SDKs. There is a standard Haxe "CFFI" API for connecting Haxe classes directly to C++ libraries.

We have also developed a straight-forward Android library project API for adding Java-based extensions, too. Native extensions can also use the standard Lime project format, for flexible control over dependencies, adding additional assets or tuning the output of your project.

The result are native extensions that can be made to interchangeably drop into projects, without breaking one another. We have made no attempt to emulate the system for AIR native extensions, which are much more difficult to create and less flexible.

Core Components

OpenFL relies upon Lime, a foundation for easy, cross-platform development.

hxcpp is used automatically by the Lime tools to manage the C++ compilation process for each platform, and to provide the Haxe standard library for C++ support.

License

OpenFL is free, open-source software under the MIT license.

Installing OpenFL

Follow the directions at openfl.org.

Development Builds

Clone the OpenFL repository:

git clone https://github.com/openfl/openfl

Tell haxelib where your development copy of OpenFL is installed:

haxelib dev openfl openfl

To return to release builds:

haxelib dev openfl
Something went wrong with that request. Please try again.