Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/alecmce/xember

A riff on the Ember entity system
https://github.com/alecmce/xember

Last synced: 3 months ago
JSON representation

A riff on the Ember entity system

Awesome Lists containing this project

README

        

h1. xEmber

p. xEmber is a child project inspired by Tom Davies' https://github.com/tdavies/Ember entity/component system framework.

xEmber is still in the early stages. It is possible to create games with the framework as it currently stands, but its core functionality is still being worked on and it doesn't yet have a fixed API. Use at your own risk!

h2. Structure

p. An entity is a collection of components

* A component is a value-object
* Nodes are defined as a set of components. When an entity satisfies that set of components, a Node is added to the linked list and when it stops satisfying the set, it is removed.
* Systems act on nodes. Each system should have a clear responsibility like "update position", "collision detect" or "render".
The structure can be integrated with RobotLegs, allowing MVC to be used where appropriate (HUD, game menus, leader-boards) and xEmber to be used for the core game(s).
* The io package will allow simple encoding and decoding of components into untyped objects that can be serialized to JSON, XML or AMF (or anything else). A modular structure allows complex data structures to be customly encoded and decoded (for example, encoding a Bitmap as its URL).
* The inspector package will allow object inspection, construction and descruction at runtime for game design and level building. A modular structure allows bespoke tooling for manipulating your components.
* Requires -keep-as3-metadata+="Ember" to be marked in the compiler. Metadata is used to mark data structures for encoding/decoding, and for configuring Nodes at runtime.

h2. License

Copyright (c) 2010 Tom Davies, Alec McEachran

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.