Documented Debug Symbols

Author: jeffreylanters

README.md

@@ -69,6 +69,7 @@ Welcome to the React Unity WebGL Documentation! My name is Jeffrey and I'm here
 - [Change the Render Size of WebGL Canvas](#change-the-render-size-of-webgl-canvas)
 - [Taking Screenshots of the Canvas](#taking-screenshots-of-the-canvas)
 - [Providing an external Memory File](#providing-an-external-memory-file)
+- [Providing Debugging Symbols](#providing-debugging-symbols)
 - [JavaScript to UnityScript types](#javascript-to-unityscript-types)
 - [Creating Unity WebGL builds](#creating-unity-webgl-builds)
 - [Contribution and Development](#contribution-and-development)
@@ -1118,6 +1119,41 @@ function App() {
 }
 ```
 
+## Providing Debugging Symbols
+
+> Available since version 8.8.0
+
+This is set to the filename of the JSON file containing debug symbols when the current build is using debug symbols, otherwise it is set to an empty string. If the Debug Symbols option is enabled and the Development Build option is disabled then the Debug Symbols will be generated automatically.
+
+```tsx
+<IUnityConfig>{
+  symbolsUrl: string,
+};
+```
+
+#### Example implementation
+
+A basic implementation could look something like this. In the following example we'll set the streaming assets url to the "streamingassets" directory.
+
+```jsx
+// File: App.jsx
+
+import React from "react";
+import Unity, { UnityContext } from "react-unity-webgl";
+
+const unityContext = new UnityContext({
+  loaderUrl: "build/myunityapp.loader.js",
+  dataUrl: "build/myunityapp.data",
+  frameworkUrl: "build/myunityapp.framework.js",
+  codeUrl: "build/myunityapp.wasm",
+  symbolsUrl: "build/debug-symbols.json",
+});
+
+function App() {
+  return <Unity unityContext={unityContext} />;
+}
+```
+
 ## JavaScript to UnityScript types
 
 Simple numeric types can be passed to JavaScript in function parameters without requiring any conversion. Other data types will be passed as a pointer in the emscripten heap (which is really just a big array in JavaScript). For strings, you can use the Pointerstringify helper function to convert to a JavaScript string.