StreamElements

https://github.com/streamelements/docs
Admin
StreamElements is a platform that provides comprehensive tools and services for live streamers,...
Tokens:188,083
Snippets:2,158
Trust Score:9.2
Update:6 days ago
Show doc for...
Tokens:
Raw
### Start a votekick for TrollUser123

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/modules/votekick.md

Example command to start a votekick for the user 'TrollUser123'.

```streamelements
!votekick TrollUser123
```

--------------------------------

### Start votekick with default duration

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/votekick.mdx

Example of starting a vote for 'DisruptiveUser' using the default vote duration configured in the module.

```json
{
  "persona": "moderator",
  "message": "!votekick DisruptiveUser"
},
{
  "persona": "bot",
  "message": "Vote started to kick DisruptiveUser! Type !yes or !no to vote. (Vote ends in 60s)"
}
```

--------------------------------

### Entering a raffle (!sraffle) chat example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/join.mdx

This example shows the interaction flow between a moderator starting a raffle, the bot announcing it, and a user joining.

```json
{
  "persona": "moderator", "message": "!sraffle" },
  { "persona": "bot", "message": "A raffle has begun! Enter by typing \"!join\". It will end in 60 seconds." }, // Example bot message
  { "persona": "user", "message": "!join" },
}
```

--------------------------------

### Chat example: successfully opening store

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/openstore.mdx

Example of the bot response when items are successfully re-enabled.

```json
{
  "persona": "moderator",
  "message": "!openstore"
},
{
  "persona": "bot",
  "message": "@Moderator, successfully updated 15 items. (Store opened)"
}
```

--------------------------------

### Example: Successfully enabling SFX items

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/enablesfx.mdx

This example shows the bot response when multiple SFX items are successfully re-enabled.

```json
{
  "persona": "moderator",
  "message": "!enablesfx"
},
{
  "persona": "bot",
  "message": "@Moderator, successfully updated 5 items. (SFX store opened)"
}
```

--------------------------------

### Bingo game with all platforms example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/bingo.mdx

An example of the broadcaster starting a bingo game that includes emotes from all supported platforms.

```json
{
  "persona": "broadcaster", "message": "!bingo all 250" },
  { "persona": "bot", "message": "Bingo started! Guess the emote (Twitch, BTTV, FFZ, 7TV) to win 250 points!" }
```

--------------------------------

### Example: No disabled SFX items found

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/enablesfx.mdx

This example shows the bot response when there are no disabled SFX items to re-enable.

```json
{
  "persona": "broadcaster",
  "message": "!enablesfx"
},
{
  "persona": "bot",
  "message": "@Broadcaster, No disabled SFX store items found."
}
```

--------------------------------

### Install Go WebSocket Dependencies

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/websockets/examples.mdx

Use this command to install the necessary packages for implementing a WebSocket client in Go.

```sh
go get github.com/gorilla/websocket github.com/google/uuid
```

--------------------------------

### Buying multiple tickets example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/ticket.mdx

Example of a user purchasing five tickets using the !ticket command.

```astro
<ChatExample
    messages={[
        { persona: 'user', message: '!ticket 5' },
        { persona: 'bot', message: '@viewer, you successfully bought 5 tickets!' }
    ]}
/>
```

--------------------------------

### Buying a single ticket example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/ticket.mdx

Example of a user purchasing a single ticket using the !ticket command.

```astro
<ChatExample
    messages={[
        { persona: 'user', message: '!ticket' },
        { persona: 'bot', message: '@viewer, you successfully bought 1 ticket!' }
    ]}
/>
```

--------------------------------

### Start votekick with custom duration

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/votekick.mdx

Example of starting a vote for 'RuleBreaker' with a specified 2-minute voting period.

```json
{
  "persona": "moderator",
  "message": "!votekick RuleBreaker 2m"
},
{
  "persona": "bot",
  "message": "Vote started to kick RuleBreaker! Type !yes or !no to vote. (Vote ends in 120s)"
}
```

--------------------------------

### Start a raffle with default settings

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/sraffle.mdx

Example of a moderator starting a raffle without parameters, using the default prize of 1000 points and default duration of 60 seconds from module settings. The bot confirms the raffle has begun.

```streamelements
!sraffle
```

```streamelements
a Raffle has begun for 1000 points PogChamp it will end in 60 Seconds. Enter by typing "!join" OpieOP
```

--------------------------------

### Giveaway Start Event

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/websockets/topics/channel-giveaway.md

Payload indicating that a giveaway has started accepting entries.

```json
{
    "channelId": "5ad23dcc18fff500d78c5348",
    "giveawayId": "67cf4296216c6ff883878c0a",
    "event": "start",
    "state": "running",
    "data": null
}
```

--------------------------------

### Betting all points example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/roulette.mdx

Example of a user betting all their points and the resulting bot response.

```json
<ChatExample messages={[
  { persona: 'user', message: '!roulette all' },
  { persona: 'bot', message: '@User spins the wheel... and lost 1000 points! You now have 0 points. FeelsBadMan' } // Output varies (win/loss)
]} />
```

