Skip to content

Commit e6226a2

Browse files
committed
chore: documentation and link updates
1 parent dcd6c96 commit e6226a2

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ Use this if you are only editing C# code, assets, samples, or tests.
77
1. Ensure you have [Unity 2022.3.23f1](https://unity.com/releases/editor/whats-new/2022.3.23) installed.
88
2. Fork the repository and clone it to your local drive.
99

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.
1212
1. Install [NodeJS](https://nodejs.org/en) on your system.
1313
2. Build the JS bridge:
1414
```shell
1515
cd Tools/playroomkit-js
1616
npm install
1717
```
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.
2020

2121
## Resources
2222
- User-facing Documentation: https://docs.joinplayroom.com/usage/unity
@@ -56,7 +56,7 @@ Packages/com.playroomkit.sdk
5656
├── Playroom.asmdef
5757
└── PlayroomKit.cs
5858
```
59-
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.
6060

6161
#### Modules
6262
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
9494
3. In the `Samples` section, click `Import` on the sample you want to run.
9595
4. Open the imported sample scene from your project `Assets/` folder.
9696

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+
97102
### Syncing sample changes
98103
If the package sample content changes, re-import the sample from the same Package Manager screen (`Samples` section > `Reimport`).
99104

Packages/com.playroomkit.sdk/package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"unity": "2022.3",
66
"description": "This SDK is a wrapper over PlayroomKit JS. Currently, it only supports WebGL exported games.",
77
"documentationUrl": "https://docs.joinplayroom.com/usage/unity",
8+
"changelogUrl": "https://github.com/playroomkit/unity/blob/main/CHANGELOG.md",
89
"keywords": [
910
"playroom",
1011
"multiplayer",
@@ -39,6 +40,7 @@
3940
}
4041
],
4142
"author": {
42-
"name": "Playroom"
43+
"name": "Playroom",
44+
"url" : "https://joinplayroom.com"
4345
}
4446
}

0 commit comments

Comments
 (0)