lime

A foundational Haxe framework for cross-platform development
https://github.com/openfl/lime

To install, run:

haxelib install lime 8.3.1 

See using Haxelib in Haxelib documentation for more information.

README.md

MIT License Haxelib Version Build Status Community Discord Server

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.

Then, install Lime from Haxelib and run Lime's setup command.

haxelib install lime haxelib run lime setup 

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 lime-haxelib.zip 

Building from Source

  1. Clone the Lime repository, as well as the submodules:

    haxelib git lime https://github.com/openfl/lime 
  2. Install required dependencies:

    haxelib install format haxelib install hxp 
  3. Copy the ndll directory from the latest Haxelib release, or see project/README.md for details about building native binaries.

  4. After any changes to the tools or lime/tools directories, rebuild from source:

    lime rebuild tools 
  5. To switch away from a source build:

    haxelib set lime [version number] 

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 android lime test ios lime test html5 lime test flash lime test air lime test neko lime test hl 

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

Join the Community

Have a question? Want a new place to hang out?

Contributors
singmajesty
bowlerhat
Dimensionscape
Version
8.3.1
Published
4 weeks ago
License
MIT

All libraries are free

Every month, more than a thousand developers use Haxelib to find, share, and reuse code — and assemble it in powerful new ways. Enjoy Haxe; It is great!

Explore Haxe

Haxe Manual

Haxe Code Cookbook

Haxe API documentation

You can try Haxe in the browser! try.haxe.org

Join us on GitHub!

Haxe is being developed on GitHub. Feel free to contribute or report issues to our projects.

Haxe on GitHub