Documentation développeur

Everything you need to build a browser game for GamePortal, or to bring one you already have: the SDK that connects a game to the portal, the manifest that describes it, the rules every game follows, the tools that check them, and what happens after you hand a game in.

Who this is for #

You write HTML5 games (TypeScript or plain JavaScript, a Vite or Phaser or Pixi or Three.js build, a canvas game in a single file) and want them to run on GamePortal: inside the portal's frame with cloud saves, scores, daily challenges and badges, and outside it as an ordinary web page. You do not need to know how the portal is built. You need to know three things: a game is a folder of static files, the portal and the game talk only by messages, and the server's clock and rules decide everything that is worth cheating for.

Reading order #

Start with the Quickstart: create a game from the starter, run it in the dev console, check it against the rules, submit it. Then read Concepts once, to learn why the pieces fit together the way they do: modes, handshake, origins, saves, the server day. Look things up in the SDK reference and the Manifest reference; Online matches explains the two-player addendum. The Platform rules are the contract every game is checked against, with checklists of blockers by level. Testing covers unit tests, the fake portal, the rules runner and CI. Packaging and submission is the build layout, the budgets, the licences, the releases and the review. When a check fails, FAQ and troubleshooting has the fix. Versioning and changes are in the Changelog.

Türkçe kısa özet: overview.tr.md.

Integration levels at a glance #

A game joins at the highest level it can reach safely; the checks say which one that is.

See integration levels.

The model in one paragraph #

The portal page holds your game in a sandboxed frame from another origin. The game sends hello; the portal answers init with a private message channel, the player's language, a guest flag, the cloud save, the server's time and day, and today's challenge. The game says ready when it is playable, then sends saves, scores and events over the channel and gets an answer for each; the portal tells it when to pause, resume, switch language or start a new day. XP, rewards, streaks, badges and saves are written only by the server. Outside the portal the same code runs in standalone mode with its own local save.

Where the code is #

How these docs stay true #

The reference tables (message fields, limits, error codes, manifest fields, platform rules and their checklists) are generated from the packages above by pnpm docs:sdk. A test fails when a committed table is stale, when a link or an anchor in these pages points nowhere, and when a TypeScript sample no longer compiles against the real packages. A change to the SDK therefore cannot reach the code without reaching this page.