vugluskr86 / ezgui

EZGUI - The missing GUI for Pixi.js and Phaser.io

EZGUI

EZGUI is a GUI system for PIXI and Phaser. It's focused on PIXI 3 but supports PIXI 2 to guarantee seamless transition, and to remain compatible with Phaser 2.x

Note for Phaser 2.4.x users

If you use Phaser 2.4.x, please include phaser-compat-2.4.js file after phaser.js script (see examples/Phaser/phaser-2.4.html)

If you load custom resources to be used in your GUI templates and you are loading them with phaser default loader, you'll need to add an event listener for onLoadComplete and pass EZGUI.Compatibility.fixCache (see examples/game/phaser-2.4.html line ~193)

Phaser 2.4.4 known issues

WebGL renderer seem to have a strange behaviour, investigation is made to identify/isolate the bug since it don't seems to be an EZGUI issue.

Important

The code in this repository is still in development, and some breaking changes may occur.

Online components demos

• simple window

• window with children

• window with header

• window layout

• window layout relative positionning

• simple button

• button with skin

• checkbox

• radio

• slider

• Tabs

• Fonts

• Phaser complex

• Pixi complex

• Phaser Game screens

• Phaser 2.4 Game screens

• Pixi Game screens

• Phaser App screens

• Pixi App screens

Online Kits demos

• Game Main screen Kit (Pixi)
• Game Main screen Kit (Phaser)

Documentation

A work in progress documentation is available in the wiki section

There are also a lot of commented examples to get started

Features

• Flexible configuration : EZGUI use a flexible JSON configuration format for theme and gui definitions
• Themes : a default theme is provided but you can create your own custom theme.
• Tweening
• Bitmap fonts
• Extendable : you can easily create your own components
• relative width/height and positionning using percentage values

Implemented Components

• Window
• Layout
• Button
• Label
• Checkbox
• Radio
• Slider
• List
• Input
• Tabs

TODO

• Enhance Phaser 2.4 compatibility
• Two states button component
• Scrollbar component
• texts/texts alignements
• Documentation for theme definition
• Documentation for gui definition
• GUI Designer :)

License

The MIT License (MIT)
Copyright (c) 2015 Ezelia
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.