Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Next-Gen Isomorphic Application Engine for Embedded, Console, Mobile, Server and Desktop
JavaScript HTML CSS Shell Other
branch: master

README.md

lycheeJS (v0.8.5)

NPM Version NPM Downloads Gratipay

lycheeJS is a Next-Gen Isomorphic Application Engine that offers a complete solution for prototyping and deployment of HTML5 or native OpenGL(ES) or libSDL2 based applications.

The development process is optimized for Blink-based browsers (Chromium, Google Chrome, Opera) and their developer tools.

Automatic Installation

There are prebuilt packages that ship all dependencies and runtimes lycheeJS needs in order to work and cross-compile properly.

Take a look at lycheejs.org for a list of those available packages.

Manual Installation

1. Download lycheeJS

Download lycheeJS via zip-file and extract its contents. Rename the lycheeJS-master folder that was inside the archive accordingly.

cd ~/Development; # Change to your development folder

wget https://github.com/LazerUnicorns/lycheeJS/archive/master.zip -O lycheeJS-master.zip;
unzip lycheeJS-master.zip;
mv lycheeJS-master lycheeJS;

2. Download lycheeJS runtimes

cd ~/Development; # Change to your development folder

wget https://github.com/LazerUnicorns/lycheeJS-runtime/archive/master.zip;
unzip lycheeJS-runtime-master.zip;
mv lycheeJS-runtime-master ./lycheeJS/bin/runtime;

3. Start lycheeJS

If you installed lycheeJS via distributed package, you can use lycheeJS Ranger from the Applications Menu from your Operating System. This tool offers a GUI for maintenance and management of lycheeJS and your projects.

If you manually installed lycheeJS, you can start Sorbet via Terminal:

cd /path/to/lycheeJS;
./bin/sorbet.sh start development;

NPM / NodeJS Integration

You can modify the ~/lycheeJS/package.json/scripts section to use your own sorbet profile. Take a look at the examples localhost or lycheejs.org.

cd ~/Development/lycheeJS;
npm run-script localhost;

Documentation

The documentation is available online at http://lycheejs.org/documentation/index.html.

Roadmap

You want to see what kind of fancy features will arrive next? Take a look at the ROADMAP.md file.

Contribution

You want to contribute to the project? Take a look at the CONTRIBUTING.md file.

Other (unsupported) JavaScript Runtimes

The lycheeJS architecture is independent of the environment which means it will run in any theoretical JavaScript runtime.

The only requirement for such a platform is a fully implemented bootstrap API.

For fully supporting a client-side environment, you will also have to implement a lychee.Input, a lychee.Renderer, a lychee.Storage, and a lychee.Viewport.

These implementations are fully optional and only necessary if you are using them inside your Game or Application.

License

lycheeJS is (c) 2012-2015 LazerUnicorns and released under MIT license. The projects and demos are licensed under CC0 (public domain) license. The runtimes are owned and copyrighted by their respective owners.

Something went wrong with that request. Please try again.