--------------------------------

### Chat example: no items to enable

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/openstore.mdx

Example of the bot response when no regular items were previously disabled.

```json
{
  "persona": "broadcaster",
  "message": "!openstore"
},
{
  "persona": "bot",
  "message": "@Broadcaster, No disabled regular store items found."
}
```

--------------------------------

### Chat example for !songrequest

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/songrequest.mdx

Example of a user requesting a song by search term and the bot's confirmation response.

```javascript
<ChatExample messages={[
  { persona: 'user', message: '!songrequest epic sax guy' },
  { persona: 'bot', message: '@User, added Epic Sax Guy - "Epic Sax Guy 10 Hours" to the queue at #2 (playing ~in 3 mins 5 secs) https://youtu.be/kxopViU98Xo' } // Output varies; the name before the title is the YouTube channel
]} />
```

--------------------------------

### Start a raffle with a 100 point reward

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/raffle.mdx

Example of starting a raffle with a 100 point reward lasting 60 seconds.

```json
{
  "persona": "moderator",
  "message": "!raffle 100 60"
},
{
  "persona": "bot",
  "message": "The Multi-Raffle for 100 points will end in 60 Seconds. Enter by typing \"!join\""
}
```

--------------------------------

### Start a raffle with 10 points for 10 seconds

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/sraffle.mdx

Example of a moderator starting a raffle with 10 points and 10 seconds duration. The bot confirms the raffle has begun and instructs viewers to enter with !join.

```streamelements
!sraffle 10 10
```

```streamelements
a Raffle has begun for 10 points PogChamp it will end in 10 Seconds. Enter by typing "!join" OpieOP
```

--------------------------------

### Chat example: no song playing

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/song.mdx

Example of the bot responding when no song is currently in the queue.

```json
<ChatExample messages={[
  { persona: 'user', message: '!song' },
  { persona: 'bot', message: '@User, No song is currently playing.' }
]} />
```

--------------------------------

### Chat example for !sr

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/songrequest.mdx

Example of a user requesting a song by URL and the bot's confirmation response.

```javascript
<ChatExample messages={[
  { persona: 'user', message: '!sr https://www.youtube.com/watch?v=dQw4w9WgXcQ' },
  { persona: 'bot', message: '@User, added Rick Astley - "Never Gonna Give You Up" to the queue at #3 (playing ~in 7 mins 15 secs) https://youtu.be/dQw4w9WgXcQ' } // Output varies
]} />
```

--------------------------------

### Install Python Websockets Library

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/websockets/examples.mdx

Command to install the 'websockets' library required for the Python client implementation.

```sh
pip install websockets
```

--------------------------------

### Chat interaction example for !play

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/play.mdx

Example of a moderator triggering the command and the bot confirming the action.

```javascript
{
  // Assume playback was paused previously
  { persona: 'moderator', message: '!play' },
  { persona: 'bot', message: '@Moderator, Media request playback resumed!' }
}
```

--------------------------------

### Set points example for a user

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/setpoints.mdx

Example of a moderator setting a user's points to 1000.

```astro
<ChatExample messages={[
  { persona: 'moderator', message: '!setpoints darkoe 1000' },
  { persona: 'bot', message: '@Moderator, set darkoe\'s points to 1000!' }
]} />
```

--------------------------------

### Extended onWidgetLoad implementation

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/overlays/events.mdx

An example of handling the onWidgetLoad event with additional logic.

```javascript
window.addEventListener('onWidgetLoad', function (obj) {
  console.log(obj); // You can check obj value in the browser console.
  //fancy stuff here
});
```

--------------------------------

### Chat interaction example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/filesay.mdx

An example of how the !filesay command appears in chat and the subsequent bot responses.

```javascript
<ChatExample messages={[
  { persona: 'broadcaster', message: '!filesay https://pastebin.com/raw/examplebans' },
  // Bot output will vary based on the file contents and success of each command
  { persona: 'bot', message: 'Executing 3 lines from URL...' },
  { persona: 'bot', message: 'BotUser1 has been permanently banned from the chat.' },
  { persona: 'bot', message: 'TrollAccount2 has been permanently banned from the chat.' },
  { persona: 'bot', message: 'AnotherUser has been timed out for 600 seconds.' }
]} />
```

--------------------------------

### Example interaction 1

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/8ball.mdx

An example of a user asking a question and receiving a response from the bot.

```astro
<ChatExample messages={[
  { persona: 'user', message: '!8ball Will I win my next game?' },
  { persona: 'bot', message: 'It is decidedly so.' }
]} />
```

--------------------------------

### Chat example: song playing

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/song.mdx

Example of the bot responding with the current song details when a track is active.

```json
<ChatExample messages={[
  { persona: 'user', message: '!song' },
  { persona: 'bot', message: '@User, current song: DrakeVEVO - Drake, 21 Savage - Rich Flex (Audio), requested by styler https://youtu.be/I4DjHHVHWAE' }
]} />
```

--------------------------------

### Create a command with $(customapi)

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/customapi.mdx

Example of adding a command that fetches the latest video from a YouTube API.

