gasm 1.0.0

Renderer agnostic ECS framework

Released 2017-12-12.

To install, run:

haxelib install gasm 1.0.0

See using Haxelib in Haxelib documentation for more information.

Maintainerleo.bergman
Websitehttps://github.com/lbergman/gasm
Current version1.0.0
StatisticsInstalled 81 times
LicenseMIT
Tags

README.md

Build Status

GASM ECS

Framework agnostic ECS layer.

What is it?

After trying the excellent Flambe framework, I really became found of that flavor of Entity Component Systems, but since Flambe is not very actively developed any more and lacks a c++ target, I got the idea to create a entity component system which is not tied to a specific framework and renderer, so I can use ECS regardless of if I want to use OpenFL, NME, Kha or Heaps. Also I would like to be able to reuse components on the server side, in which case I also need components to be decoupled from framework and renderer as well.

The idea is not to add abstractions of everything in the different backends and frameworks used, but just add en ECS implementation to control rendering, input and sound. So the intention is not to be able to write a game that can be instantly ported between frameworks, but it should be possible to write components that can be reused between backends or can run on a server.

Targeting a new framework means writing a few classes to ensure that the Entity graph is tied to the rendering system and models for graphics and sound that can interface with the framework classes. To run components to perform logic on the server, the idea is to create noop systems for rendering and sound so just the models are updated.

Note that ECS purists will not consider this a proper ECS framework, since components contain the logics instead of systems. If you are writing a complex RPG or MMO, proper ECS might be worth looking in to, but for more typical small scale web or mobile projects I think having logic in components is prerable.

What does it mean?

The name comes from the separation added to different component types, Graphics, Actor, Sound, Model. GASM has model types for graphics (SpriteModelComponent, TextModelComponent) and sound (SoundModelComponent) which are used to interface with the framework used.

Regardless of in which order components are added, they will always be updated in the following order: Models -> Actors -> Graphics -> Sound

Current status

Currently there is a basic renderer and sound systems for OpenFL and Heaps, and some examples with graphics, text and sound.See GASM-openfl, GASM-heaps and GASM-examples. Some optimization is done to ensure performance seems acceptable, and at least with the shallow entity graph in the bunny mark test in examples, the overhead introduced by the framwork seems like it should be acceptable for most games. Compared to Flambe there will be additional overhead due to two things: - The model components added to interface between graphics objects in different frameworks means extra calls when updating an Entity. - Extra logic to ensure the different component types are updated in the correct order.

Future plans

Will start using the framework for a game and see how it works out, and will likely make breaking changes to GASM while doing that. I will implement scene/state management and some way of handling dependency injection, but haven't decided if they should be separate libs or included in GASM. Eventually when I feel it's stable and ready for a beta release, I will post it to haxelib.

Usage

Run:

haxelib git gasm https://github.com/lbergman/GASM/master

Then add the integration for the backend you want to use:

haxelib git gasm-openfl https://github.com/lbergman/GASM-openfl/master

or

haxelib git gasm-heaps https://github.com/lbergman/GASM-heaps/master

Finally you want to look the the examples: https://github.com/lbergman/GASM-examples

Or install them with haxelib to try them out:

haxelib git gasm-examples https://github.com/lbergman/GASM-examples/master

Compatibility

The goal is that the core ECS system should be possible to use for an integration on any target. So far only core entity component functionality is tested on Haxe 3.2.1 and 3.3.0 with the following targets: neko python node flash java cpp cs php