add missing config options and bump version

Author: Philipp Molitor

README.md

@@ -1,5 +1,14 @@
 # React Unity Renderer
 
+<p align="center">
+
+<img src="https://img.shields.io/npm/l/react-unity-renderer?style=flat-square">
+<img src="https://img.shields.io/npm/dw/react-unity-renderer?style=flat-square">
+<img src="https://img.shields.io/github/stars/PhilippMolitor/react-unity-renderer?style=flat-square">
+<img src="https://img.shields.io/npm/v/react-unity-renderer?style=flat-square">
+
+</p>
+
 > This project is heavily inspired by [react-unity-webgl](https://github.com/elraccoone/react-unity-webgl) made by Jeffrey Lanters.
 > This is a modernized, `FunctionComponent` based interpretation of his ideas.
 
@@ -37,11 +46,13 @@ import {
 // you *could* put a JSON in your WebGL template containing this information
 // and load that with fetch or axios to assemble your config.
 const config: UnityLoaderConfig = {
-  loaderUrl: '',
-  frameworkUrl: '',
-  codeUrl: '',
-  dataUrl: '',
+  loaderUrl: '...',
+  frameworkUrl: '...',
+  codeUrl: '...',
+  dataUrl: '...',
   // everything from here on is optional
+  memoryUrl: '',
+  symbolsUrl: '',
   streamingAssetsUrl: '',
   companyName: '',
   productName: '',
@@ -64,3 +75,70 @@ export const UnityGameComponent: VFC = (): JSX.Element => {
   );
 };
 ```
+
+## Creating a fetchable config from a Unity WebGL template
+
+In order to create a fetchable build config that contains all required keys for `UnityLoaderConfig`, you could add the following to a Unity WebGL template and upload it to a `CORS`-enabled web host (for example Amazon AWS S3).
+
+`build.json`
+
+```json
+{
+  "loaderUrl": "Build/{{{ LOADER_FILENAME }}}",
+  "frameworkUrl": "Build/{{{ FRAMEWORK_FILENAME }}}",
+  "codeUrl": "Build/{{{ CODE_FILENAME }}}",
+#if MEMORY_FILENAME
+  "memoryUrl": "Build/{{{ MEMORY_FILENAME }}}",
+#endif
+#if SYMBOLS_FILENAME
+  "symbolsUrl": "Build/{{{ SYMBOLS_FILENAME }}}",
+#endif
+  "dataUrl": "Build/{{{ DATA_FILENAME }}}",
+  "streamingAssetsUrl": "StreamingAssets",
+  "companyName": "{{{ COMPANY_NAME }}}",
+  "productName": "{{{ PRODUCT_NAME }}}",
+  "productVersion": "{{{ PRODUCT_VERSION }}}"
+}
+
+```
+
+Take the following example using `axios`:
+
+`unity-api.ts`
+
+```ts
+import axios, { AxiosResponse } from 'axios';
+import { UnityLoaderConfig } from 'react-unity-renderer';
+
+function fetchLoaderConfig(baseUrl: string): Promise<UnityLoaderConfig> {
+  let result: AxiosResponse<UnityLoaderConfig>;
+
+  try {
+    const url = `${baseUrl}/build.json?t=${new Date().getTime()}`;
+    result = await axios.get<UnityLoaderConfig>(url);
+  } catch (ex) {
+    // network or request error
+    throw new Error('unable to load build info');
+  }
+
+  const { status, data } = result;
+
+  // invalid response
+  if (status < 200 || status >= 400) {
+    throw new Error('unable to load build info');
+  }
+
+  return {
+    loaderUrl: `${baseUrl}/${data.loaderUrl}`,
+    frameworkUrl: `${baseUrl}/${data.frameworkUrl}`,
+    codeUrl: `${baseUrl}/${data.codeUrl}`,
+    dataUrl: `${baseUrl}/${data.dataUrl}`,
+    memoryUrl: `${baseUrl}/${data.memoryUrl}`,
+    symbolsUrl: `${baseUrl}/${data.symbolsUrl}`,
+    streamingAssetsUrl: `${baseUrl}/${data.streamingAssetsUrl}`,
+    companyName: `${data.companyName}`,
+    productName: `${data.productName}`,
+    productVersion: `${data.productVersion}`,
+  };
+}
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-unity-renderer",
-  "version": "1.2020.0",
+  "version": "1.2020.1",
   "description": "React Unity Renderer allows to interactively embed Unity WebGL builds into a React powered project.",
   "main": "./dist/index.js",
   "author": "Philipp Molitor <philipp@molitor.cloud>",

src/global.ts

@@ -7,20 +7,15 @@ interface Window {
   createUnityInstance(
     element: HTMLCanvasElement,
     parameters: {
-      dataUrl: string;
-
       frameworkUrl: string;
-
       codeUrl: string;
-
+      dataUrl: string;
+      memoryUrl?: string;
+      symbolsUrl?: string;
       streamingAssetsUrl?: string;
-
       companyName?: string;
-
       productName?: string;
-
       productVersion?: string;
-
       modules?: Object;
     },
     onProgress?: (progression: number) => void

src/interfaces/config.ts

@@ -1,18 +1,13 @@
 export type UnityInstanceConfig = {
-  dataUrl: string;
-
   frameworkUrl: string;
-
   codeUrl: string;
-
+  dataUrl: string;
+  memoryUrl?: string;
+  symbolsUrl?: string;
   streamingAssetsUrl?: string;
-
   companyName?: string;
-
   productName?: string;
-
   productVersion?: string;
-
   modules?: Object;
 };