# games.atplay.game.invitation

> Published by [atplay.games](https://lexicon.garden/identity/did:plc:xawtkr77srkxlwhxjf7whbml)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:xawtkr77srkxlwhxjf7whbml/games.atplay.game.invitation)
- [Documentation](https://lexicon.garden/lexicon/did:plc:xawtkr77srkxlwhxjf7whbml/games.atplay.game.invitation/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:xawtkr77srkxlwhxjf7whbml/games.atplay.game.invitation/examples)

## Definitions

### `games.atplay.game.invitation`

**Type**: `record`

An invitation to play a game, with everything needed to execute it

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `game` | `ref` → `games.atplay.game.release` | Yes |  |
| `state` | `ref` → `games.atplay.game.state` | Yes |  |
| `parameters` | `object` | No | Any parameters of play used by the game logic |
| `otherPlayers` | `array` | Yes | Array of DIDs for other players in the game |

## Raw Schema

```json
{
  "id": "games.atplay.game.invitation",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "game",
          "otherPlayers",
          "state"
        ],
        "properties": {
          "game": {
            "ref": "games.atplay.game.release",
            "type": "ref"
          },
          "state": {
            "ref": "games.atplay.game.state",
            "type": "ref"
          },
          "parameters": {
            "type": "object",
            "properties": {},
            "description": "Any parameters of play used by the game logic"
          },
          "otherPlayers": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "did"
            },
            "minLength": 1,
            "description": "Array of DIDs for other players in the game"
          }
        }
      },
      "description": "An invitation to play a game, with everything needed to execute it"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```