Starter kits
Starter kits
The fastest way to a game that passes review is to start from one that already follows the rules. Each kit is the same tiny game, "Target Tap" (tap the targets before they vanish), so you can compare how the SDK is wired in. Each is small and dependency-light, runs when the SDK is missing or disabled, keeps every asset path relative and loads the SDK from https://sdk.zokogames.com/zokogames-sdk-v1.js.
| Kit | Use it when | Needs | Download |
|---|---|---|---|
html5-minimal |
You write plain JavaScript or want to read every SDK call in one file. | A static web server. No build step. | html5-minimal.zip |
html5-vite-ts |
You want TypeScript, a bundler and typed SDK access. | Node 18 or later, npm install. |
html5-vite-ts.zip |
phaser |
You build with Phaser 3. | Node 18 or later, npm install. |
phaser.zip |
What each kit demonstrates#
| SDK area | Where to look |
|---|---|
init() and the disabled fallback |
A small wrapper (zoko() in html5-minimal, src/zoko.ts in the Vite kit, safe() in the Phaser kit) so one failing call never breaks the game. |
| Loading signals and portal settings | loadingStart / loadingStop at boot; muteAudio applied at start and on change. |
| Gameplay events | gameplayStart when a round begins, gameplayStop when it ends, the tab is hidden or an ad starts. |
| Ads | A midgame ad every second round at a natural break; a rewarded button that grants the reward only after adFinished. |
| Banners | A container on the menu screen only, cleared before play (html5-minimal, Phaser). |
| Cloud save | The best score through SDK.data. |
| Users and leaderboard | html5-minimal shows getUser, an auth listener, a sign-in button and submitScore with the AES-GCM helper. |
| Invites | html5-minimal shows inviteLink, getInviteParam and a join listener. |
Test, package, upload#
All kits follow the same loop. The kit READMEs list the details.
- Run on
localhost. The SDK switches to its in-page mock: ads are a three-second overlay, banners are dashed boxes, users and friends are fake. Add?sdk_debug=trueto log every call. See testing. - Open the Preview tool. Enter your local address and play: the requirements checklist ticks as your game makes the calls.
- Package.
html5-minimalis already uploadable: zipindex.htmlso it sits at the archive root. In the Vite and Phaser kits,npm run packagetypechecks, builds and writes a zip named after the package, refusing to zip a build with absolute paths. Both set Vite'sbaseto./. - Upload the zip in the developer console and read the validation report.
The Phaser kit uses the ZokoGames Phaser plugin, copied into src/zoko/. See the Phaser page for what the plugin adds on top of the raw SDK. The plugin has not yet been compiled against every Phaser release; it targets Phaser 3.80 and later.