jil
v0.0.4
Published
UI Framework for HTML5 Games
Downloads
14
Maintainers
Readme
JIL - HTML5 Game UI
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
- Three.js
- ...
This is still a project in early development
I plan later, to make a small editor to design scene UI and export them in
*.json
Usage
This library is exported with UMD (Universal Module Definition)
:
CDN
You can use directly in your webpage https://cdn.jsdelivr.net/npm/jil@latest/dist/jil.min.js
and call jil.SceneManager.init()
NPM
Or install it through npm
/ yarn
npm install jil
and
import { SceneManager } from 'jil';
SceneManager.init();
Dev Usage
Install
npm install
- clone this repository and run this command
Dev
npm run dev
- this will start a dev server on http://localhost:8080
Build
npm run build
- this will update the
dist
folder- code
- documentation
- typescript definition file
jil.d.ts