# OGS for game developers

> How to make a web game OGS-compatible: the OGS app casts once, a TV launcher frames each game's TV page, phones play its phone page, and the game learns who is playing through profile-kit.

Start with the Quickstart for agents: it is a step-by-step checklist. The game contract is the single source of truth; when it and the code disagree, the zod schemas in packages/ogs-protocol win. Every page is also served as HTML at the same path without `.md`.

## Docs

- [Build a game for OGS](https://ogs-docs.pages.dev/index.md): What OGS is (cast once, a TV launcher frames games, phones join the couch, games know who's playing) and what a game gets.
- [Quickstart for agents](https://ogs-docs.pages.dev/quickstart.md): A numbered checklist a coding agent can follow end to end to make a web game OGS-compatible, with a copy-paste prompt.
- [The OGS game contract](https://ogs-docs.pages.dev/contract.md): The OGS game contract (single source of truth): manifest, TV page messages, phone page, token verification, rules, multi-couch rooms, planned joining.
- [profile-kit reference](https://ogs-docs.pages.dev/profile-kit.md): Every export of @open-game-system/profile-kit (main, /react, /server) with its signature and when to use it.
- [Messages and manifest](https://ogs-docs.pages.dev/messages.md): Launcher-to-game and game-to-launcher postMessage messages, manifest fields and shared types, generated from the ogs-protocol zod schemas.
- [Testing your game](https://ogs-docs.pages.dev/testing.md): Seam tests that frame your TV page from a stand-in launcher, the phone page in a fake WebView, no-fullscreen and plain-browser checks.
- [Art kit and catalogue](https://ogs-docs.pages.dev/art-and-catalogue.md): The four art-kit images (sizes and rules) and how to submit a game to the OGS catalogue.
- [Rules and taste](https://ogs-docs.pages.dev/rules.md): What an OGS game must and must not do: no cast button, no join codes, nothing over the TV's focal area, safe area, silent when parked, works in a plain browser.

## Optional

- [Everything in one file](https://ogs-docs.pages.dev/llms-full.txt): all pages above, concatenated
- [Source repository](https://github.com/open-game-system/open-game-system): the OGS monorepo (profile-kit, ogs-protocol, the TV launcher)