gg.infinitetavern.herald.battleReport

infinitetavern.gg

Documentation

A herald's battle report — a structured summary of a tavern battle written by the town crier bot to its own PDS. The AT-URI of this record may be embedded in Bluesky feed posts to announce match results.

main record

A herald's battle report — a structured summary of a tavern battle written by the town crier bot to its own PDS. The AT-URI of this record may be embedded in Bluesky feed posts to announce match results.

Record Key tid Timestamp-based ID

Properties

gifUrl string uri Optional

Optional URL to an animated battle summary.

lobbyId string Required

Server-assigned lobby UUID identifying the tavern battle.

placements array of ref #placementEntry Required

Final standings of all adventurers, ordered by placement.

maxLength: 8 items
playedAt string datetime Required

ISO 8601 UTC timestamp when the battle concluded.

roundCount integer Required

Total combat rounds in the battle.

minimum: 1
seasonName string Optional

Display name of the campaign season.

seasonNumber integer Required

The campaign season this battle took place in.

minimum: 1
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "lobbyId",
      "seasonNumber",
      "roundCount",
      "playedAt",
      "placements"
    ],
    "properties": {
      "gifUrl": {
        "type": "string",
        "format": "uri",
        "description": "Optional URL to an animated battle summary."
      },
      "lobbyId": {
        "type": "string",
        "description": "Server-assigned lobby UUID identifying the tavern battle."
      },
      "playedAt": {
        "type": "string",
        "format": "datetime",
        "description": "ISO 8601 UTC timestamp when the battle concluded."
      },
      "placements": {
        "type": "array",
        "items": {
          "ref": "#placementEntry",
          "type": "ref"
        },
        "maxLength": 8,
        "description": "Final standings of all adventurers, ordered by placement."
      },
      "roundCount": {
        "type": "integer",
        "minimum": 1,
        "description": "Total combat rounds in the battle."
      },
      "seasonName": {
        "type": "string",
        "description": "Display name of the campaign season."
      },
      "seasonNumber": {
        "type": "integer",
        "minimum": 1,
        "description": "The campaign season this battle took place in."
      }
    }
  },
  "description": "A herald's battle report — a structured summary of a tavern battle written by the town crier bot to its own PDS. The AT-URI of this record may be embedded in Bluesky feed posts to announce match results."
}
placementEntry object

One adventurer's final standing in the battle.

Properties

did string did Required

A decentralized identifier (DID).

handle string Required

No description available.

heroKey string Required

No description available.

heroName string Required

No description available.

mmrChange number Optional

Signed rating change for this adventurer.

placement integer Required

No description available.

minimum: 1maximum: 8
View raw schema 
{
  "type": "object",
  "required": [
    "placement",
    "did",
    "handle",
    "heroKey",
    "heroName"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "handle": {
      "type": "string"
    },
    "heroKey": {
      "type": "string"
    },
    "heroName": {
      "type": "string"
    },
    "mmrChange": {
      "type": "number",
      "description": "Signed rating change for this adventurer."
    },
    "placement": {
      "type": "integer",
      "maximum": 8,
      "minimum": 1
    }
  },
  "description": "One adventurer's final standing in the battle."
}

Lexicon Garden

@