```streamelements
!command add !latestvideo Check out our latest video: $(customapi https://decapi.me/youtube/latest_video?id=UCjerlCIbLPQwSnYlClkjDXg)
```

--------------------------------

### Enable a chat timer example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/timer.mdx

Example of a moderator enabling a timer named socialMediaTimer.

```json
{
  "persona": "moderator", "message": "!timer enable socialMediaTimer" },
  { "persona": "bot", "message": "@Moderator, timer socialMediaTimer has been enabled." }
]
```

--------------------------------

### Node.js ws Library Installation

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/websockets/examples.mdx

Installs the ws library required for implementing a websocket client in Node.js.

```sh
npm install ws
```

--------------------------------

### Chat interaction example for !accept

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/accept.mdx

This example shows the flow of a duel request from initiation by the challenger to acceptance by the target user and the final result.

```javascript
<ChatExample
    messages={[
        {
            username: "Challenger",
            message: "!duel TargetUser 100"
        },
        {
            username: 'StreamElements',
            message: '@TargetUser, @Challenger wants to duel you for 100 points, you can !accept or !deny within 2 minutes',
            userColor: '#5B99FF',
            badges: ['partner', 'moderator'],
            isBot: true
        },
        {
            username: "TargetUser",
            message: "!accept"
        },
        {
            username: 'StreamElements',
            message: 'TargetUser won the Duel vs Challenger PogChamp',
            userColor: '#5B99FF',
            badges: ['partner', 'moderator'],
            isBot: true
        }
    ]}
/>
```

--------------------------------

### Roleplaying example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/ai.mdx

Example of using the AI variable for roleplaying, incorporating the ${user} variable.

```streamelements
!command add !aipirate ${ai You are a friendly pirate. Greet ${user} and tell them about your latest adventure.}
```

--------------------------------

### Checking your own points example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/points.mdx

An example of a user checking their own points balance and rank in chat.

```astro
<ChatExample messages={[
  { persona: 'user', usernameOverride: 'Viewer1', message: '!points' },
  { persona: 'bot', message: '@Viewer1, you have 5280 ChannelPoints and are rank #15 on the leaderboard.' }
]} />
```

--------------------------------

### Chat example: Active giveaway

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/giveaway.mdx

Example of the bot response when a giveaway is currently running.

```json
<ChatExample messages={[
  { persona: 'user', message: '!giveaway' },
  { persona: 'bot', message: '@User, Current giveaway: "Epic New Game Key!" https://streamelements.com/YOUR_CHANNEL/giveaway/GIVEAWAY_ID' }
]} />
```

--------------------------------

### KappaGen Overlay Broadcast Example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/websockets/topics/channel-overlay-broadcast.md

An example of the channel.overlay.broadcast topic used by the !kappagen command to trigger an emotesplosion-kappagen event.

```json
{
    "id": "01J6VTDB25SX14GDBDFZWDX3M9",
    "ts": "2024-09-03T11:30:39Z",
    "type": "message",
    "topic": "channel.overlay.broadcast",
    "room": "5ad23dcc18fff500d78c5348",
    "data": {
        "target": "global",
        "event": "emotesplosion-kappagen",
        "data": {
            // ... the chat message that triggered !kappagen
        }
    }
}
```

--------------------------------

### Example output

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/leagueoflegends.mdx

The format of the rank and LP returned by the variable.

```text
Challenger I (1229 LP)
```

--------------------------------

### Betting 100 points example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/roulette.mdx

Example of a user betting 100 points and the resulting bot response.

```json
<ChatExample messages={[
  { persona: 'user', message: '!roulette 100' },
  { persona: 'bot', message: '@User spins the wheel... and wins 100 points! You now have 1100 points. PogChamp' } // Output varies (win/loss)
]} />
```

--------------------------------

### Chat example: No active giveaway

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/giveaway.mdx

Example of the bot response when no giveaway is currently running.

```json
<ChatExample messages={[
  { persona: 'user', message: '!giveaway' },
  { persona: 'bot', message: '@User, There is currently no giveaway running!' }
]} />
```

--------------------------------

### Duel challenge example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/duel.mdx

An example of a user initiating a duel and the bot responding with the challenge notification.

```javascript
<ChatExample
    messages={[
        {
            username: "Challenger",
            message: "!duel TargetUser 100"
        },
        {
            username: 'StreamElements',
            message: '@TargetUser, @Challenger wants to duel you for 100 points, you can !accept or !deny within 2 minutes',
            userColor: '#5B99FF',
            badges: ['partner', 'moderator'],
            isBot: true
        }
    ]}
/>
```

--------------------------------

### Listing active BTTV emotes example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/emotes.mdx

Example of listing active BetterTTV emotes in chat.

```json
{
  "persona": "user", "message": "!emotes bttv" 
},
{
  "persona": "bot", "message": "Active BetterTTV emotes in chat: Pog LULW monkaW Clap" 
}
```

--------------------------------

### Betting 50% of points example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/roulette.mdx

Example of a user betting 50% of their current points and the resulting bot response.

