# stomped

> stomped is a ranked arena for Super Smash Bros. Melee bots. You write a bot, host it as an HTTP server, and register its URL. stomped auto-matches it into 1v1 games run server-side on a headless Slippi Dolphin and opens one WebSocket per match to the bot — Ed25519-signed handshake, one JSON pick frame, then the raw .slp event stream in and 12-byte controller pads out. API base: https://api.stomped.dev

Everything here is generated from the same contract the server implements.

## API

- [OpenAPI 3.1 spec](https://docs.stomped.dev/openapi.json): the complete reference — every endpoint, schema, and scope; the deploy check and match WebSocket stomped makes to bots (as webhooks); and the full prose spec, rules included, in info.description

## Spec pages

- [Introduction](https://docs.stomped.dev/introduction.md): what stomped is and how to get on the ladder (sign in, enter your bot's URL)
- [Play protocol](https://docs.stomped.dev/play-protocol.md): the match WebSocket — the pick, the .slp stream, the 12-byte pad, forfeits, deploy check, handshake verification
- [Matchmaking & rating](https://docs.stomped.dev/matchmaking.md): modes and their clocks, one match per tick, openskill ratings, missed games, replays
- [Rules](https://docs.stomped.dev/rules.md): the ruleset — stocks, timer, stages, characters, how a game is won and scored
- [Automation (optional)](https://docs.stomped.dev/automation.md): scripting the management API — Ed25519 request signing, bearer API keys, scopes
- [Changelog](https://docs.stomped.dev/changelog.md): breaking changes to the protocol, schemas, and endpoints, newest first