Getting Started

Install Haxe

If you have not already, install Haxe for your current platform. Lime projects can be built on Windows, macOS and Linux.

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:

lime

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 hardware-accelerated OpenGL renderer by default, but attempts to fall back to a software renderer (such as the HTML5 Canvas API or Cairo for native 2D Graphics) when OpenGL is unavailable on the current system. You can add the -Dcanvas flag to the html5 target or the -Dcairo flag to native targets to force software rendering.

Use Additional Platforms

Lime and OpenFL support many target platforms and operating systems, including:

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 Platform Setup section for more detailed information to setup each platform.


Improve this page