Bot Command List

Matt Smith edited this page Jul 5, 2018 · 41 revisions

CouchBot Commands

Owner Commands

Approved Admin Configuration

An approved admin on your server will be able to add/remove streamers to/from the streamer lists. They WILL NOT be able to add/remove platform owner settings though.

Add Approved Admin

Command:

admin add [@DISCORD_USER_NAME]

Description:

Run this command to add a new approved admin to the server admin list.

Required Parameters
  • @DISCORD_USER_NAME - This is the user you would like to add as an approved admin for your server. Note - You must TAG the user you'd like to add with the @ symbol followed by their username.
Example Usage:

!cb admin add @dawgeth

Back to Top

Remove Approved Admin

Command:

admin remove [@DISCORD_USER_NAME]

Description:

Run this command to remove an approved admin from the server admin list.

Required Parameters
  • @DISCORD_USER_NAME - This is the user you would like to remove as an approved admin for your server. Note - You must TAG the user you'd like to add with the @ symbol followed by their username.
Example Usage:

!cb admin remove @dawgeth

Back to Top

List Approved Admins

Command:

admin list

Description:

Run this command to see a list of your servers approved admins.

Example Usage:

!cb admin list

Back to Top

Custom Commands

Use the following commands to configure custom commands.

Add Command

Command:

add [COMMAND_NAME] [COOLDOWN_IN_SECONDS] "[OUTPUT]"

Description:

Run this command to create a new custom command.

Required Parameters
  • COMMAND_NAME - What users have to type to execute the command.
  • COOLDOWN_IN_SECONDS - How many seconds between command usage.
  • OUTPUT - What is output when the command is executed. Wrap this in " and ".
Example Usage:

!cb command add !twitter 5 "Check out my twitter!"

Back to Top

Add Repeating Command

Command:

