# GAMEE SDK

> `@gamee/sdk` is a typed, promise-based JavaScript bridge between an HTML5 game and the GAMEE platform (web iframe, iOS WKWebView, Android WebView). The wire protocol is identical across all three hosts; the SDK picks the right transport at boot. Games declare capabilities at `init()` time; gated methods reject synchronously when the capability is missing.

Full briefing for an AI agent (single file, paste-ready): https://sdk.gamee.com/llms-full.txt

## Get started

- [What is the GAMEE SDK?](https://sdk.gamee.com/guide/getting-started): A short tour of the SDK and the platform ↔ game model.
- [Glossary](https://sdk.gamee.com/guide/glossary): Canonical terms used across the SDK and these docs.
- [Install](https://sdk.gamee.com/guide/install): Download the SDK, link it from your game.
- [Your first game](https://sdk.gamee.com/guide/first-game): A 30-line GAMEE-ready game, line by line.

## Guides

- [Architecture](https://sdk.gamee.com/guide/architecture): How the SDK, the bridge and the GAMEE platform actually talk.
- [Capabilities](https://sdk.gamee.com/guide/capabilities): What each capability unlocks and how to declare them.
- [Methods](https://sdk.gamee.com/guide/methods): Every game → platform call, its arguments, return value, and capability requirements.
- [Events](https://sdk.gamee.com/guide/events): Every platform → game event, payload, and what your game has to do.
- [Platform rules a game must follow](https://sdk.gamee.com/guide/game-rules): Hard requirements for shipping on GAMEE — distilled from the legacy wiki.
- [Engine recipes](https://sdk.gamee.com/guide/engine-recipes): Drop-in setups for the most common HTML5 game stacks.

## Reference

- [Error handling](https://sdk.gamee.com/guide/errors): Every error code, when it fires, and how to recover.
- [Troubleshooting](https://sdk.gamee.com/guide/troubleshooting): Symptom → likely cause → how to verify → fix. The page you reach for when something silently doesn't work.
- [Configuration](https://sdk.gamee.com/guide/config): Tuning SdkOptions, and when to use createSdk vs. the gamee singleton.
- [Utilities](https://sdk.gamee.com/guide/utilities): SDK-level helpers and read-only state — platform context, platform name, version, capability list.
- [Changelog](https://sdk.gamee.com/guide/changelog): Notable changes between SDK versions.
- [AI-agent context](https://sdk.gamee.com/guide/llm-context): A drop-in briefing your AI assistant can read to use @gamee/sdk correctly on the first try.

## Testing

- [Unit testing with sdk-test-utils](https://sdk.gamee.com/guide/testing): MockBridge — drive the SDK from a test without a real platform.

## Migration

- [Migrating from gamee-js](https://sdk.gamee.com/guide/migration): Every breaking change between gamee-js and gamee-sdk, with the mapping tables.