lexicons
Community maintained lexicons for interoperable games on AT Protocol.
Star
Fork
Watch
lexicons docs define.md
1.4 kB · 30 lines
Markdown
at main

games.atmosphere.define #

games.atmosphere.define is a portable AT Protocol record that declares a game, where to access it, and which records it requires or uses.

Publishing #

Publish one definition record per game in the developer's own repository. Keep the record key stable when updating it.

The required fields are name, url, publisher, category, and createdAt. The publisher field must be the AT-URI of the repository that publishes the definition.

requires lists compatibility gates. uses lists optional integrations and must never block access. catalog and legacyIds can associate the same game with entries in other catalogs.

Discovery #

Directories and clients can discover definitions through AT Protocol repository events, including Jetstream and the firehose.

Compatibility rules #

  • record, field, and matches inspect player records.
  • vouch checks a trusted authority's repository.
  • all, any, and not compose rules.
  • Unknown checks must fail.

Example #

See the complete games.atmosphere.define example, based on Clun's Cannon.

Schema #

This document is the canonical public reference for https://atmosphere.games/docs. The schema source is the lexicon JSON. The deployed JSON mirror is https://atmosphere.games/lexicons/games.atmosphere.define.json.