asadm / playroom-unity

9 stars 1 forks source link

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 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.

Found a bug, or want us to implement something? Create an Issue 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.

git tag v0.Y.Z
git push origin --tags

This will create a draft release on GitHub. Edit the release to add release notes and publish it.

Learn more

Read more about the PlayroomKit Unity integration and the design behind it.

Examples

Example(s) of the SDK are in the Examples folder