# games.cavu.game

> Published by [chris.pardy.family](https://lexicon.garden/identity/did:plc:dp7v5b5kejmmzzpwmqyf5wj6)

✓ This is the authoritative definition for this NSID.

## Links

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

## Definitions

### `games.cavu.game`

**Type**: `record`

Cavu's sidecar to a game's games.atmosphere.define record: how the game launches and what it may do with a player's account. Same rkey as the define record: the game's slug (e.g. 'haiku-day'), which scopes everything the game may write (games.cavu.score / games.cavu.save at '<slug>[:...]', actor.rpg.stats at '<slug>'). The game's name, description, art and links live in the define record.

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `capabilities` | `array` | Yes | Everything the game may do through a player's host. Shown before launch. |
| `define` | `string` (at-uri) | Yes | The games.atmosphere.define record this extends (same repo, same rkey). |
| `guests` | `boolean` | Yes | Whether the game can be played without signing in (nothing is saved). |
| `launchService` | `string` (did) | Yes | DID whose document names the launch service endpoint (#cavu_launch) and its grant-signing key. |
| `pack` | `string` (at-uri) | No | The games.cavu.pack this game runs (Lua + assets). |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Cavu's sidecar to a game's games.atmosphere.define record: how the game launches and what it may do with a player's account. Same rkey as the define record: the game's slug (e.g. 'haiku-day'), which scopes everything the game may write (games.cavu.score / games.cavu.save at '<slug>[:...]', actor.rpg.stats at '<slug>'). The game's name, description, art and links live in the define record.",
      "key": "any",
      "record": {
        "properties": {
          "capabilities": {
            "description": "Everything the game may do through a player's host. Shown before launch.",
            "items": {
              "ref": "games.cavu.defs#capability",
              "type": "ref"
            },
            "type": "array"
          },
          "define": {
            "description": "The games.atmosphere.define record this extends (same repo, same rkey).",
            "format": "at-uri",
            "type": "string"
          },
          "guests": {
            "description": "Whether the game can be played without signing in (nothing is saved).",
            "type": "boolean"
          },
          "launchService": {
            "description": "DID whose document names the launch service endpoint (#cavu_launch) and its grant-signing key.",
            "format": "did",
            "type": "string"
          },
          "pack": {
            "description": "The games.cavu.pack this game runs (Lua + assets).",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "define",
          "launchService",
          "guests",
          "capabilities"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "games.cavu.game",
  "lexicon": 1
}
```