An open API service indexing awesome lists of open source software.

https://github.com/kefniark/jil

UI Framework for HTML5 Games
https://github.com/kefniark/jil

framework game game-development html5 ui

Last synced: 9 months ago
JSON representation

UI Framework for HTML5 Games

Awesome Lists containing this project

README

          

# JIL - HTML5 Game UI

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1aa993a6b3f1434d9d7be61a58e1adbe)](https://app.codacy.com/app/kefniark/jil?utm_source=github.com&utm_medium=referral&utm_content=kefniark/jil&utm_campaign=Badge_Grade_Dashboard)
[![Coverage Status](https://coveralls.io/repos/github/kefniark/jil/badge.svg?branch=master)](https://coveralls.io/github/kefniark/jil?branch=master)
[![Build Status](https://img.shields.io/travis/kefniark/jil/master.svg)](https://travis-ci.org/kefniark/jil)
[![NPM Version](https://img.shields.io/npm/v/jil.svg)](https://npmjs.org/package/jil)
[![NPM Downloads](https://img.shields.io/npm/dm/jil.svg)](https://npmjs.org/package/jil)
[![License](https://img.shields.io/npm/l/jil.svg)](https://npmjs.org/package/jil)

![Logo](./logo.png)

## **UI Framework for HTML5 Games**:
To build a **HTML5 Game UI**, there are usually two choices:
* Use the **GUI system** provided by your engine (each one is different with their limitations).
* Use **HTML/CSS** (but usual CSS framework like bootstrap are not designed for games)
Which in both case can be annoying and time consuming.

The idea behind **JIL** is to provide the best of both world, in a user friendly way.
* Auto-scaling and Centering
* Vector positioning (`pivot`, `anchor`, `position`, `scale`, `rotation`)
* Fast HTML5/CSS3 (Use CSS3 transform & Virtual dom)
* Tween integration (Provide an easy way to animate your UI)
* Layer & Layout system (Easier to organize UI than table or flexbox)
* Engine agnostic (Work with HTML canvas and dont interfer with 2D/3D Engine):
- Babylon.js
- Pixi
- Phaser
- ...

---

## Sample
* [**Demo**](https://kefniark.github.io/jil/dist/samples/)
* [**Sample Code**](./dist/samples/)

## How to use ?

* [**Install JIL**](./doc/install.md)
* [**Getting Started !**](./doc/getting_started.md)
* [**API Doc**](https://kefniark.github.io/jil/dist/docs/)
* [**Jil Development**](./doc/development.md)

---

## Copyright and license

Code and documentation copyright 2019 [Kefniark](https://github.com/kefniark)

Code released under the [MIT License](./LICENSE.md).

[![NPM](https://nodei.co/npm/jil.png)](https://nodei.co/npm/jil/)