Skip to content

Latest commit

 

History

History
100 lines (73 loc) · 3.2 KB

README.md

File metadata and controls

100 lines (73 loc) · 3.2 KB
Raw

Fae - 2D WebGL Renderer

Build Status Dependency Status
Sauce Test Status

PayPal

Fae is originally based on pixi.js but with a focus on WebGL and a few core design differences that result in a familiar but slightly different API.

Fae is meant to be a highly modular rendering framework. The primary target use-case for Fae is to be easily intregrable into larger application frameworks. However, the plugin library for Fae enables it to be useful to end users as well as a standalone framework.

Website: Coming Soon
Discord: https://discord.gg/qghcMmr
Docs/Guides: Coming Soon

Contents

Download

Coming Soon.

Getting Started

Coming Soon.

Support

Developing Fae takes a lot of time and effort. The multiple services and servers that run for the Fae project cost a non-trivial amount of money. If you want to help support the continued development of Fae, please consider making a donation.

There are a couple ways you can have an impact:

  • A monthly contribution via Patreon (Coming Soon).
  • A donation via PayPal: PayPal

All donations go right back into the Fae community in the form of server hosting, and development time.

Roadmap

Todo:

  • Custom Shaders
  • Filters
  • Masks
  • DevicePixelRatio
  • Move math shapes to plugin (Rectangle, BoundingBox, Polygon)
  • Move Color to a plugin
  • Compressed textures

Plugins to Make

  • Mesh
  • Animated sprites
  • Text/BitmapText
  • Tiled Editor/Tile maps
  • Loader
  • Particle System
  • Interactions
  • Spine, Dragon Bones, etc
  • Lights

Contributing

The Contributing Guide contains the full details on how to contribute changes to the project.

Main points:

  • Report bugs on GitHub Issues and include a code sample.
  • Pull Requests should be made against master.
  • Before contributing read the Code of Conduct.

Analytics