```json
<ChatExample messages={[
  { persona: 'user', message: '!roulette 50%' },
  { persona: 'bot', message: '@User spins the wheel... and lost 500 points! You now have 500 points. FeelsBadMan' } // Output varies (win/loss)
]} />
```

--------------------------------

### Reset points example for a user

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/setpoints.mdx

Example of a broadcaster resetting a user's points to 0.

```astro
<ChatExample messages={[
  { persona: 'broadcaster', message: '!setpoints viewer123 0' },
  { persona: 'bot', message: '@Broadcaster, set viewer123\'s points to 0!' }
]} />
```

--------------------------------

### Listing active FFZ emotes example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/emotes.mdx

Example of listing active FrankerFaceZ emotes in chat.

```json
{
  "persona": "user", "message": "!emotes ffz" 
},
{
  "persona": "bot", "message": "Active FrankerFaceZ emotes in chat: monkaS FeelsOkayMan PepeHands ZULUL" 
}
```

--------------------------------

### TFT rank lookup examples

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/teamfighttactics.mdx

Examples of using the $(teamfighttactics) variable with different regions and Riot IDs.

```streamelements
$(teamfighttactics euw Styler#EUW)
$(teamfighttactics na Doublelift#NA1)
```

--------------------------------

### Checking another user's points example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/points.mdx

An example of a user checking the points balance and rank of another specified user.

```astro
<ChatExample messages={[
  { persona: 'user', message: '!points StreamElements' },
  { persona: 'bot', message: '@StreamElements has 99999 ChannelPoints and is rank #1 on the leaderboard.' }
]} />
```

--------------------------------

### Add a command using $(game)

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/game.mdx

Example of adding a custom command that announces the current game.

```streamelements
!command add !game We're currently playing $(game)!
```

--------------------------------

### Example interaction 2

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/8ball.mdx

An example of a user asking a different question and receiving a random response from the bot.

```astro
<ChatExample messages={[
  { persona: 'user', message: '!8ball What should I have for dinner?' },
  { persona: 'bot', message: 'Cannot predict now.' }
]} />
```

--------------------------------

### Variable usage examples

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/leagueoflegends.mdx

Examples showing how to use the variable with a standard Riot ID and a Riot ID containing spaces.

```streamelements
$(leagueoflegends styler#euw euw)
$(leagueoflegends "Doublelift#na1" na)
```

--------------------------------

### Example: Removing all songs requested by a user

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/removesong.mdx

This example shows a broadcaster removing all songs requested by a specific user.

```json
{
  "persona": "broadcaster",
  "message": "!removesong SpamRequester"
},
{
  "persona": "bot",
  "message": "@Broadcaster, skipped all songs from SpamRequester"
}
```

--------------------------------

### Chat interaction example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/vanish.mdx

Shows the user input and the resulting bot confirmation message.

```javascript
<ChatExample messages={[
  { persona: 'user', message: '!vanish' },
  { persona: 'bot', message: 'StreamElements timed out [User] for 1 second.' }
]} />
```

--------------------------------

### Bingo game interaction example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/bingo.mdx

An example of a moderator starting a Twitch emote bingo game and a viewer winning the points.

```json
{
  "persona": "moderator", "message": "!bingo twitch 100" },
  { "persona": "bot", "message": "Bingo started! Guess the Twitch emote to win 100 points!" },
  { "persona": "user", "usernameOverride": "viewer1", "message": "Kappa" },
  { "persona": "user", "usernameOverride": "viewer2", "message": "LUL" },
  { "persona": "user", "usernameOverride": "viewer3", "message": "PogChamp" },
  { "persona": "bot", "message": "Congratulations viewer3! You guessed the correct emote PogChamp and won 100 points!" }
```

--------------------------------

### Example text file for !filesay

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/filesay.mdx

A sample raw text file format containing commands to be executed line by line.

```text
/ban BotUser1 Spamming
/ban TrollAccount2 Being disruptive
/timeout AnotherUser 600 Repeat offences
```

--------------------------------

### !emotecount example with Kappa emote

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/emotecount.mdx

Example of a user checking the count for the Kappa emote and the bot's response showing the usage count.

```streamelements
!emotecount Kappa
```

```streamelements
@User, The emote Kappa has been used 15731 times! PogChamp
```

--------------------------------

### Example: Losing spin

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/slots.mdx

A chat example showing a user wagering 100 points and losing the bet.

```json
{
  "persona": "user",
  "message": "!slots 100"
},
{
  "persona": "bot",
  "message": "@User you got Kappa | Kappa | 4Head and lost your 100 points LUL"
}
```

--------------------------------

### Example: Broadcaster setting game to OSRS

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/setgame.mdx

Shows the broadcaster triggering the command and the bot confirming the update to Old School RuneScape.

```json
{
  "persona": "broadcaster",
  "message": "!setgame OSRS"
},
{
  "persona": "bot",
  "message": "@Broadcaster changed the game to \"Old School RuneScape\"!"
}
```

--------------------------------

### Example: Winning spin

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/slots.mdx

