This project is an attempt to to use the excellent library react-unity-webgl (RUW) by Jeffrey Lanters. RUW provides a React component wrapper for embedding a Unity WebGL build in a React application, with two-way communication between the React and Unity applications.
For common usage of RUW, please refer to RUW's documentation wiki:
- Embedding a Unity WebGL build in a React application
- Communication from React to Unity
- Communication from Unity to React
- Unity WebGL build built in events
To enable two-way React-Unity communication, RUW of course uses methods provided by Unity.
One special note is that when sending messages from Unity to React, one should use the Pointer_stringify helper function to convert a Unity C# string (???) to a JavaScript string. This string conversion should be done in JavaScript functions defined in a JSLib file, for binding communication, to be placed in "Assets/Plugins/WebGL/MyPlugin.jslib" in the Unity project.
To see what other methods are exposed by the UnityContent class, we can refer to RUW's source code, in particular:
- public setFullscreen(fullscreen: boolean): void
- public remove(): void
This project uses the Unity WebGL builds from the following projects:
The above Unity WebGL builds are placed in the directory "public/unityBuilds" under the CRA directory structure. When specifying buildJsonPath and unityLoaderJsPath for initialising a UnityContent instance, better specify the paths using process.env.PUBLIC_URL to ensure that the paths point to CRA's public directory correctly.
Some reflections: I have tried exporting a Unity project to an Android Studio project before. Since I am not too familiar with Android / Gradle development, embedding a Unity project in an Android project was a bit of a pain, due to lots of trial-and-errors when facing build linkage errors. On the other hand, I find embedding a Unity WebGL build in a React application quite easy, thanks to RUW. The web is really a beautiful platform, and React and Unity WebGL can be a match made in heaven:)
This project was bootstrapped with Create React App (CRA). And the sections below are generated by CRA.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify