to.atpota.poe.overlay

atpota.to

Documentation

main record

No description available.

Record Key any Any valid record key

Properties

alerts boolean Optional

Poe says weather alerts (storms, apps blowing in).

chat boolean Optional

Poe says hello to chatters and answers chat commands.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

follows boolean Optional

Poe thanks new followers.

ignore array of string at-identifier Optional

Accounts Poe never greets, thanks or answers (bots).

maxLength: 50 items

name string Optional

What the streamer calls this layout, on the setup page only.

maxLength: 400 bytesmaxGraphemes: 40 graphemes

nap integer Optional

Minutes of quiet before Poe naps; 0 never.

minimum: 0maximum: 240

poe ref #poe Required

No description available.

theme string Optional

No description available.

Known values: light, dark

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

visitors boolean Optional

Now and then a butterfly, bird, snail, worm or moth visits Poe.

volume integer Optional

How loud Poe's noises are; 0 is silent.

minimum: 0maximum: 100

widgets array of ref #widget Required

The widgets on screen, each kind at most once.

maxLength: 16 items

View raw schema

{
  "key": "any",
  "record": {
    "properties": {
      "alerts": {
        "description": "Poe says weather alerts (storms, apps blowing in).",
        "type": "boolean"
      },
      "chat": {
        "description": "Poe says hello to chatters and answers chat commands.",
        "type": "boolean"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "follows": {
        "description": "Poe thanks new followers.",
        "type": "boolean"
      },
      "ignore": {
        "description": "Accounts Poe never greets, thanks or answers (bots).",
        "items": {
          "format": "at-identifier",
          "type": "string"
        },
        "maxLength": 50,
        "type": "array"
      },
      "name": {
        "description": "What the streamer calls this layout, on the setup page only.",
        "maxGraphemes": 40,
        "maxLength": 400,
        "type": "string"
      },
      "nap": {
        "description": "Minutes of quiet before Poe naps; 0 never.",
        "maximum": 240,
        "minimum": 0,
        "type": "integer"
      },
      "poe": {
        "ref": "#poe",
        "type": "ref"
      },
      "theme": {
        "knownValues": [
          "light",
          "dark"
        ],
        "type": "string"
      },
      "updatedAt": {
        "format": "datetime",
        "type": "string"
      },
      "visitors": {
        "description": "Now and then a butterfly, bird, snail, worm or moth visits Poe.",
        "type": "boolean"
      },
      "volume": {
        "description": "How loud Poe's noises are; 0 is silent.",
        "maximum": 100,
        "minimum": 0,
        "type": "integer"
      },
      "widgets": {
        "description": "The widgets on screen, each kind at most once.",
        "items": {
          "ref": "#widget",
          "type": "ref"
        },
        "maxLength": 16,
        "type": "array"
      }
    },
    "required": [
      "poe",
      "widgets",
      "createdAt",
      "updatedAt"
    ],
    "type": "object"
  },
  "type": "record"
}

poe object

No description available.

Properties

scale integer Required

Percent of its usual size.

minimum: 50maximum: 200

show boolean Required

No description available.

side string Required

Which bottom corner Poe sits in; it faces into the screen.

Known values: left, right

View raw schema

{
  "properties": {
    "scale": {
      "description": "Percent of its usual size.",
      "maximum": 200,
      "minimum": 50,
      "type": "integer"
    },
    "show": {
      "type": "boolean"
    },
    "side": {
      "description": "Which bottom corner Poe sits in; it faces into the screen.",
      "knownValues": [
        "left",
        "right"
      ],
      "type": "string"
    }
  },
  "required": [
    "show",
    "side",
    "scale"
  ],
  "type": "object"
}

widget object

No description available.

Properties

kind string Required

The atmosphere's weather (card to pulse), Anisota's moon, mark and loader, the time as a TID, the streamer's flushes (im.flushing.right.now), status and vitals (is.dame.now, is.dame.state) and teal.fm music, or their stream.place chat.

Known values: card, strip, badge, apps, forecast, pulse, moon, mark, loader, tid, flushes, status, music, chat

scale integer Required

Percent of its usual size.

minimum: 50maximum: 200

slot string Required

Where on screen. Widgets in the same slot stack.

Known values: top-left, top-center, top-right, bottom-left, bottom-center, bottom-right

style string Optional

How the widget looks, for the kinds with more than one way: tid (ticking, mini), flushes (count, stats, latest), status (both, status, vitals), music (now, history, stats, mini), chat (corner, side, pop). Absent or unknown is the kind's first.

maxLength: 32 bytes

Known values: ticking, mini, count, stats, latest, both, status, vitals, now, history, corner, side, pop

View raw schema

{
  "properties": {
    "kind": {
      "description": "The atmosphere's weather (card to pulse), Anisota's moon, mark and loader, the time as a TID, the streamer's flushes (im.flushing.right.now), status and vitals (is.dame.now, is.dame.state) and teal.fm music, or their stream.place chat.",
      "knownValues": [
        "card",
        "strip",
        "badge",
        "apps",
        "forecast",
        "pulse",
        "moon",
        "mark",
        "loader",
        "tid",
        "flushes",
        "status",
        "music",
        "chat"
      ],
      "type": "string"
    },
    "scale": {
      "description": "Percent of its usual size.",
      "maximum": 200,
      "minimum": 50,
      "type": "integer"
    },
    "slot": {
      "description": "Where on screen. Widgets in the same slot stack.",
      "knownValues": [
        "top-left",
        "top-center",
        "top-right",
        "bottom-left",
        "bottom-center",
        "bottom-right"
      ],
      "type": "string"
    },
    "style": {
      "description": "How the widget looks, for the kinds with more than one way: tid (ticking, mini), flushes (count, stats, latest), status (both, status, vitals), music (now, history, stats, mini), chat (corner, side, pop). Absent or unknown is the kind's first.",
      "knownValues": [
        "ticking",
        "mini",
        "count",
        "stats",
        "latest",
        "both",
        "status",
        "vitals",
        "now",
        "history",
        "corner",
        "side",
        "pop"
      ],
      "maxLength": 32,
      "type": "string"
    }
  },
  "required": [
    "kind",
    "slot",
    "scale"
  ],
  "type": "object"
}