Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 27 lines (17 sloc) 2.375 kb
75cb0e3 @alecmce Adds a readme to the project
authored
1 h1. xEmber
2
3 p. xEmber is a child project inspired by Tom Davies' https://github.com/tdavies/Ember entity/component system framework.
3b7f9a2 @alecmce Update README.textile
authored
4
adce447 @alecmce Correct .textfile formatting for README
authored
5 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!
75cb0e3 @alecmce Adds a readme to the project
authored
6
7 h2. Structure
8
9 p. An entity is a collection of components
3b7f9a2 @alecmce Update README.textile
authored
10
8f3dfbd @alecmce Update README.textile
authored
11 * A component is a value-object
12 * 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.
13 * Systems act on nodes. Each system should have a clear responsibility like "update position", "collision detect" or "render".
adce447 @alecmce Correct .textfile formatting for README
authored
14 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).
8f3dfbd @alecmce Update README.textile
authored
15 * 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).
16 * 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.
2f256f8 @alecmce Add license to README
authored
17 * 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.
18
19 h2. License
20
6168c7d @alecmce Adds LICENSE.txt and appends copyright line to README.textile.
authored
21 Copyright 2011 Tom Davies, Alec McEachran
22
2f256f8 @alecmce Add license to README
authored
23 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:
24
25 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
26
27 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
Something went wrong with that request. Please try again.