games.atplay.game.secrets Documentation (EN)

main record

A player's private secrets for one game, stored in their own 'me only' permissioned space — never on the public network. Written with the same record key as the invitation it belongs to, so it can be found without a query.

Record Key tid Timestamp-based ID

Properties

invitation ref com.atproto.repo.strongRef Required

The game this holds secrets for. Record keys are only unique within a collection, so this disambiguates same-key invitations from different repos.

secrets ref #secrets Required

Replaces any previously stored secrets for this game in full; game logic replaces rather than merges this map on every resolve.

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "invitation",
      "secrets"
    ],
    "properties": {
      "secrets": {
        "ref": "#secrets",
        "type": "ref",
        "description": "Replaces any previously stored secrets for this game in full; game logic replaces rather than merges this map on every resolve."
      },
      "invitation": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "The game this holds secrets for. Record keys are only unique within a collection, so this disambiguates same-key invitations from different repos."
      }
    }
  },
  "description": "A player's private secrets for one game, stored in their own 'me only' permissioned space — never on the public network. Written with the same record key as the invitation it belongs to, so it can be found without a query."
}

secrets object

Open-ended map of string keys to string values, opaque to everything but the game logic and middleware that produced it (committed cleartexts awaiting reveal, per-item decryption keys, and so on).

This object has no properties defined.

View raw schema

{
  "type": "object",
  "properties": {},
  "description": "Open-ended map of string keys to string values, opaque to everything but the game logic and middleware that produced it (committed cleartexts awaiting reveal, per-item decryption keys, and so on)."
}