/ecs-matrix

Component Dependency Matrix for Artemis and Ashley ECS frameworks.

Primary LanguageJavaApache License 2.0Apache-2.0

ecs-matrix

A small command-line tool for generating a matrix describing references between ECS classes in your game. Supports artemis-odb and ashley. Note that artemis-odb also provides this functionality via maven, gradle and its cli tool.

Shaman's Weirding Game: Component Dependency Matrix

Building

$ mvn clean package

Downloading

Usage

$ java -jar matrix-cli/target/matrix-cli-0.2.0.jar 
Usage: matrix-cli-<version>.jar [options]
  Options:
  * -c, --class-folder
       Root class folder
    -h, --help
       Displays this help message.
       Default: false
    -l, --label
       Project name, used as page title
       Default: Unnamed project
    -o, --output
       Save to file, destination may be given as a folder path
       Default: matrix.html

Example

$ cd ashley-superjumper/
$ java -jar /path/to/matrix-cli-0.2.0.jar \
> -c core/build/classes/main/ \
> -l "Ashley SuperJumper"
Found ECS framework: ashley
$ ls matrix.html 
matrix.html