A chat example showing a user wagering 500 points and winning, with the payout calculated based on the default configuration.

```json
{
  "persona": "user",
  "message": "!slots 500"
},
{
  "persona": "bot",
  "message": "@User you got Kappa | Kappa | Kappa and won 12500 points PogChamp"
}
```

--------------------------------

### !queue open command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/queue.mdx

Opens the queue for viewers to join. A title is required.

```json
<ChatExample messages={[
  { persona: 'moderator', message: '!queue open Viewer Games' },
  { persona: 'bot', message: '@Moderator, The Viewer Games queue is now open! Viewers can type !queue join to enter.' }
]} />
```

--------------------------------

### Insufficient points error example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/duel.mdx

An example showing the bot response when a user attempts to wager more points than they currently possess.

```javascript
<ChatExample messages={[
  { persona: 'user', message: '!duel AnotherUser 10000' }, // User doesn't have enough points
  { persona: 'bot', message: '@User, you do not have enough points to duel for 10000.' }
]} />
```

--------------------------------

### SE_API.getOverlayStatus example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/overlays/custom-widget.md

Gets the overlay status, returning an object with isEditorMode and muted properties.

```JavaScript
SE_API.getOverlayStatus().then(status => {
  console.log(status);
  
  /*
  Result would look like below:
  {
    "isEditorMode":true,
    "muted":false
  }
  */
});
```

--------------------------------

### Add an introduction command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/args.mdx

Uses multiple argument tokens $(1) and $(2) to reference specific words in the user message.

```streamelements
!cmd add !introduce $(1) is $(2) years old
```

--------------------------------

### Example output format

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/quote.mdx

The format of the output generated by the $(quote) variable.

```text
#3 That was the play of the century!
```

--------------------------------

### 8ball chat interaction example 2

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/modules/eightball.mdx

An example of a viewer asking a question and receiving a neutral response from the bot.

```astro
<ChatExample messages={[
  { persona: 'user', message: '!8ball Should I order pizza tonight?' },
  { persona: 'bot', message: 'The 8ball says: Ask again later.' }
]} />
```

--------------------------------

### Chat example: Successful clear

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/hypecup.mdx

Shows the expected interaction when the command is used correctly.

```json
{
  "persona": "moderator",
  "message": "!hypecup clear"
},
{
  "persona": "bot",
  "message": "@Moderator, Successfully cleared HypeCup."
}
```

--------------------------------

### Example of successful !skip command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/skip.mdx

Shows the interaction when a moderator successfully skips a song.

```json
<ChatExample messages={[
  { persona: 'moderator', message: '!skip' },
  { persona: 'bot', message: '@Moderator, skipped song: Drake, 21 Savage - Rich Flex (Audio)' }
]} />
```

--------------------------------

### Get weather for London, UK

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/weather.mdx

Example usage of the $(weather) variable for an international location.

```streamelements
$(weather "London, UK")
```

--------------------------------

### Usage Example in CSS

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/overlays/widget-structure.md

Demonstrates how to use custom field values to dynamically set CSS properties.

```css
.message {
    font-size:{{someSlider}}px;
    color: {{someColorPicker}};
}
```

--------------------------------

### Get weather for New York City

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/weather.mdx

Example usage of the $(weather) variable for a specific US location.

```streamelements
$(weather "New York, NY")
```

--------------------------------

### Insufficient points error example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/givepoints.mdx

An example of the bot response when a user attempts to transfer more points than they possess.

```astro
<ChatExample messages={[
  { persona: 'user', usernameOverride: 'PoorViewer', message: '!givepoints RichPal 10000' },
  { persona: 'bot', message: '@PoorViewer, You only have 500 points.' }
]} />
```

--------------------------------

### Usage Example in JavaScript

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/overlays/widget-structure.md

Shows how to access field data via the onWidgetLoad event or by using internal templating variables.

```javascript
let someVariable,magicNumber;
window.addEventListener('onWidgetLoad', function (obj) {
    const {fieldData} = obj.detail;
    someVariable = fieldData["someText"];
    // OR
    magicNumber = fieldData.someNumber;
    // OR use internal templating variables
    magicNumber = parseFloat("{{someNumber}}");
});
```

--------------------------------

### Create a longer raffle with a larger reward

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/raffle.mdx

Example of starting a raffle with a 500 point reward lasting 180 seconds.

```json
{
  "persona": "moderator",
  "message": "!raffle 500 180"
},
{
  "persona": "bot",
  "message": "The Multi-Raffle for 500 points will end in 180 Seconds. Enter by typing \"!join\""
}
```

--------------------------------

### !emotecount example with channel emote

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/emotecount.mdx

Example of a user checking the count for a channel emote (channelCoolEmote) and the bot's response showing the usage count.

```streamelements
!emotecount channelCoolEmote
```

```streamelements
@User, The emote channelCoolEmote has been used 452 times! PogChamp
```

--------------------------------

### Ban Users with Regex Example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/nukeusername.mdx

Ban users whose usernames match a regex pattern (e.g., starts with "troll_") and chatted in the last 5 mins.

