online.timtinkers.bot.command

bot.timtinkers.online

Documentation

Record representing a chat bot command. The response field supports variable substitution (e.g. $user, $target, $randomNumber[min,max]) which is resolved at runtime.

main record

Record representing a chat bot command. The response field supports variable substitution (e.g. $user, $target, $randomNumber[min,max]) which is resolved at runtime.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

Optional help text describing what the command does

maxLength: 300 bytes
globalCooldown integer Optional

Global cooldown in seconds shared across all users. 0 means no cooldown.

minimum: 0
hidden boolean Optional

Whether the command is hidden from the !commands list

isReply boolean Optional

Whether the bot should reply to the triggering message rather than posting standalone

permissions array of ref #permissionLevel Optional

Roles that are allowed to use this command. If omitted, the command is available to everyone.

maxLength: 10 items
response string Required

Response text supporting variable substitution ($user, $target, $arg[n], $randomNumber[min,max], etc.). Length is validated at runtime after substitution.

trigger string Required

The command trigger without prefix (e.g., 'socials', 'hug', 'd6')

maxLength: 50 bytesminLength: 1 bytes
userCooldown integer Optional

Per-user cooldown in seconds. 0 means no cooldown.

minimum: 0
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "trigger",
      "response",
      "createdAt"
    ],
    "properties": {
      "hidden": {
        "type": "boolean",
        "description": "Whether the command is hidden from the !commands list"
      },
      "isReply": {
        "type": "boolean",
        "description": "Whether the bot should reply to the triggering message rather than posting standalone"
      },
      "trigger": {
        "type": "string",
        "maxLength": 50,
        "minLength": 1,
        "description": "The command trigger without prefix (e.g., 'socials', 'hug', 'd6')"
      },
      "response": {
        "type": "string",
        "description": "Response text supporting variable substitution ($user, $target, $arg[n], $randomNumber[min,max], etc.). Length is validated at runtime after substitution."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "description": {
        "type": "string",
        "maxLength": 300,
        "description": "Optional help text describing what the command does"
      },
      "permissions": {
        "type": "array",
        "items": {
          "ref": "#permissionLevel",
          "type": "ref"
        },
        "maxLength": 10,
        "description": "Roles that are allowed to use this command. If omitted, the command is available to everyone."
      },
      "userCooldown": {
        "type": "integer",
        "minimum": 0,
        "description": "Per-user cooldown in seconds. 0 means no cooldown."
      },
      "globalCooldown": {
        "type": "integer",
        "minimum": 0,
        "description": "Global cooldown in seconds shared across all users. 0 means no cooldown."
      }
    }
  },
  "description": "Record representing a chat bot command. The response field supports variable substitution (e.g. $user, $target, $randomNumber[min,max]) which is resolved at runtime."
}
default token

Any viewer (default permission level)

Referenceonline.timtinkers.bot.command#default

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "type": "token",
  "description": "Any viewer (default permission level)"
}
moderator token

A channel moderator

Referenceonline.timtinkers.bot.command#moderator

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "type": "token",
  "description": "A channel moderator"
}
permissionLevel string

No description available.

Known Values (other values may be valid)
online.timtinkers.bot.command#streamer(token) online.timtinkers.bot.command#moderator(token) online.timtinkers.bot.command#vip(token) online.timtinkers.bot.command#default(token)
View raw schema 
{
  "type": "string",
  "knownValues": [
    "online.timtinkers.bot.command#streamer",
    "online.timtinkers.bot.command#moderator",
    "online.timtinkers.bot.command#vip",
    "online.timtinkers.bot.command#default"
  ]
}
streamer token

The channel owner / streamer

Referenceonline.timtinkers.bot.command#streamer

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "type": "token",
  "description": "The channel owner / streamer"
}
vip token

A VIP viewer

Referenceonline.timtinkers.bot.command#vip

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "type": "token",
  "description": "A VIP viewer"
}

Lexicon Garden

@