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.
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.
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.
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.
Read CONTRIBUTING.md for more information on how to contribute code to this project.
Example(s) of the SDK are in the Examples folder
Currently, there's no support for using the native platforms. We'd love to hear ideas and plans to implement PlayroomKit for Unity on native platforms. Please join this Discord to discuss!