Skip to content
/ core Public
forked from ReactUnity/core

Create UI in Unity using React or HTML

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE.meta
Notifications You must be signed in to change notification settings

aaptho/core

 
 

Repository files navigation

React Unity

openupm GitHub Workflow Status Codecov Discord

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

About

Create UI in Unity using React or HTML

Resources

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE.meta

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 77.8%
  • C# 21.1%
  • TypeScript 0.6%
  • ShaderLab 0.2%
  • GLSL 0.1%
  • HLSL 0.1%
  • Other 0.1%