Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matter-ecs/matter

A modern ECS library for Roblox
https://github.com/matter-ecs/matter

ecs roblox

Last synced: 8 days ago
JSON representation

A modern ECS library for Roblox

Awesome Lists containing this project

README

        



Matter





CI status


Docs status


OSS Discord



**Matter** is a modern ECS library for _[Roblox]_.

[roblox]: https://www.roblox.com/

## Installation

Matter can be installed with [Wally] by including it as a dependency in your
`wally.toml` file.

```toml
Matter = "matter-ecs/[email protected]"
```

## Migration

If you're currently using the scope `evaera/matter`, prior versions are the same
package. You can migrate by changing your `wally.toml` file to use the scope
`matter-ecs/matter`.

## Building

Before building, you'll need to install all dependencies using [Wally].

You can then sync or build the project with [Rojo]. Matter contains several
project files with different builds of the project. The `default.project.json`
is the package build. The `example.project.json` is the example game build.

[rojo]: https://rojo.space/
[wally]: https://wally.run/

## Contributing

Contributions are welcome, please make a pull request! Check out our
[contribution] guide for further information.

Please read our [code of conduct] when getting involved.

[contribution]: CONTRIBUTING.md
[code of conduct]: CODE_OF_CONDUCT.md

## Project Legacy

Matter was originally pioneered by [@evaera](https://www.github.com/evaera). She
laid the robust foundation for the work we continue today.

## License

Matter is free software available under the MIT license. See the [license] for
details.

[license]: LICENSE.md