# nocker.sh game API

> AI-authored 256x256 pixel games. No editor, login, database, or save data.

Write JavaScript declaring const game. The runtime supplies api.
Play: /r/<payload>. Read code without executing it: /c/<payload>.
The payload is gzip-compressed UTF-8 JavaScript encoded as unpadded Base64url.
Limits: 3,000 compressed bytes and 65,536 uncompressed bytes.
The payload is in the URL path and is sent to the server. /c/ renders decoded code in the browser.
Legacy fragment URLs remain readable. Never truncate or manually rewrite an encoded payload.
The root page / is an unrelated existing artwork. Do not change it.

## Documentation

- [Getting started](/docs/getting-started.md): Create a game, generate its URL, and verify it.
- [Core API](/docs/core.md): 256x256 drawing, input, timing, and game lifecycle.
- [Sprites](/docs/sprites.md): Built-in 8x8 sprites and custom pixel assets.
- [Dungeon instance](/docs/dungeon.md): All options, defaults, turn rules, and inspect state.
- [Combat](/docs/battle.md): Turn-based battles, skills, guard, and damage formulas.
- [Type reference](/docs/api-reference.md): Complete public TypeScript interfaces.
- [Preview and sharing](/docs/preview.md): URL format, browser automation, errors, and sandbox behavior.

- [Game tools](/docs/tools.md): Overlap and swept collisions, wall sliding, seeded random, grids, pathfinding, line of sight, field of view, and particles.
- [Works](/docs/examples.md): Generated links for complete example games; repository records are .docs/works/*.md.

- [Inventory](/docs/inventory.md): Stack limits, atomic crafting/trades, item consumption, and snapshots.

- [Animation](/docs/animation.md): Numeric tweens, easing, repeat/pingpong, explicit time updates, seek and reset.

- [Drawing layers](/docs/layers.md): Scoped translation, scaling, clipping, cameras, split screens, and HUD separation.

- [Fixed-step games](/docs/fixed-step.md): Timed grid movement, queued turns, pause, tail collision, and full-board spawning.

- [Platform player](/docs/player.md): Reusable movement, jump buffering, coyote time, dash, reset, and original animated pixel assets.

Documentation files are UTF-8. Preserve exact API identifiers and generated URLs.
Use node scripts/check-docs.mjs for offline encoding, link, and generated-reference checks.