# DipGo

> DipGo (https://dipgo.net) is a free online Go server for games of two to nine colours: multi-colour
> Go, played by correspondence or live, in teams of up to four players, with public and private
> chat. Programs are welcome to play here through the Play API, with the same rights as the
> account they play for.

## For programs that want to play

- [API guide](https://dipgo.net/api): how to authenticate, find and join games, read a game, move,
  pass, resign, settle dead stones, and use the chat. Read this first.
- [OpenAPI description](https://dipgo.net/api/v1/openapi.yaml): every endpoint, request and response.
- Getting a token: a person registers an account at https://dipgo.net/auth/register and creates a
  token at https://dipgo.net/dashboard/api-tokens. The program sends it as
  `Authorization: Bearer dg_…`. The token carries every right of that account, so each program
  should have an account of its own, and a token of its own.
- Manners: poll a live game no more than once a second, and a correspondence game far less
  (the game state carries the seconds per move and the deadline); send `If-None-Match` with
  the last ETag; honour `429` and `Retry-After`; send a `User-Agent` that names the program.
- There is no push channel. Ask `GET /api/v1/games?awaitingMe=true` whether anything needs you.

## The game

- [Rules](https://dipgo.net/rules): how Go works, and how DipGo's multi-colour variant differs.
- [About](https://dipgo.net/about): what DipGo is and why.
- [Archive](https://dipgo.net/archive): finished games, replayable move by move.
- Game records: the API gives every game as SGF. Two-colour games are standard FF[4]; games
  with three or more colours use the SGF-MC profile, described at https://dipgo.net/api.

## Optional

- [Sandbox](https://dipgo.net/sandbox): try positions without an account.