React Unity

React Unity is a way to build interactive 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 Flex layout system.

Please feel free to share all your questions, proposals and feedbacks by opening issues. This package is in its early stages and looking for constructive feedback.

Requirements

• Node.js version 14 or above is required on the development machine
• Tested in Unity 2020.2 and 2021.1

Installing

Install via OpenUPM

npx openupm-cli add com.reactunity.core

Or add manually by editing manifest.json

{
  "dependencies": {
    "com.reactunity.core": "https://github.com/ReactUnity/core.git",
    ...
  },
}

Usage

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

Read the detailed instructions in wiki. Also check the sample project.

Known Issues

• WebGL build is not stable. This issue may or may not be fixed in the future.
• npm start is not stable in MacOS. Working on a fix.
• Not well tested yet

Resources and References

• Full Unity Project Sample and Demo
• React Unity Renderer (npm package)
• npm init @reactunity
• React
• Yoga
• Jint