A foundational Haxe framework for cross-platform development
Haxe C++ Java C# C HTML Other
Permalink
Failed to load latest commit information.
cs/ndll Initial HelloWorld support for C# (thank you @vroad) Aug 30, 2016
dependencies Allow setting a different Gradle plugin version. Feb 13, 2017
docs Cleaner GL bindings, consistent end points, progress toward GLES3 Mar 11, 2017
haxe Tag files for C++ release, even on debug builds, unless -Dlime-debug Dec 16, 2016
lime Fix HTML5 not able to exit full-screen via API Mar 29, 2017
ndll Cleanup Feb 13, 2015
project Fix missing CFFI warning Mar 29, 2017
templates Use default 'base' value in Flash HTML template (load paths relative … Mar 29, 2017
tests/runtime Update window close behavior May 14, 2016
tools Prefer project.xml over project.nmml Mar 3, 2017
.gitattributes Merge Aether tools Oct 1, 2014
.gitignore Switch to lime.exe instead of lime.bat (fixes exit from batch files) Feb 17, 2015
.gitmodules Switch to tinyfiledialogs, implement unicode on Windows Dec 28, 2016
.travis.yml Update CI script Mar 14, 2017
CHANGELOG.md Update CHANGELOG Mar 28, 2017
CONTRIBUTING.md Update README, add CONTRIBUTING and LICENSE Dec 31, 2013
LICENSE.md Update LICENSE.md Jan 10, 2017
NOTICE.md Update NOTICE.md Jan 10, 2017
README.md Update README Aug 29, 2016
extraParams.hxml Improve behavior from HXML builds Sep 28, 2016
haxelib.json Update to 4.0.3 Mar 28, 2017
haxelib.xml Add dummy haxelib.xml Oct 18, 2014
include.xml Initial Vorbis bindings, rename lime.audio to lime.media Jan 7, 2017
lime.png Add lime.png Aug 13, 2014
run.n Tools rebuild fix Nov 28, 2016
svg.n Update SVG tool Dec 20, 2016

README.md

MIT License Haxelib Version Build Status

Lime

Lime is a flexible, lightweight layer for Haxe cross-platform developers.

Lime supports native, Flash and HTML5 targets with unified support for:

  • Windowing
  • Input
  • Events
  • Audio
  • Render contexts
  • Network access
  • Assets

Lime does not include a renderer, but exposes the current context:

  • Cairo
  • Canvas
  • DOM
  • Flash
  • GL

The GL context is based upon the WebGL standard, implemented for both OpenGL and OpenGL ES as needed.

Lime provides a unified audio API, but also provides access to OpenAL for advanced audio on native targets.

License

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

Installation

First install the latest version of Haxe.

The current version of Lime has not been released on haxelib, yet, so please install the latest development build.

Development Builds

When there are changes, Lime is built nightly. Builds are available for download here.

To install a development build, use the "haxelib local" command:

haxelib local filename.zip

Building from Source

Clone the Lime repository, as well as the submodules:

git clone --recursive https://github.com/openfl/lime

Tell haxelib where your development copy of Lime is installed:

haxelib dev lime lime

The first time you run the "lime" command, it will attempt to build the Lime standard binary for your desktop platform as the command-line tools. To build these manually, use the following command (using "mac" or "linux" if appropriate):

haxelib install format
lime rebuild windows

You can build additional binaries, or rebuild binaries after making changes, using "lime rebuild":

lime rebuild windows
lime rebuild linux -64 -release -clean

You can also rebuild the tools if you make changes to them:

lime rebuild tools

On a Windows machine, you should have Microsoft Visual Studio C++ (Express is just fine) installed. You will need Xcode on a Mac. To build on a Linux machine, you may need the following packages (or similar):

sudo apt-get install libgl1-mesa-dev libglu1-mesa-dev g++ g++-multilib gcc-multilib libasound2-dev libx11-dev libxext-dev libxi-dev libxrandr-dev libxinerama-dev

To switch away from a source build, use:

haxelib dev lime

Sample

You can build a sample Lime project with the following commands:

lime create HelloWorld
cd HelloWorld
lime test neko

You can also list other projects that are available using "lime create".

Targets

Lime currently supports the following targets:

lime test windows
lime test mac
lime test linux
lime test neko
lime test android
lime test ios
lime test html5
lime test flash

Desktop builds are currently designed to be built on the same host OS