You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,16 +7,16 @@ Use this if you are only editing C# code, assets, samples, or tests.
7
7
1. Ensure you have [Unity 2022.3.23f1](https://unity.com/releases/editor/whats-new/2022.3.23) installed.
8
8
2. Fork the repository and clone it to your local drive.
9
9
10
-
### JS bridge (only if you change the WebGL plugin)
11
-
Node.js is only required to rebuild the WebGL JS bridge. The build step installs the upstream JS SDK and generates the `.jslib`/`.jspre` files used by Unity.
10
+
### JS bridge (only if you change the PlayroomKit JS plugin)
11
+
Node.js is only required to rebuild the PlayroomKit JS plugin. The build step installs the upstream JS SDK and generates the `.jslib`/`.jspre` files used by Unity.
12
12
1. Install [NodeJS](https://nodejs.org/en) on your system.
13
13
2. Build the JS bridge:
14
14
```shell
15
15
cd Tools/playroomkit-js
16
16
npm install
17
17
```
18
-
This installs the upstream SDK and builds the WebGL plugin into `Packages/com.playroomkit.sdk/Runtime/Plugins/Playroom` (the `.jslib` and `.jspre` files).
19
-
3. Re-run `npm install`(or `npm run build`) only when `Tools/playroomkit-js/src/index.js` changes.
18
+
This installs the upstream SDK and builds the plugin into `Packages/com.playroomkit.sdk/Runtime/Plugins/Playroom` (the `.jslib` and `.jspre` files).
19
+
3. Re-run `npm install` only when `Tools/playroomkit-js/src/index.js` changes.
The package also includes a custom WebGL template for Discord activities located in `Packages/com.playroomkit.sdk/Assets/WebGLTemplates`.
59
+
The package also includes a custom WebGL template for Discord activities located in `Packages/com.playroomkit.sdk/Assets/WebGLTemplates`. This can be uploaded to project using the provided menu.
60
60
61
61
#### Modules
62
62
Playroomkit comes with many [modules](https://docs.joinplayroom.com/components) which help with speeding up development. Unity SDK builds on top of that and adds its own modules such as MockMode.
@@ -94,6 +94,11 @@ Samples are distributed via the package and must be imported into your project t
94
94
3. In the `Samples` section, click `Import` on the sample you want to run.
95
95
4. Open the imported sample scene from your project `Assets/` folder.
96
96
97
+
## Editor Menu Options
98
+
Menu options are available to help setup the Unity Editor:
99
+
1.`PlayroomKit > Dev > Apply Playroom Mock Mode to Scene` adds the mock mode prefab to active scene
100
+
2.`PlayroomKit > WebGL > ...` allow setting up editor support for WebGL/discord builds
101
+
97
102
### Syncing sample changes
98
103
If the package sample content changes, re-import the sample from the same Package Manager screen (`Samples` section > `Reimport`).
0 commit comments