```json
{
  "persona": "broadcaster", "message": "!nukeusername 300 ban /^troll_/i" },
  { "persona": "bot", "message": "@Broadcaster, Nuked 1 users matching \"/^troll_/i\"." }
```

--------------------------------

### Example: Removing a specific song by URL

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/removesong.mdx

This example shows a moderator removing a specific song by its YouTube URL.

```json
{
  "persona": "moderator",
  "message": "!removesong https://youtu.be/dQw4w9WgXcQ"
},
{
  "persona": "bot",
  "message": "@Moderator, Rick Astley - Never Gonna Give You Up was removed from the queue."
}
```

--------------------------------

### $(customapi <url>)

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/customapi.mdx

Makes a GET request to the specified URL and displays the response in chat. The URL must be a single token without spaces; if it doesn't start with http:// or https://, http:// is prepended automatically.

```APIDOC
## $(customapi <url>)

### Description
Makes an HTTP GET request to the specified external API and displays the response in chat. The response is truncated to the first 400 bytes.

### Method
GET

### Endpoint
$(customapi <url>)

### Parameters
#### Path Parameters
- **url** (string) - Required - The API endpoint to request. Must be a single token without spaces. If it doesn't start with http:// or https://, http:// is automatically prepended.

### Request Example
$(customapi https://api.example.com/data?param1=value1&param2=value2)

### Response
#### Success Response (200)
- **response** (string) - The raw response body from the API, truncated to 400 bytes.

#### Response Example
{"id":323,"type":"general","setup":"Why did the cookie cry?","punchline":"Because his father was a wafer so long!"}

### Errors
- **invalid url <url>** - The URL could not be parsed.
- **Could not connect to remote server** - The request failed (e.g. timeout, DNS failure).
- **The remote server returned status code <status>** - The server responded with status 400 or higher.
- **The remote server did not send any data** - The response body could not be read.

### Notes
- Requests are GET only and routed through a StreamElements proxy with a 15-second timeout.
- Custom request headers cannot be set.
- Query parameters are percent-encoded and re-sorted alphabetically.
- No caching: every evaluation makes a fresh request.
- Legacy dot form supported: $(customapi.https://example.com/data).
- Alias: $(urlfetch) is identical.
```

--------------------------------

### Display top users by points

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/top.mdx

Example of using the !top command with the points parameter to show the top 5 users.

```json
<ChatExample messages={[
  { persona: 'user', message: '!top points' },
  { persona: 'bot', message: 'Top 5 ChannelPoints: 1. UserA (15000), 2. UserB (12500), 3. UserC (11000), 4. UserD (9800), 5. UserE (9500)' } // Output format may vary
]} />
```

--------------------------------

### Live stats command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/channel.mdx

A command example combining uptime, viewers, and chatters variables to display live stream statistics.

```streamelements
!cmd add !live We've been live for $(channel.uptime) with $(channel.viewers) viewers and $(channel.chatters) active chatters!
```

--------------------------------

### Random chatter examples

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/random.mdx

Examples of selecting a random chatter for shoutouts or spotlights.

```streamelements
Congratulations, $(random.chatter)! You've been selected!
Our spotlight viewer is: $(random.chatter)
```

--------------------------------

### Random emote examples

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/random.mdx

Examples of using random emotes in chat messages.

```streamelements
Here's a random emote: $(random.emote)
Let's celebrate with $(random.emote)!
```

--------------------------------

### Development CLI Commands

Source: https://github.com/streamelements/docs/blob/master/README.md

Standard commands for managing the local development environment, including installation, running the dev server, and building for production.

```sh
npm install
npm run dev      # dev server at localhost:4321
npm run build    # production build (also validates all internal links)
npm run preview  # preview the production build
```

--------------------------------

### Reloading all emote caches example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/emotes.mdx

Example of a moderator reloading all emote caches.

```json
{
  "persona": "moderator", "message": "!emotes reload" 
},
{
  "persona": "bot", "message": "@Moderator, successfully updated emotes :)" 
}
```

--------------------------------

### Example of checking another user's watch time

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/watchtime.mdx

An example interaction where a user checks the watch time of another specific viewer.

```astro
<ChatExample messages={[
  { persona: 'user', message: '!watchtime LoyalViewer' },
  { persona: 'bot', message: 'LoyalViewer has spent 1 day 5 hours and 30 minutes watching StreamerName!' } // Format may vary
]} />
```

--------------------------------

### Contextual response example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/ai.mdx

Example of using the AI variable to provide a persona-based response.

```streamelements
!command add !aifact ${ai You are a knowledgeable historian. Tell me an interesting fact about ${1:}}
```

--------------------------------

### Include query parameters

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/customapi.mdx

Example of appending multiple query parameters to the API URL.

```streamelements
$(customapi https://api.example.com/data?param1=value1&param2=value2)
```

--------------------------------

### Disable a chat timer example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/timer.mdx

Example of a broadcaster disabling a timer named upcomingEvent.

```json
{
  "persona": "broadcaster", "message": "!timer disable upcomingEvent" },
  { "persona": "bot", "message": "@Broadcaster, timer upcomingEvent has been disabled." }
]
```

