{"id":"matter-ecs/matter-hooks","name":"matter-hooks","scope":"matter-ecs","platform":"roblox","description":"A hooks library for Matter","version":"0.2.1","latest":"0.2.1","versions":["0.2.0","0.2.1"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{"matter-ecs/matter":{"version":"=0.8.5","alias":"Matter"}},"integrity":"f221139e689b0a9592e11bcdba8a0c2f6470c8084562c46c9895439855f5048d","likes":0,"downloads":0,"install":"forest install matter-ecs/matter-hooks","url":"https://forest.dev/p/roblox/matter-ecs/matter-hooks","files":"https://api.forest.dev/ai/package/roblox/matter-ecs/matter-hooks/files","readme":"# Matter Hooks [![CI status][ci-badge]][ci] [![Docs status][docs-badge]][docs]\n\n**Matter Hooks** is a _[Luau]_ hooks library for _[Matter]_.\n\nIt provides access to useful hooks not included in with Matter.\n\n[ci-badge]: https://github.com/matter-ecs/matter-hooks/actions/workflows/ci.yaml/badge.svg\n[docs-badge]: https://github.com/matter-ecs/matter-hooks/actions/workflows/docs.yaml/badge.svg\n[ci]: https://github.com/matter-ecs/matter-hooks/actions/workflows/ci.yaml\n[docs]: https://matter-ecs.github.io/matter-hooks/\n[luau]: https://luau-lang.org/\n[matter]: https://eryn.io/matter/\n\n## Installation\n\nMatter Hooks can be installed with [Wally] by including it as a dependency in\nyour `wally.toml` file.\n\n```toml\nMatterHooks = \"matter-ecs/matter-hooks@0.2.1\"\n```\n\n## Migration\n\nIf you're currently using the scope `lasttalon/matter-hooks`, this is the same\npackage. You can migrate by changing your `wally.toml` file to use the scope\n`matter-ecs/matter-hooks`.\n\nIf you have migrated to `ecs-matter/matter`, you should also upgrade to\n`matter-ecs/matter-hooks@0.2.0` or newer. This version of Matter Hooks is\ncompatible with the `matter-ecs/matter` package scope as a peer dependency.\n\n## Building\n\nBefore building, you'll need to install all dependencies using [Wally].\n\nYou can then sync or build the project with [Rojo]. Matter Hooks contains\nseveral project files with different builds of the project. The\n`default.project.json` is the package build.\n\n[rojo]: https://rojo.space/\n[wally]: https://wally.run/\n\n## Contributing\n\nContributions are welcome, please make a pull request! Check out our\n[contribution] guide for further information.\n\nPlease read our [code of conduct] when getting involved.\n\n[contribution]: CONTRIBUTING.md\n[code of conduct]: CODE_OF_CONDUCT.md\n\n## License\n\nMatter Hooks is free software available under the MIT license. See the [license]\nfor details.\n\n[license]: LICENSE.md\n","readmeTruncated":false}