Skip to content
forked from ReactUnity/core

React renderer for building user interfaces in Unity UI

License

MIT, Unknown licenses found

Licenses found

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

mfandreich/core

 
 

Repository files navigation

React Unity

openupm GitHub Wiki Tests codecov

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.

Requirements

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

  • Node 12
  • Unity 2020.3

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#stable

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 in Unity

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

Known Issues

  • Not well tested yet

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.

Resources and References

About

React renderer for building user interfaces in Unity UI

Resources

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE.meta

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 51.5%
  • C# 46.0%
  • TypeScript 2.0%
  • Other 0.5%