React Unity Scripts

This package includes scripts and configuration used by React Unity.

This project is a fork of Create React App (CRA). Same options, conventions, and environment variables can be used. You can also check the documentation of CRA to get more information.

Installation

npm i @reactunity/scripts

Commands

• react-unity-scripts start - Start the dev server with Hot Module Replacement (HMR)
• react-unity-scripts build - Create the production ready build
• react-unity-scripts start --test - Start the test server (entry file will be test.ts instead of index.ts)

Extra Environment Variables

Environment variables of CRA can be used with React Unity. However, there are some differences:

• FILENAME - Name of the generated javascript file. index.js by default.
• BUILD_PATH - Path to the generated output. Relative to the project. ../Assets/Resources/react by default.
• GENERATE_SOURCEMAP - false by default.
• FAST_REFRESH - This can be set to false to disable react-refresh if you are having problems with hot reload
• IMAGE_INLINE_SIZE_LIMIT - 0 by default. Because non-inlined images will be faster in Unity. However, if users still want to inline images, they should increase this limit.
• JSX_IMPORT_SOURCE - Can be used to allow some custom JSX transformations. For example, set this variable to @emotion/react for Emotion.
• ENABLE_SCOPE - Can be used to restricts imports to src folder only.

Environment variables can also be defined by having .env, .env.local, .env.<development|production> in project folder.

Custom environment variables are also possible as in CRA.

.babelrc can be used to modify some Babel options.

Multiple Entry Points

In addition to src/index file, there can be other entry points. Every file under src/entry/ folder will be detected and configured as an entry point. For example, if there is a file src/entry/menu.tsx, Webpack will detect that and create an entrypoint named menu with output menu.js in addition to the default entrypoint index.js.

WebGL Inspector

When dev server is started with the start script, a web server is launched at the selected port (e.g. http://localhost:3000). This server serves the javascript and asset files that are used by ReactUnity. If you visit this link in browser, you will see a page explaining how to setup the web previewer. The previewer can be used to quickly test the React code without even launching Unity. It also reacts to the changes in code by utilizing HMR.

Note that this web inspector has very limited capabilities. Naturally, it may not work for all cases. However it is a useful tool for when starting a new ReactUnity project. As an advanced feature, you can override the web inspector by placing your custom web inspector in previewer folder under your React project.