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.
The SDK is distributed as a UPM package (not a .unitypackage). Source lives under Packages/com.playroomkit.sdk, and samples are under Packages/com.playroomkit.sdk/Samples~.
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.
Releases are handled by release-please. Merges to main create or update a release PR; merging that PR cuts the tag, updates CHANGELOG.md, and publishes the GitHub release (the workflow also attaches the packed UPM artifact).
Read CONTRIBUTING.md for more information on how to contribute code to this project.
Example(s) of the SDK are in the Samples 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!