https://matter-ecs.github.io/react-matter

An interface between React and Matter
https://matter-ecs.github.io/react-matter

ecs hooks matter react roblox

Last synced: about 2 months ago
JSON representation

An interface between React and Matter

• Host: GitHub
• URL: https://matter-ecs.github.io/react-matter
• Owner: matter-ecs
• License: mit
• Created: 2024-06-10T16:58:04.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-10T16:58:48.000Z (8 months ago)
• Last Synced: 2024-06-10T20:51:46.790Z (8 months ago)
• Topics: ecs, hooks, matter, react, roblox
• Language: Luau
• Homepage: https://matter-ecs.github.io/react-matter/
• Size: 15.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-react-lua - **Documentation**
• awesome-react-lua - **Documentation**

README

        
# React-Matter [![CI status][ci-badge]][ci] [![Docs status][docs-badge]][docs]

**React-Matter** is an interface between _[React]_ and _[Matter]_.

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

[ci-badge]: https://github.com/matter-ecs/react-matter/actions/workflows/ci.yaml/badge.svg

[docs-badge]: https://github.com/matter-ecs/react-matter/actions/workflows/docs.yaml/badge.svg

[ci]: https://github.com/matter-ecs/react-matter/actions/workflows/ci.yaml

[docs]: https://matter-ecs.github.io/react-matter/

[react]: https://jsdotlua.github.io/react-lua/

[matter]: https://matter-ecs.github.io/matter/

## Installation

React-Matter can be installed with [Wally] by including it as a dependency in

your `wally.toml` file.

```toml

ReactMatter = "matter-ecs/[email protected]"

```

## Building

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

You can then sync or build the project with [Rojo]. React-Matter contains

several project files with different builds of the project. The

`default.project.json` is the package 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

## License

React-Matter is free software available under the MIT license. See the [license]

for details.

[license]: LICENSE.md