Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asadm/playroom-unity
https://github.com/asadm/playroom-unity
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/asadm/playroom-unity
- Owner: asadm
- Created: 2023-07-25T08:24:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-09T10:16:01.000Z (5 months ago)
- Last Synced: 2024-04-10T08:29:11.385Z (5 months ago)
- Language: C#
- Size: 349 KB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
PlayroomKit SDK for Unity
The easiest multiplayer infrastructure for the web
This SDK is a wrapper over PlayroomKit JS. Currently, it only supports WebGL exported games. The API is meant to closely mirror the PlayroomKit JavaScript SDK.
## Installation and Usage
See [PlayroomKit Unity docs](https://docs.joinplayroom.com/usage/unity) on how to use this SDK in your Unity project.
This beta version of the SDK might undergo changes that could break compatibility with previous versions, even without a major version update. To ensure stability, it's advisable to fix the usage to a particular package version. By doing so, you'll consistently install the same version and avoid unexpected changes, unless you deliberately seek the latest updates.
## Contribution
### Reporting issues
You can search for help, or ask the community, in our [Discord channel](https://discord.gg/HGkSRAD8).
Found a bug, or want us to implement something? [Create an Issue](https://github.com/asadm/playroom-unity/issues/new) on GitHub.
### Creating a new release
Tag and push the tag to create a new release. The tag should be in the format `v0.Y.Z`. For example, `v0.0.20`.
```bash
git tag v0.Y.Z
git push origin --tags
```
This will create a draft release [on GitHub](https://github.com/asadm/playroom-unity/releases). Edit the release to add release notes and publish it.
### Learn more
Read more about the PlayroomKit Unity integration and the design behind it.
- [Official announcement blog](https://docs.joinplayroom.com/blog/unityweb)
- [Deep dive into PlayroomKit Unity](https://www.linkedin.com/pulse/building-unity-plugin-javascript-grayhatpk-gynfc/?trackingId=kbv0oZVNT6aLh2TjQ%2FhuVw%3D%3D)
### Examples
Example(s) of the SDK are in the [Examples](https://github.com/asadm/playroom-unity/tree/main/Assets/PlayroomKit/Examples) folder