--------------------------------

### Subscribe Request JSON

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/websockets/index.mdx

Example of a request to subscribe to a specific topic and room.

```json
{
  "type": "subscribe",
  "nonce": "req-001",
  "data": {
    "topic": "channel.activities",
    "room": "603abc123",
    "token": "eyJhbGc...",
    "token_type": "jwt"
  }
}
```

--------------------------------

### Allowed Tip WebSocket Event

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/websockets/topics/channel-tips-moderation.md

Example payload for a tip that has been approved by a moderator.

```json
{
    "id": "01JMFBZQVK8VCR34VDR5S29368",
    "ts": "2025-02-19T15:07:25Z",
    "type": "message",
    "topic": "channel.tips.moderation",
    "room": "5ad23dcc18fff500d78c5348",
    "data": {
        "donation": {
            "user": {
                "username": "Styler",
                "geo": "ZZ",
                "email": "styler@streamelements.com",
                "channel": "5ad23dcc18fff500d78c5348"
            },
            "message": "",
            "amount": 4.2,
            "currency": "USD",
            "paymentMethod": "scheme"
        },
        "_id": "67b5f39d07ecd4c594e60f73",
        "channel": "5ad23dcc18fff500d78c5348",
        "provider": "paypal",
        "approved": "allowed",
        "status": "success",
        "createdAt": "2025-02-19T15:07:09.302Z",
        "updatedAt": "2025-02-19T15:07:25.924Z",
        "transactionId": "2YH79902JR1691017",
        "approvedBy": "styler"
    }
}
```

--------------------------------

### Add a command with $(repeat)

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/repeat.mdx

Example of adding a command that repeats the word HYPE five times.

```streamelements
!command add !hype $(repeat 5 HYPE)
```

--------------------------------

### Setting a counter value

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/editcounter.mdx

Example of setting the 'wins' counter to a specific value of 10.

```javascript
{
  persona: 'broadcaster', message: '!editcounter wins 10' }, // Setting 'wins' counter
  { persona: 'bot', message: '@Broadcaster, changed the wins counter from 9 to 10.' }
```

--------------------------------

### Broadcaster usage example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/settitle.mdx

Example of a broadcaster changing the stream title via chat.

```astro
<ChatExample messages={[
  { persona: 'broadcaster', message: '!settitle Monday Variety: Minecraft, Fall Guys, and more!' },
  { persona: 'bot', message: '@Broadcaster changed the title to "Monday Variety: Minecraft, Fall Guys, and more!"' }
]} />
```

--------------------------------

### Moderator usage example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/settitle.mdx

Example of a moderator changing the stream title via chat.

```astro
<ChatExample messages={[
  { persona: 'moderator', message: '!settitle Playing Overwatch 2 with viewers!' },
  { persona: 'bot', message: '@Moderator changed the title to "Playing Overwatch 2 with viewers!"' }
]} />
```

--------------------------------

### Initiate a duel command syntax

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/duel.mdx

The basic syntax for starting a duel with a specific user and optional point wager.

```streamelements
!duel <username> [points]
```

--------------------------------

### Successful point transfer example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/givepoints.mdx

An example of a successful transfer of 500 points between users.

```astro
<ChatExample messages={[
  { persona: 'user', usernameOverride: 'GenerousViewer', message: '!givepoints LuckyFriend 500' },
  { persona: 'bot', message: '@GenerousViewer -> gave 500 points to @LuckyFriend' }
]} />
```

--------------------------------

### Pending Tip WebSocket Event

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/websockets/topics/channel-tips-moderation.md

Example payload for a tip that is currently awaiting moderation review.

```json
{
    "id": "01JMFBZF7KSRDDXXV0EH7G8X6G",
    "ts": "2025-02-19T15:07:17Z",
    "type": "message",
    "topic": "channel.tips.moderation",
    "room": "5ad23dcc18fff500d78c5348",
    "data": {
        "donation": {
            "user": {
                "username": "Styler",
                "geo": "ZZ",
                "email": "styler@streamelements.com",
                "channel": "5ad23dcc18fff500d78c5348"
            },
            "message": "",
            "amount": 4.2,
            "currency": "USD",
            "paymentMethod": "scheme"
        },
        "_id": "67b5f39d07ecd4c594e60f73",
        "channel": "5ad23dcc18fff500d78c5348",
        "provider": "paypal",
        "approved": "pending",
        "status": "success",
        "createdAt": "2025-02-19T15:07:09.302Z",
        "updatedAt": "2025-02-19T15:07:17.099Z",
        "transactionId": "2YH79902JR1691017"
    }
}
```

--------------------------------

### Add a time command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/time.mdx

Example of adding a command to display the current time in a specific timezone.

```streamelements
!command add !time It's currently $(time America/New_York) for the streamer
```

--------------------------------

### Display default leaderboard

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/top.mdx

Example of using the !top command without parameters, which defaults to the points leaderboard.

