# dev.tsunagite.song

> Published by [tsunagite.dev](https://lexicon.garden/identity/did:plc:pz4sp2vf5w26wnaee253gfms)

✓ This is the authoritative definition for this NSID.

## Description

Definitions related to songs included in games hosting leaderboards via Tsunagite.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.song)
- [Documentation](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.song/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.song/examples)

## Definitions

### `dev.tsunagite.song`

**Type**: `record`

A song included in a game hosting leaderboards via Tsunagite.

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `game` | `array` | Yes | The game(s) this song is included in. |
| `genre` | `ref` → `dev.tsunagite.translatable` | No | The genre this song belongs to. |
| `title` | `ref` → `dev.tsunagite.translatable` | Yes | The human-readable title of this song in UI. Translations will typically be listed alongside the default. |
| `jacket` | `blob` | No | The jacket or banner art of this song, for display in UI. |
| `source` | `ref` → `dev.tsunagite.translatable` | No | The source this song is from - an album, competition, other game, etc. |
| `composer` | `ref` → `dev.tsunagite.translatable` | Yes | The name of the composer of this song. Translations will typically be listed alongside the default. |
| `subtitle` | `ref` → `dev.tsunagite.translatable` | No | The human-readable subtitle of this song. |
| `createdAt` | `string` (datetime) | No |  |
| `updatedAt` | `string` (datetime) | No |  |
| `jacketArtist` | `ref` → `dev.tsunagite.translatable` | No | The name of the jacket artist for this song. |

## Raw Schema

```json
{
  "id": "dev.tsunagite.song",
  "defs": {
    "main": {
      "key": "any",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "game",
          "title",
          "composer"
        ],
        "properties": {
          "game": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "at-uri",
              "description": "All URIs must point to records of type `dev.tsunagite.game`."
            },
            "description": "The game(s) this song is included in."
          },
          "genre": {
            "ref": "dev.tsunagite.translatable",
            "type": "ref",
            "description": "The genre this song belongs to."
          },
          "title": {
            "ref": "dev.tsunagite.translatable",
            "type": "ref",
            "description": "The human-readable title of this song in UI. Translations will typically be listed alongside the default."
          },
          "jacket": {
            "type": "blob",
            "accept": [
              "image/png",
              "image/jpeg",
              "image/jxl",
              "image/webp"
            ],
            "maxSize": 8000000,
            "description": "The jacket or banner art of this song, for display in UI."
          },
          "source": {
            "ref": "dev.tsunagite.translatable",
            "type": "ref",
            "description": "The source this song is from - an album, competition, other game, etc."
          },
          "composer": {
            "ref": "dev.tsunagite.translatable",
            "type": "ref",
            "description": "The name of the composer of this song. Translations will typically be listed alongside the default."
          },
          "subtitle": {
            "ref": "dev.tsunagite.translatable",
            "type": "ref",
            "description": "The human-readable subtitle of this song."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "updatedAt": {
            "type": "string",
            "format": "datetime"
          },
          "jacketArtist": {
            "ref": "dev.tsunagite.translatable",
            "type": "ref",
            "description": "The name of the jacket artist for this song."
          }
        }
      },
      "description": "A song included in a game hosting leaderboards via Tsunagite."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Definitions related to songs included in games hosting leaderboards via Tsunagite."
}
```