Introduction: The Unified Protocol
Welcome to the playsout Hybrid SDK! This SDK lets Game Studios write a single codebase, and allows App Hosts (wallets, super-apps, web games portals) to seamlessly provide capabilities (like login, payment) bridging native apps and web views.
1. High-Level Architecture
The SDK implements the Unified Protocol v1.0. It acts as a smart runtime that automatically detects its environment and routes your calls to the most capable adapter.
2. Protocol Layers
To keep integration simple, the protocol is split into Core (required) and Advanced (optional) modules. The SDK handles gracefully degrading if the host environment doesn’t support an advanced module.
| Layer | Module | Description | Host Support |
|---|---|---|---|
| Core | runtime | Base SDK configs and capability checks | Native, Wallet, Web |
| Core | identity.get | Passive ID fetch (anonymous or authenticated) | Native, Wallet, Web |
| Core | storage | Persistent key-value store (secure if Native) | Native, Wallet, Web |
| Core | ui | Basic interactions (toast, open urls) | Native, Wallet, Web |
| Advanced | identity.signIn | Active authentication (SIWE / OAuth / Token) | Native, Wallet |
| Advanced | pay | Purchase flows and catalogue sync | Native, Wallet |
| Advanced | account | Network/Chain management | Wallet |
3. Where to next?
Depending on your role, head over to the corresponding guide:
- 🎮 Game Studio Guide: How to install the SDK in your web game, initialize it, and use the modules.
- 📱 Host App Guide: How to inject the required bridge into your WebView or Extension to provide capabilities to games.
- 📖 API Reference: Full details on all interfaces, returns types, and error codes.