README.md

React Unity

React Unity is a way to build declarative UI in Unity3D using React. It can be used together with packages like Typescript, redux, i18next, react-router and more. It also supports a subset of CSS features and Flexbox layout system.

Requirements

Node is only used while developing and not required in runtime or after the project is built. Following are the minimum recommended versions. Use latest stable versions when possible.

• Node 12
• Unity 2019.4
• TMPro v2 or v3

Installing

Install via OpenUPM (recommended)

npx openupm-cli add com.reactunity.core

Or add using the package manager with the git URL

https://github.com/ReactUnity/core.git#latest

Usage

• Create a canvas and add ReactUnity component to it
• Run npx @reactunity/create in your Unity project root to create a React project
• Run npm start from React project
• Click play in Unity

The documentation on the main website is under development. You can also read detailed instructions in the outdated wiki.

Known Issues

• Low documentation coverage

Most of ReactUnity's features are not well documented yet. All questions, bug reports and requests are welcome. You can share them by opening issues or posting them in the Discord server.

Resources and References

• Sample Project and Demo
• React Unity Renderer (npm package)
• npx @reactunity/create
• Acknowledgements