add [COMMAND_NAME] [COOLDOWN_IN_SECONDS] "[OUTPUT]" [true / false] [INTERVAL_IN_SECONDS] [#DISCORD_CHANNEL_NAME]

Description:

Run this command to create a new custom command.

Required Parameters
  • COMMAND_NAME - What users have to type to execute the command.
  • COOLDOWN_IN_SECONDS - How many seconds between command usage.
  • OUTPUT - What is output when the command is executed. Wrap this in " and ".
  • true / false - True or False. Yes or No.
  • `INTERVAL_IN_SECONDS - How many seconds between the command runs.
  • #DISCORD_CHANNEL_NAME - Channel you want the command to execute in.
Example Usage:

!cb command add !twitter 5 "Check out my twitter!" true 60 #MyTweets

Back to Top

Remove Custom Command

Command:

remove [COMMAND_NAME]

Description:

Run this command to remove a custom command.

Required Parameters
  • COMMAND_NAME - What users have to type to execute the command.
Example Usage:

!cb command remove !twitter

Back to Top

List Commands

Command:

list

Description:

Run this command to list your custom commands.

Example Usage:

!cb list

Back to Top

Channel Configuration

Use the following commands to configure where the bot will send it's messages.

Livestream Channel

Command:

channel live [#DISCORD_CHANNEL_NAME]

Description:

Run this command to set the channel that livestream notifications will be sent to.

Required Parameters
  • #DISCORD_CHANNEL_NAME - This is the channel you would like to send the notifications to. Note - Please tag the channel you'd like, starting with #.
Example Usage:

!cb channel live #live-announcements

Back to Top

Owner Livestream Channel

Command:

channel ownerlive [#DISCORD_CHANNEL_NAME]

Description:

Run this command to set the channel that owner livestream notifications will be sent to.

Required Parameters
  • #DISCORD_CHANNEL_NAME - This is the channel you would like to send the notifications to. Note - Please tag the channel you'd like, starting with #.
Example Usage:

!cb channel ownerlive #live-announcements

Back to Top

Published / VOD Channel

Command:

channel published [#DISCORD_CHANNEL_NAME]

Description:

Run this command to set the channel that published notifications will be sent to.

Required Parameters
  • #DISCORD_CHANNEL_NAME - This is the channel you would like to send the notifications to. Note - Please tag the channel you'd like, starting with #.
Example Usage:

!cb channel published #new-videos

Back to Top

Owner Published / VOD Channel

Command:

channel ownerpublished [#DISCORD_CHANNEL_NAME]

Description:

Run this command to set the channel that owner published notifications will be sent to.

Required Parameters
  • #DISCORD_CHANNEL_NAME - This is the channel you would like to send the notifications to. Note - Please tag the channel you'd like, starting with #.
Example Usage:

!cb channel ownerpublished #new-videos

Back to Top

Twitter Channel

Command:

channel twitter [#DISCORD_CHANNEL_NAME]

Description:

Run this command to set the channel that Twitter notifications will be sent to.

Required Parameters
  • #DISCORD_CHANNEL_NAME - This is the channel you would like to send the notifications to. Note - Please tag the channel you'd like, starting with #.
Example Usage:

!cb channel twitter #tweets

Back to Top

Owner Twitter Channel

Command:

channel ownertwitter [#DISCORD_CHANNEL_NAME]

Description:

Run this command to set the channel that owner Twitter notifications will be sent to.

Required Parameters
  • #DISCORD_CHANNEL_NAME - This is the channel you would like to send the notifications to. Note - Please tag the channel you'd like, starting with #.
Example Usage:

!cb channel ownertwitter #tweets

Back to Top

Greeting / Goodbye Channel

Command:

channel greetings [#DISCORD_CHANNEL_NAME]

Description:

Run this command to set the channel that greeting and goodbye notifications will be sent to.

Required Parameters
  • #DISCORD_CHANNEL_NAME - This is the channel you would like to send the notifications to. Note - Please tag the channel you'd like, starting with #.
Example Usage:

!cb channel greetings #welcome-mat

Back to Top

Clear Channel Settings

Command:

channel clear [CHANNEL_TYPE]

Description:

Run this command to clear the channel settings, whether it be a single setting, or all of them.

Required Parameters
  • #CHANNEL_TYPE - This is the specific channel you'd like cleared. Your options are:
  • live
  • ownerlive
  • published
  • ownerpublished
  • greetings
  • ownertwitchfeed
  • all
Example Usage:

!cb channel clear live

Back to Top

Allow Configuration

Use the following commands to configure what the bot is allowed to do.

Mention Role

Command:

allow mention [true / false] - Enable or Disable all platforms/types with a single command. allow mention [PLATFORM] [TYPE] [true / false] - Choose which platforms/types to enable/disable.

Description:

Run this command to allow / deny the ability for announcements to contain an @role announcement.

Required Parameters
  • true / false - True or False. Yes or No.
  • [PLATFORM] - Replace with: mixer, mobcrush, picarto, smashcast, twitch, or youtube.
  • [TYPE] - Replace with: live, published, ownerlive, or ownerpublished.
Example Usage:

!cb allow mention true

Back to Top

Thumbnails

Command:

allow thumbnails [true / false]

Description:

Run this command to allow / deny the ability for announcements to contain a thumbnail.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb allow thumbnails true

Back to Top

Live

Command:

allow live [true / false]

Description:

Run this command to allow / deny the ability for livestream announcements.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb allow live true

Back to Top

Published / VOD

Command:

allow published [true / false]

Description:

Run this command to allow / deny the ability for published / VOD announcements.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb allow published true

Back to Top

Allow Live and Published

Command:

allow all [true / false]

Description:

Run this command to allow / deny the ability for live and published / VOD announcements.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb allow all true

Back to Top

Allow Vodcast (Twitch Only)

Command:

allow vodcast [true / false]

Description:

Run this command to allow / deny the ability for Vodcast content from Twitch.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb allow vodcast true

Back to Top

Allow Stream Stats

Command:

allow streamstats [true / false]

Description:

Run this command to allow / deny the ability for stats to be posted along with your stream / publish announcements.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb allow streamstats true

Back to Top

Message Configuration

Use the following commands to configure custom message options and test them.

Live Message

Command:

message live "[Your Custom Message]"

Description:

Run this command to set a custom message to be announced when configured channels go live.

Required Parameters
  • Your Custom Message - This message has to be surrounded with quotes. You can include the following custom variables... %CHANNEL%, %TITLE%, %URL%, and %GAME%. Note, %GAME% doesn't work on YouTube. It will be replaced with "a game".
Example Usage:

!cb message live "%CHANNEL% just went live - %TITLE% - Playing %GAME% - Click to Watch: %URL%"

Back to Top

Published Message

Command:

message published "[Your Custom Message]"

Description:

Run this command to set a custom message to be announced when configured channels publish new content.

Required Parameters
  • Your Custom Message - This message has to be surrounded with quotes. You can include the following custom variables... %CHANNEL%, %TITLE%, and %URL%.
Example Usage:

!cb message published "%CHANNEL% just posted a new video - %TITLE% - Click to Watch: %URL%"

Back to Top

Offline Message

Command:

message offline "[Your Custom Message]"

Description:

Run this command to replace the default Stream Offline message that displays when a streamer goes offline. (Please note - only used if !cb config deleteoffline is set to false.)

Required Parameters
  • Your Custom Message - This message has to be surrounded with quotes.
Example Usage:

!cb message offline "This stream is now offline. Sorry you missed the fun."

Back to Top

Test Live Message

Command:

message testlive [PLATFORM]

Description:

Run this command to test your custom live message. This will display in your current channel, not the live channel you have set.

Required Parameters
  • [PLATFORM] - Replace with: mixer, mobcrush, picarto, smashcast, twitch, or youtube.
Example Usage:

!cb message testlive mixer

Back to Top

Test Published Message

Command:

message testpublished

Description:

Run this command to test your custom published message. This will display in your current channel, not the live channel you have set.

Example Usage:

!cb message testpublished

Back to Top

Greeting / Goodbye Configuration

Use the following commands to configure greeting and goodbye functionality.

Greetings

Command:

greetings [on / off]

Description:

Run this command to turn greetings on / off.

Required Parameters
  • on / off - On for on. Off for off.
Example Usage:

!cb greetings on

Back to Top

Goodbyes

Command:

goodbyes [on / off]"

Description:

Run this command to turn goodbyes on / off.

Required Parameters
  • on / off - On for on. Off for off.
Example Usage:

!cb goodbyes off

Back to Top

Greeting Message

Command:

greetings set "[Your Custom Message]"

Description:

Run this command to replace the default Greeting message.

Required Parameters
  • Your Custom Message - This message has to be surrounded with quotes. Use the variables %USER% to dynamically insert the new users name, or %NEWLINE% for a line break.
Example Usage:

!cb greetings set "Hello there, %USER%!"

Back to Top

Goodbye Message

Command:

goodbyes set "[Your Custom Message]"

Description:

Run this command to replace the default Goodbye message.

Required Parameters
  • Your Custom Message - This message has to be surrounded with quotes. Use the variables %USER% to dynamically insert the new users name, or %NEWLINE% for a line break.
Example Usage:

!cb goodbyes set "Good bye, %USER%!"

Back to Top

Test Greeting Message

Command:

greetings test

Description:

Run this command to test your Greeting message.

Example Usage:

!cb greetings test

Back to Top

Test Goodbye Message

Command:

goodbyes test

Description:

Run this command to test your Goodbye message.

Example Usage:

!cb goodbyes test

Back to Top

Misc. Configuration Options

Use the following commands to configure various other bits and bobs.

Configuration List

Command:

conflig list

Description:

Run this command to see your server configuration.

Example Usage:

!cb config list

Back to Top

Set a New Prefix

Command:

prefix [NEW PREFIX]

Description:

Run this command to replace the CouchBot Prefix (!cb).

Required Parameters
  • [NEW PREFIX] - Your new prefix.
Example Usage:

!cb prefix $

Back to Top

Toggle Text Announcements

Command:

config textannouncements [true / false]

Description:

Run this command to toggle embedded vs. text announcements.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb config textannouncements true

Back to Top

Time Zone Offset

Command:

config timezoneoffset [number]

Description:

Run this command to set your servers time zone offset.

Required Parameters
  • number - A number. Can be a negative. No decimals plz.
Example Usage:

!cb config timezoneoffset -5

Back to Top

Delete Offline Streams

Command:

config deleteoffline [true / false]

Description:

Run this command to toggle delete offline vs. change text when stream goes offline.

By default, false, if you go offline - your announcement will just be appended with text indicating the stream is over. If you set this to true, it'll (most the time) delete your stream announcement shortly after your stream goes offline.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb config deleteoffline true

Back to Top

Mention Role

Command:

config mentionrole [@DISCORD_ROLE]

Description:

Run this command to set the role that will get announced if Allow Mentions is turned on.

(By default this is @everyone)

Required Parameters
  • @DISCORD_ROLE - A Discord Role. Also can use @everyone or here (no @. Please leave the @ off for @here) for @everyone or @here.
Example Usage:

!cb config mentionrole @Subscribers

Back to Top

Published Gaming URLs

Command:

config publishedytg [true / false]

Description:

Run this command to enable YouTube Gaming links for Published / VOD YouTube Content.

Required Parameters
  • true / false - True or False. Yes or No.
Example Usage:

!cb config publishedytg true

Back to Top

Owner / Approved Admin Commands

Streamer and Content Creator Settings

These commands have to do with creator, streamers, who gets announced, etc.

List Your Creators

Command:

streamer list streamer list [PLATFORM]

Description:

Run this command to see what creators you follow / announce.

Optional Parameters
  • [PLATFORM] - Replace with: mixer, mobcrush, picarto, smashcast, twitch, youtube, or vidme.
Example Usage:

!cb streamer list youtube

Back to Top

Add a Creator

Command:

[PLATFORM] add [CHANNELID]

Description:

Run this command to add a new creator to announce.

Required Parameters
  • [PLATFORM] - Replace with: mixer, mobcrush, picarto, smashcast, twitch, youtube, or vidme.
  • [CHANNELID] - Mixer, Smashcast, Twitch, Use Channel Name. YouTube needs to use the Channel Id (24 characters, starts with UC. Can be found at http://youtube.com/account_advanced).
Example Usage:

!cb twitch add DevTheMatt

Back to Top

Remove a Creator

Command:

[PLATFORM] remove [CHANNELID]

Description:

Run this command to remove a creator.

Required Parameters
  • [PLATFORM] - Replace with: mixer, mobcrush, picarto, smashcast, twitch, youtube, or vidme.
  • [CHANNELID] - Mixer, Smashcast, Twitch, Use Channel Name. YouTube needs to use the Channel Id (24 characters, starts with UC. Can be found at http://youtube.com/account_advanced).
Example Usage:

!cb twitch remove DevTheMatt

Back to Top

Add an Owner Creator

Command:

[PLATFORM] remove [CHANNELID]

Description:

Run this command to add an owner creator. What is an owner creator? Well! So glad you asked. There can be a single owner assigned to a server. This allows you to set the Owner Channel and separate those announcements. This was implemented to allow a single creator to announce to one channel, while others are announced in another channel.

Required Parameters
  • [PLATFORM] - Replace with: mixer, mobcrush, picarto, smashcast, twitch, youtube, or vidme.
  • [CHANNELID] - Mixer, Smashcast, Twitch, Use Channel Name. YouTube needs to use the Channel Id (24 characters, starts with UC. Can be found at http://youtube.com/account_advanced).
Example Usage:

!cb twitch owner DevTheMatt

Back to Top

Remove an Owner Creator

Command:

[PLATFORM] remove [CHANNELID]

Description:

Run this command to remove an owner creator. What is an owner creator? Well! So glad you asked. There can be a single owner assigned to a server. This allows you to set the Owner Channel and separate those announcements. This was implemented to allow a single creator to announce to one channel, while others are announced in another channel.

Required Parameters
  • [PLATFORM] - Replace with: mixer, mobcrush, picarto, smashcast, twitch, youtube, or vidme.
  • [CHANNELID] - Mixer, Smashcast, Twitch, Use Channel Name. YouTube needs to use the Channel Id (24 characters, starts with UC. Can be found at http://youtube.com/account_advanced).
Example Usage:

!cb twitch resetowner

Back to Top

Announce a Creator

Command:

[PLATFORM] announce [CHANNELID]

Description:

Run this command to announce a currently live channel.

Required Parameters
  • [PLATFORM] - Replace with: mixer, mobcrush, picarto, smashcast, twitch, youtube, or vidme.
  • [CHANNELID] - Mixer, Smashcast, Twitch, Use Channel Name. YouTube needs to use the Video ID that you want announced (This can be found in the URL of the stream / video).
Example Usage:

!cb twitch announce DevTheMatt

Back to Top

Add a Twitch Team

Command:

twitch addteam [TEAMTOKEN]

Description:

Run this command to add a Twitch team.

Required Parameters
Example Usage:

!cb twitch addteam ths

Back to Top

Remove a Twitch Team

Command:

twitch removeteam [TEAMTOKEN]

Description:

Run this command to remove a Twitch team.

Required Parameters
Example Usage:

!cb twitch removeteam ths

Back to Top

Add a Twitch Game

Command:

twitch addgame "[GAMENAME]"

Description:

Run this command to add a Twitch game.

Note: Surround your game names with " and ".

Required Parameters
Example Usage:

!cb twitch addgame "League of Legends"

Back to Top

Remove a Twitch Game

Command:

twitch addgame "[GAMENAME]"

Description:

Run this command to remove a Twitch game.

Note: Surround your game names with " and ".

Required Parameters
Example Usage:

!cb twitch removegame "League of Legends"

Back to Top

List Twitch Teams Followed

Command:

twitch listteams

Description:

Run this command to list the Twitch teams you follow.

Example Usage:

!cb twitch listteams

Back to Top

List Twitch Games Followed

Command:

twitch listgames

Description:

Run this command to list the Twitch games you follow.

Example Usage:

!cb twitch listgames

Back to Top

Twitch Discover

Command:

twitch discover [DISCOVER_TYPE] [DISCORD_ROLE_NAME]

Description:

Run this command to automatically announce users that go live in your Discord, who have their Twitch profiles linked to their Discord profiles.

Required Parameters
  • [DISCOVER_TYPE] - all: All users, none: Turn it off, role: To only announce people in a specific role.
  • [DISCORD_ROLE_NAME] - The NAME (do not tag the role) of the role you want to limit the announcements for.
Example Usage:

!cb twitch discover all !cb twitch discover role TwitchStreamers

Back to Top

Twitch Live Role

Command:

twitch liverole [@DISCORD_ROLE_NAME]

Description:

Run this command to move Twitch Discover users that go live to a role.

SETUP:

Please note - this will only work if Twitch Discovery is turned on. To turn that on - !cb twitch discover all. For other Twitch Discover options - check out the #bot-commands list.

  1. Create a new role and move it to the top of the roles list.
  2. Make sure you set it so you can @Mention the role, and that the role is displayed separately when online.
  3. In the roles list, click CouchBot.
  4. Add Manage Roles to the list of permissions this role has.
  5. Move the CouchBot role above the role you created in step 1.
  6. Type !cb twitch liverole @YourNewRole
Required Parameters
  • [@DISCORD_ROLE_NAME] - The NAME (TAG the role) of the role you want to limit the announcements for.
Example Usage:

!cb twitch liverole @CurrentlyLive

Back to Top

Everyone Commands

User Commands

These commands give various information to the user.

Invite the Bot

Command:

invite

Description:

Run this command to get a DM with an invite link.

Example Usage:

!cb invite

Back to Top

Info

Command:

invite

Description:

Run this command to get a summary of information pertaining to the bot.

Example Usage:

!cb info

Back to Top

Ping

Command:

ping

Description:

Run this command to ping the bot.

Example Usage:

!cb ping

Back to Top

Lookup a YouTube Channel ID

Command:

ytidlookup "[CHANNELNAME]"

Description:

Run this command to get a DM with an invite link.

Note: Make sure to wrap your channel name with " and ".

Required Parameters
  • [CHANNELNAME] - Channel name you want to find the Channel ID for.
Example Usage:

!cb ytidlookup "Matt the Developer"

Back to Top

Whitelisted

Command:

whitelisted [DISCORD_SERVER_ID]

Description:

Check if a server is whitelisted for the Bot to use.

Required Parameters
  • [DISCORD_SERVER_ID] - ID of the server you want to check.
Example Usage:

!cb whitelisted 1234567890

Back to Top

Check Bot Permissions

Command:

permissions [#DISCORD_CHANNEL_NAME]

Description:

Check permissions for the Bot on a specific channel.

Required Parameters
  • [#DISCORD_CHANNEL_NAME] - Tag the channel you want to check the permissions of.
Example Usage:

!cb permissions #ChannelName

Back to Top

Purge Messages

Command:

purgeall

Description:

Purge messages from a channel 100 at a time.

Example Usage:

!cb purgeall

Back to Top

Purge Messages by Name

Command:

purge [@DISCORD_USER_NAME] [COUNT]

Description:

Purge messages from a channel by name / count.

Required Parameters
  • [@DISCORD_USER_NAME] - Tag the User that you want to purge the messages of.
Optional Parameters
  • [COUNT] - Number of Messages to Delete (Default: 100, Max: 100)
Example Usage:

!cb purge @MattTheDev 100

Back to Top

Create a Strawpoll

Command:

strawpoll create "[QUESTION]|[CHOICE1],[CHOICE2],[ETC]|[true / false]"

Description:

Run this command to create a Strawpoll.

Note: Make sure to wrap your creation with " and ".

Required Parameters
  • [QUESTION] - Question you want to ask.
  • [CHOICE] - List of choices separated by ,.
  • [true / false] - Allow multiple choice
Example Usage:

!cb strawpoll create "We cool?|Yep,Nope|false"

Back to Top

Check Mixer Status

Command:

mixer status

Description:

Check CouchBot's Mixer Constellation Connection

Example Usage:

!cb mixer status

Back to Top

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.