https://github.com/junkdog/ecs-matrix
Component Dependency Matrix for Artemis and Ashley ECS frameworks.
https://github.com/junkdog/ecs-matrix
Last synced: about 1 year ago
JSON representation
Component Dependency Matrix for Artemis and Ashley ECS frameworks.
- Host: GitHub
- URL: https://github.com/junkdog/ecs-matrix
- Owner: junkdog
- License: apache-2.0
- Created: 2014-09-21T05:50:10.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2021-04-26T17:38:58.000Z (about 5 years ago)
- Last Synced: 2025-06-28T18:57:20.805Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 64.5 KB
- Stars: 11
- Watchers: 5
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## ecs-matrix
A small command-line tool for generating a matrix describing references between [ECS][ecs] classes in your game.
Supports [artemis-odb][artemis] and [ashley][ashley]. Note that artemis-odb also provides this functionality
via maven, gradle and its cli tool.
[ecs]: http://en.wikipedia.org/wiki/Entity_component_system
[artemis]: https://github.com/junkdog/artemis-odb
[ashley]: https://github.com/libgdx/ashley
[](http://junkdog.github.io/matrix.html)
### Building
```
$ mvn clean package
```
### Downloading
- http://repo1.maven.org/maven2/net/onedaybeard/ecs/matrix-cli/0.2.0/matrix-cli-0.2.0.jar
### Usage
```
$ java -jar matrix-cli/target/matrix-cli-0.2.0.jar
Usage: matrix-cli-.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
```