What is the GAMEE SDK?

A short tour of the SDK and the platform ↔ game model.

@gamee/sdk is the JavaScript/TypeScript SDK that lets your HTML5 game talk to the GAMEE platform — the iOS app, the Android app, and gamee.com on web. It is the ground-up successor to the legacy gamee-js.

If you have never built for GAMEE before, read this page top to bottom and you will know enough to choose the right install path and write your first integration.

The model in one minute#

A GAMEE game runs inside the platform. On web the platform embeds it in an iframe; on mobile it is a WKWebView (iOS) or an Android WebView. The platform is the GAMEE app or gamee.com — it owns the user, the score board, the wallet, and the lifecycle.

Your game and the platform exchange two kinds of traffic:

• Game → platform: requests. Your game asks the platform to do something (save state, show a rewarded video, charge gems). The SDK gives you a Promise for the result.
• Platform → game: events. The platform tells your game about a change (pause, resume, mute, start, useExtraLife). You subscribe with gamee.on(...).

The SDK abstracts the underlying transport. You always write the same code; the SDK picks postMessage on web and the native bridge on mobile.

What the SDK gives you#

• Typed API — every method, event payload and error code has a TypeScript type. No more guessing at callback shapes.
• Promises everywhere — async work returns Promises. Old gamee-js callbacks are gone.
• Capabilities — declare upfront what your game supports (saveState, gems, rewardedAds, …). The SDK refuses to call gated methods until you do.
• Validation at the call site — bad input rejects locally with a typed GameeError instead of round-tripping to the platform and failing silently.
• A real test bridge — @gamee/sdk-test-utils ships a MockBridge so you can unit-test the integration without a platform.
• A bundled emulator — open it from the top-right button on any page to drive any URL through a fake platform and watch every byte on the wire.

What’s not here (was in gamee-js)#

The new SDK intentionally drops the surface area that nobody used or that the platform stopped supporting:

• Controllers (OneButton, Joystick, …) — games are fullscreen and own their own input.
• replay, ghostMode, socialData, playerData capabilities and the methods/events that hung off them.
• gamee.share() — was a stub.
• gamee.gameLoadingProgress() — render your own loading UI.

If you are coming from gamee-js, the migration guide has the full diff.

Where to next#

1. Glossary — the canonical names for every moving piece (platform, bridge, capability, …) so the rest of the docs read cleanly.
2. Install — local-build link (today), <script> tag, or self-hosted bundle. npm registry is a preview.
3. Build your first game — annotated 30-line walkthrough.
4. Architecture — what flows on the wire and why.
5. Engine recipes — copy-paste setups for Phaser, Pixi, Three.js, Babylon.js, Construct 3, and vanilla canvas.
6. Testing — using @gamee/sdk-test-utils in Vitest/Jest.