Getting Started

Install Haxe

If you have not already, install Haxe for your current platform. Lime supports Windows, macOS and Linux host platforms.

Install Lime

Next, open a command-prompt (Windows) or terminal (macOS/Linux) and run the following commands:

haxelib install lime
haxelib run lime setup

To confirm that Lime is installed and working properly, try running the “lime” command:


Install a Code Editor

We recommend Visual Studio Code, using the Lime Extension, but many other code editors are also compatible with Haxe development.

Run a Sample

Lime includes some simple sample projects to help you get started. For example, the “SimpleImage” sample illustrates an example of rendering graphics for multiple platforms and renderers:

lime create SimpleImage
cd SimpleImage
lime test html5
lime test html5 -Dcanvas
lime test html5 -Ddom
lime test neko
lime test neko -Dcairo
lime test flash

Lime will use a OpenGL-based renderer by default, but attempts to fallback to a software renderer (such as HTML5 canvas or Cairo) when it is unavailable.

Use Additional Platforms

Lime and OpenFL support many target platforms and operating systems, including native C++ apps on Windows, macOS, Linux, Android, and iOS, HTML5 on the web or as an app with Electron, the HashLink virtual machine, Adobe AIR, and more.

Some target platforms require extra setup before they will work properly with Lime. After you confirm that things are running properly, you can try configuring a new platform:

lime setup windows
lime setup linux
lime setup mac
lime setup android
lime setup ios

Follow the pages under the “Advanced Setup” section for more detailed information to setup each platform.

Improve this page