Repository files navigation

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.

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 20
• Unity 2021.3
• TMPro v3

Install via OpenUPM (recommended)

npx openupm-cli add com.reactunity.core com.reactunity.quickjs

Or add using the package manager with the git URL

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

• Create a canvas and addReactRendererUGUI component to it
• Runnpx @reactunity/create@latest in your Unity project root to create a React project
• Install all dependenciesnpm intall from React project
• Runnpm run start from React project
• Click play in Unity

Visit the documentation on themain website to learn more.

• 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 theDiscord server.

• Sample Project
• React Unity Renderer (npm package)
• Acknowledgements