https://github.com/junkdog/dominatrix-odb
Library for working with libGDX + Artemis Entity System Framework, primarily dealing with runtime introspection and live editing.
https://github.com/junkdog/dominatrix-odb
Last synced: 12 months ago
JSON representation
Library for working with libGDX + Artemis Entity System Framework, primarily dealing with runtime introspection and live editing.
- Host: GitHub
- URL: https://github.com/junkdog/dominatrix-odb
- Owner: junkdog
- License: apache-2.0
- Created: 2012-10-21T14:18:09.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2015-02-21T14:26:19.000Z (over 11 years ago)
- Last Synced: 2025-07-14T17:09:37.911Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 9.97 MB
- Stars: 9
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Take Note
*This small library was initially conceived during the early ECS days and hasn't really been keeping
up-to-date with developments in [artemis-odb](https://github.com/junkdog/artemis-odb). While some of the
functionality is useful, it's a little too diverse. The good bits could favorably be migrated to [artemis-odb-contrib](https://github.com/DaanVanYperen/artemis-odb-contrib)*
dominatrix-odb is a small, but diverse library for working with [libGDX](http://libgdx.badlogicgames.com/) +
[Artemis Entity System Framework](http://gamadu.com/artemis/), primarily dealing with runtime introspection and live editing.
## Features
- EntityFactoryManager for creating entities from json.
- Serialize entities to json.
- Type-safe annotation-driven injection from _.properties_ files.
- UI views for:
- reflexively editing entities
([screenshot 1](https://raw.github.com/wiki/junkdog/dominatrix-odb/images/rebelescape-editor-reflexive-03.png))
- toggling entity systems
([screenshot 2](https://raw.github.com/wiki/junkdog/dominatrix-odb/images/rebelescape-004-systems.jpg))
- adding components to entities
([screenshot 1](https://raw.github.com/wiki/junkdog/dominatrix-odb/images/rebelescape-editor-reflexive-03.png))
- inspecting entities (pretty-printed/json)
([screenshot 3](https://github.com/junkdog/dominatrix-odb/wiki/entity-inspection-psytripper))
## Assumptions/Limitations/State of Affairs
- Components are required to reside in a single package: imposed by component discovery and
json unserializing.
- Uses a slightly modified [fork](https://github.com/junkdog/artemis-odb) of artemis, allowing
for systems to be toggled at runtime.
- The demo uses [Project Lombok](http://projectlombok.org/) to reduce boilerplate nonsense. See their site
for Eclipse/Netbeans installation. (At a later stage, there may be a delomboked - vanilla java - version).
## Usage
Javadocs are a little scarce at the moment, see demo project for details.
### The EntityFactoryManager
In the screen or main class:
```java
entityFactoryManager = EntityFactoryManager.from(
Gdx.files.internal("data/archetypes.json"), JsonKey.class, true);
World world = new World();
world.setManager(entityFactoryManager);
// more artemis managers/systems
world.initialize();
```
In the render method, make sure to call `entityFactoryManager.addNewToWorld()`; this
has to be done outside of Artemis' processing loop.
To create an entity, simple call `entityFactoryManager.create("name-of-entity")`.
### Demo
Import _dominatrix-demo_ into eclipse as a Maven project, alternatively run `mvn package' inside the
demo folder, this creates an executable jar-with-dependencies under _dominatrix-demo/target_.
After starting, press **F1** to toggle keyboard shortcuts: the shortcuts demonstrate the bulk of
the functionality.
### Maven
**Nota Bene:** Maven repository on github isn't up to date; dominatrix has to be manually
installed (`mvn -Pgdx-odb install`) prior to being used.
```xml
dominatrix-odb
https://raw.github.com/junkdog/dominatrix-odb/mvn-repo/
true
net.onedaybeard
artemis-odb
0.3.2
net.onedaybeard
dominatrix-gdx-odb
0.2.0-SNAPSHOT
```