Matter Hooks

Matter Hooks is a Luau hooks library for Matter.

It provides access to useful hooks not included in with Matter.

Installation

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

MatterHooks = "matter-ecs/matter-hooks@0.2.0"

Migration

If you're currently using the scope lasttalon/matter-hooks, this is the same package. You can migrate by changing your wally.toml file to use the scope matter-ecs/matter-hooks.

If you have migrated to ecs-matter/matter, you should also upgrade to matter-ecs/matter-hooks@0.2.0 or newer. This version of Matter Hooks is compatible with the matter-ecs/matter package scope as a peer dependency.

Building

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

You can then sync or build the project with Rojo. Matter Hooks contains several project files with different builds of the project. The default.project.json is the package build.

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.

License

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