One game definition per record, published in the developer's own repo. Keep the same rkey to update it in place.
Record Key
any
Any valid record key
Properties
catalog
array
of
ref
#catalogRef
Optional
Links to matching entries in other game catalogs. Purely supplementary.
maxLength: 8 itemscategory
string
Required
Type of experience.
maxLength: 30 bytesKnown values:
browser, download, physical, othercover
blob
Optional
Card thumbnail image. 16:9 recommended.
maxSize: 4.0 MBcreatedAt
string
datetime
Required
An RFC 3339 formatted timestamp.
description
string
Optional
Full description.
maxLength: 2000 bytesdeveloper
ref
#party
Optional
The studio or person who made this.
icon
blob
Optional
Square icon. 256x256 recommended.
maxSize: 512.0 KBlegacyIds
array
of
string
Optional
Old IDs used for this same game by other catalogs or tools.
maxLength: 12 itemsmedia
array
of
ref
#mediaItem
Optional
Extra screenshots, banners, and key art.
maxLength: 24 itemsname
string
Required
Display name.
maxLength: 100 bytespublisher
string
at-uri
Required
AT-URI of the repo that owns this record. Must match this record's own repo.
releasedAt
string
datetime
Optional
When this became available.
requires
array
of
ref
#rule
Optional
Hard gates. Every rule must pass before a player can use this game.
maxLength: 16 itemsstatNamespace
string
Optional
Deprecated. Use uses[] instead.
maxLength: 80 bytesstatus
string
Optional
Current availability.
Known values:
live, beta, coming, archivedtagline
string
Optional
One-line summary.
maxLength: 200 bytestags
array
of
string
Optional
Freeform search tags.
maxLength: 12 itemstrailers
array
of
ref
#video
Optional
Video trailers or gameplay clips.
maxLength: 8 itemsupdatedAt
string
datetime
Optional
An RFC 3339 formatted timestamp.
url
string
uri
Required
Where to play, download, or access the game.
uses
array
of
ref
#recordUse
Optional
Other records this game reads or writes. Not required to play.
maxLength: 32 itemsView raw schema
{
"key": "any",
"type": "record",
"record": {
"type": "object",
"required": [
"name",
"url",
"publisher",
"category",
"createdAt"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Where to play, download, or access the game."
},
"icon": {
"type": "blob",
"accept": [
"image/png",
"image/webp"
],
"maxSize": 512000,
"description": "Square icon. 256x256 recommended."
},
"name": {
"type": "string",
"maxLength": 100,
"description": "Display name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32
},
"maxLength": 12,
"description": "Freeform search tags."
},
"uses": {
"type": "array",
"items": {
"ref": "#recordUse",
"type": "ref"
},
"maxLength": 32,
"description": "Other records this game reads or writes. Not required to play."
},
"cover": {
"type": "blob",
"accept": [
"image/png",
"image/jpeg",
"image/webp"
],
"maxSize": 4000000,
"description": "Card thumbnail image. 16:9 recommended."
},
"media": {
"type": "array",
"items": {
"ref": "#mediaItem",
"type": "ref"
},
"maxLength": 24,
"description": "Extra screenshots, banners, and key art."
},
"status": {
"type": "string",
"description": "Current availability.",
"knownValues": [
"live",
"beta",
"coming",
"archived"
]
},
"catalog": {
"type": "array",
"items": {
"ref": "#catalogRef",
"type": "ref"
},
"maxLength": 8,
"description": "Links to matching entries in other game catalogs. Purely supplementary."
},
"tagline": {
"type": "string",
"maxLength": 200,
"description": "One-line summary."
},
"category": {
"type": "string",
"maxLength": 30,
"description": "Type of experience.",
"knownValues": [
"browser",
"download",
"physical",
"other"
]
},
"requires": {
"type": "array",
"items": {
"ref": "#rule",
"type": "ref"
},
"maxLength": 16,
"description": "Hard gates. Every rule must pass before a player can use this game."
},
"trailers": {
"type": "array",
"items": {
"ref": "#video",
"type": "ref"
},
"maxLength": 8,
"description": "Video trailers or gameplay clips."
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"developer": {
"ref": "#party",
"type": "ref",
"description": "The studio or person who made this."
},
"legacyIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 80
},
"maxLength": 12,
"description": "Old IDs used for this same game by other catalogs or tools."
},
"publisher": {
"type": "string",
"format": "at-uri",
"description": "AT-URI of the repo that owns this record. Must match this record's own repo."
},
"updatedAt": {
"type": "string",
"format": "datetime"
},
"releasedAt": {
"type": "string",
"format": "datetime",
"description": "When this became available."
},
"description": {
"type": "string",
"maxLength": 2000,
"description": "Full description."
},
"statNamespace": {
"type": "string",
"maxLength": 80,
"description": "Deprecated. Use uses[] instead."
}
}
},
"description": "One game definition per record, published in the developer's own repo. Keep the same rkey to update it in place."
}