```json
<ChatExample messages={[
  { persona: 'user', message: '!top' }, // Defaults to the points leaderboard
  { persona: 'bot', message: 'Top 5 ChannelPoints: 1. UserA (15000), 2. UserB (12500), 3. UserC (11000), 4. UserD (9800), 5. UserE (9500)' } // Output format may vary
]} />
```

--------------------------------

### Self-duel error example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/duel.mdx

An example showing the bot response when a user attempts to duel themselves.

```javascript
<ChatExample messages={[
  { persona: 'user', message: '!duel SelfUser 50' },
  { persona: 'bot', message: '@SelfUser, you cannot duel yourself Kappa' }
]} />
```

--------------------------------

### Random number range examples

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/random.mdx

Practical examples of using random number ranges in chat.

```streamelements
The dice roll is: $(random.1-6)
Your lucky number is: $(random.number 1-100)
```

--------------------------------

### !queue join command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/queue.mdx

Allows a viewer to enter the open queue.

```json
<ChatExample messages={[
  { persona: 'user', message: '!queue join' },
  { persona: 'bot', message: '@User, you have been added to the queue in position #5.' }
]} />
```

--------------------------------

### Example of checking own watch time

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/watchtime.mdx

An example interaction where a user checks their own accumulated watch time.

```astro
<ChatExample messages={[
  { persona: 'user', message: '!watchtime' },
  { persona: 'bot', message: '@User has spent 2 hours and 15 minutes watching StreamerName!' } // Format may vary
]} />
```

--------------------------------

### Usage Example in HTML

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/overlays/widget-structure.md

Demonstrates how to inject custom field values directly into HTML elements using double curly braces.

```html
<div class="message">{{someDropdown}} is an option for today!<span id="additional">{{someText}}</span></div>
```

--------------------------------

### Example of failed !skip command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/skip.mdx

Shows the interaction when a user without permission attempts to use the command.

```json
<ChatExample messages={[
  { persona: 'user', message: '!skip' }, // User tries to skip (assuming default permissions)
  { persona: 'bot', message: '@User, you do not have permission to use that command.' } // Or "no song is currently playing."
]} />
```

--------------------------------

### Example: Moderator setting game to Fortnite

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/setgame.mdx

Shows a moderator triggering the command and the bot confirming the change.

```json
{
  "persona": "moderator",
  "message": "!setgame Fortnite"
},
{
  "persona": "bot",
  "message": "@Moderator changed the game to \"Fortnite\"!"
}
```

--------------------------------

### Non-existent user error example

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/givepoints.mdx

An example of the bot response when the recipient username cannot be found in the database.

```astro
<ChatExample messages={[
  { persona: 'user', usernameOverride: 'Viewer', message: '!givepoints NonExistentUser 10' },
  { persona: 'bot', message: '@Viewer, I couldn\'t find that user in the database :/' }
]} />
```

--------------------------------

### Example of placing a bet with percentage

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/bet.mdx

A viewer places a bet using a percentage of their total points.

```json
{
  "persona": "user",
  "usernameOverride": "PercentBetta",
  "message": "!bet optionA 25%"
},
{
  "persona": "bot",
  "message": "@PercentBetta, you have bet 750 points on optionA."
}
```

--------------------------------

### Show command syntax

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/command.mdx

Syntax for displaying details of a command.

```streamelements
!command show !<command_name>
```

--------------------------------

### Add !askai command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/ai.mdx

Example of creating a command that uses the $(ai) variable to respond to user input.

```streamelements
!command add !askai $(ai $(1:))
```

--------------------------------

### Start Bingo with Twitch emotes

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/modules/bingo.md

Starts a game using only Twitch emotes with a 100 point reward.

```streamelements
!bingo twitch 100
```

--------------------------------

### Example of placing a bet with shorthand notation

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/bet.mdx

A viewer places a bet of 5000 points using the 'k' shorthand.

```json
{
  "persona": "user",
  "usernameOverride": "HighRoller",
  "message": "!bet lose 5k"
},
{
  "persona": "bot",
  "message": "@HighRoller, you have bet 5000 points on Lose."
}
```

--------------------------------

### 8ball chat interaction example 1

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/modules/eightball.mdx

An example of a viewer asking a question and receiving a positive response from the bot.

```astro
<ChatExample messages={[
  { persona: 'user', message: '!8ball Will I win my next game?' },
  { persona: 'bot', message: 'The 8ball says: It is certain.' }
]} />
```

--------------------------------

### Create a YouTube search command

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/queryescape.mdx

This command demonstrates using $(queryescape) to format a YouTube search query from user input.

```streamelements
!command add !yt https://www.youtube.com/results?search_query=$(queryescape ${1:})
```

--------------------------------

### Syntax for $(uptime)

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/variables/uptime.mdx

The basic syntax for the uptime variable, with an optional username parameter.

```streamelements
$(uptime [username])
```

--------------------------------

### General !command syntax

Source: https://github.com/streamelements/docs/blob/master/src/content/docs/chatbot/commands/default/command.mdx

The base syntax for invoking the command suite.

```streamelements
!command <subcommand> [arguments...]
```
Tokens:
Raw