SDK Integrations
This guide will be updated as the Playtron SDK and additional tooling become available. Check back regularly for the latest recommendations and implementation details.
Your integration options depend on the environments you expect your users to interact with your game.
On device integration
For on device game integration, you need the Playtron GameOS SDK. The SDK provides access to OS-level features, such as environment detection, remote PACT attestation, virtual keyboard and browser utilities, and Sui wallet integration.
The Playtron GameOS SDK repository contains the installation and initialization steps to begin development. The repository also contains examples on how to use the SDK in C++, C#, and Node.js environments. The .dll build files needed to compile the C++ code are provided. For the C# and Node.js examples, you can install the necessary dependencies from the respective package manager.
The Paytron GameOS SDK provides automatic wallet access with the following benefits:
- Users already have a Playtron wallet through their Playtron account.
- No additional wallet setup required on device.
- Games can immediately access wallet functions through the SDK.
Off device integration
For off-device integration, use the Sui dApp Kit. By integrating the Sui dApp Kit, your game can continue to use the Playtron zkLogin wallet when not running directly on the SuiPlay0x1 device. This is useful if your game is available on the web, desktop, or mobile devices.
The Sui dApp Kit documentation site (linked in the previous paragraph), provides the installation instructions for the SDK. With the SDK integrated into your gaming project, you can enable Playtron zkLogin wallet as a connection option.
The dApp Kit runs in TypeScript, meaning your game needs TypeScript processing to integrate with this SDK. If your game is a web-based game, or you navigate users to a browser to perform Web3 transactions on your associated website, this should not be an issue.
If you're unable to run TypeScript, you can always support sending assets from your wallet to the Playtron wallet. Users can also access their Playtron wallet address via the companion web application. Finally, you can support sending assets from your game on a different platform. For example, the user can use your PC client to transfer assets to their Playtron wallet, then continue playing on device.
Supported wallet types
- Playtron wallet: Seamless continuation from on-device sessions.
- Self-custody options: Support for any wallet available through the Sui dApp Kit (such as Slush wallet, Phantom, Backpack) to include future wallet integrations.
Related links
- Playtron GameOS SDK: The official Playtron OS SDK repository on GitHub.
- Sui dApp Kit documentation: The Sui dApp Kit is a set of React components, hooks, and utilities to help you build a dApp for the Sui ecosystem.
- SuiPlay0x1 Discord: Follow announcements and connect with the community on the Discord channel for SuiPlay0X1.
- Companion web application (in development): Support linking the Playtron wallet to other self-custodied wallets using Sui Link, enabling read-access of associated wallets while on the device.
- Enoki Connect: With Enoki Connect, users can use their dApp-specific accounts across different dApps, enabling a more unified and consistent experience.