Skip to content

Instantly share code, notes, and snippets.

@mrgarymartin

mrgarymartin/StreamLabsCloudbot.md

Created December 14, 2020 22:46
Show Gist options
  • Save mrgarymartin/40f7f1707fe6780b5cea392d4baa2358 to your computer and use it in GitHub Desktop.
Save mrgarymartin/40f7f1707fe6780b5cea392d4baa2358 to your computer and use it in GitHub Desktop.
Download ZIP
Streamlabs Cloudbot Commands updated 12/2020
Raw
StreamLabsCloudbot.md

====== Streamlabs Cloudbot 2020 Updated======

***This is a updated doc for Cloudbot. Supported by Tunerzedge.

Streamlabs Chatbot (SLCB), formerly known as AnkhBot, is a self-hosted bot solution developed by [https://twitter.com/ankhheart|AnkhHeart] for Twitch streamers with a number of unique features, as well as now officially integrates with [https://www.streamlabs.com/|Streamlabs] and its exclusive services. Not to mention the software and all of its features are completely free.

There's numerous resources for learning how to utilize the bot to its fullest potential, but this documentation is an attempt at an all in one, quick and simple source for getting started and beyond. It's also important to note that a lot of these commands use an external API, coded and provided by the user [https://decapi.me/|Decicus] that would otherwise be impossible to do with the bot alone.

==== Resources ====

==== Quickstart Commands ====

These are the most common commands that you see in other streamer's channels, and they are 100% copy and paste friendly.

This retrieves and displays all information relative to the stream, including the game title, the status, the uptime, and the amount of current viewers.

Command: !stats
Response: Game: {channel.game} | Title: {channel.title} | Uptime: {uptime} | Viewers: ${readapi.https://api.crunchprank.net/twitch/viewercount/{channel.name}}

This returns the duration of time that the stream has been live. If the stream is not live, it will return OFFLINE.

Command: !uptime
Response: {channel.name} has been live for {uptime}.

This returns the local time for the streamer.

Command: !time
Response: The time is currently $time for {channel.name}.

This returns the date for the streamer.

Command: !date
Response: The date is currently $date for {channel.name}.

This lists the top 10 users who have the most points/currency.

Command: !toppoints
Response: Top {amount} users based on points: {loyalty.toppoints}.

This lists the top 5 users who have spent the most time, based on hours, in the stream.

Command: !top5time
Response: Top {amount} Users based on hours: {loyalty.tophours}.

This returns a numerical value representing how many followers you currently have.

Command: !followers
Response: {channel.name} currently has {readapi.https://api.crunchprank.net/twitch/followcount/{channel.name}} followers.

This returns the date and time of which the user of the command followed your channel.

Command: !followed
Response: {touser.name}, you followed {channel.name} on {readapi.https://api.crunchprank.net/twitch/followed/{channel.name}/{touser.name}}.

This returns the "time ago" that the user of the command followed your channel.

Command: !following
Response: {touser.name}, you have been following {channel.name} for {readapi.https://api.crunchprank.net/twitch/followage/{channel.name}/{touser.name}?precision=3}.

This returns the date and time of when a specified Twitch account was created.

Command: !created
Response: The account for {touser.name} was created on {readapi.https://api.crunchprank.net/twitch/creation/{touser.name}}.
Example: !created crunchprank

This grabs the last 3 users that followed your channel and displays them in chat.

Command: !recentfollowers
Response: Welcome to our 3 most recent followers: {readapi.https://api.crunchprank.net/twitch/followers/{channel.name}?count=3&direction=desc}!

This displays your latest tweet in your chat and requests users to retweet it. This only works if your Twitch name and Twitter name are the same.

Command: !retweet
Response: Please retweet my recent tweet! {readapi.https://api.crunchprank.net/twitter/latest/{channel.name}?no_rts&url}

This provides an easy way to give a shout out to a specified target by providing a link to their channel in your chat.

Command: !shoutout
Response: Please go check out $targetname at $url - I love them and you should too!
Example: !shoutout crunchprank

This returns all channels that are currently hosting your channel (if you're a large streamer, use with caution).

Command: !hosting
Response: Thanks to all the users currently hosting: {readapi.https://api.crunchprank.net/twitch/hosts/{channel.name}?implode}.

These commands show the song information, direct link, and requester of both the current song and the next queued song. For users using YouTube for song requests only.

Command: !song
Response: Current song: $currentsong - https://www.youtube.com/watch?v={readapi.https://api.crunchprank.net/youtube/videoid?search=$currentsong} Requested by: $requestedby

Example: !nextsong
Response: Next song: $nextsong - https://www.youtube.com/watch?v={readapi.https://api.crunchprank.net/youtube/videoid?search=$nextsong} Requested by: $nextrequestedby

This lists all BTTV emotes for your channel.

Command: !bttv
Response: Check out all the BTTV emotes for {channel.name}! {readapi.https://api.crunchprank.net/bttv/emotes?channel={channel.name}}

This allows one user to give a specified currency amount to another user.

Command: !give
Response: $givepoints("$userid","$targetid","$num2","$username gave $value $currencyname to $targetname","fail","false")
Example: !give woahh_jess 5
Explanation: 5 points are removed from user of the command and given to woahh_jess

This gives a specified amount of points to all users currently in chat.

!points add +viewers <amount>

==== Twitch API Commands ====

The following commands take use of AnkhBot's ''$readapi'' function. Basically it echoes the text of any API query to Twitch chat. Some of these commands have optional parameters that can help you customize your query results which I have noted for each command - be sure to play around with those.

Description: Gets the time difference (also known as the "follow age" or "time ago") between when a user followed a channel. Response: {readapi.https://api.crunchprank.net/twitch/followage/CHANNEL/FOLLOWER}

  • Optional Parameters:
    • ''precision'': How precise the timestamp should be in terms of years, months, weeks, days, hours, minutes & seconds (default: 2). Example Responses: $user has been following the channel for {readapi.https://api.crunchprank.net/twitch/followage/crunchprank/$user?precision=3}. Example Output: ''yourfrienddustin has been following the channel for 1 month, 3 days, 19 hours.''

Description: Retrieves the date and time of when the user followed the channel. Response: {readapi.https://api.crunchprank.net/twitch/followed/CHANNEL/FOLLOWER}.

  • Optional Parameters:
    • ''tz'' - By default this query will output the result in UTC. However if you'd like to change the time zone, you can specify using the PHP list of all available time zones, check here. Example Responses: $user started following on {readapi.https://api.crunchprank.net/twitch/followed/crunchprank/$user?tz=America/New_York}. Example Output(s): ''yourfrienddustin started following on Jun 07. 2016 - 05:57:21 PM (America/New_York).''

Description: Retrieves the followers of a specified channel using a variety of optional parameters for customization. Response: {readapi.https://api.crunchprank.net/twitch/followers/CHANNEL}

  • Optional Parameters:
    • ''count'' - How many followers to get with the request (default: 1 | max: 100).
    • ''offset'' - How many followers to offset from the beginning of the object.
    • ''direction'' - What direction to retrieve followers in. Can either be 'asc' (oldest) or 'desc' (most recent). The default is 'desc'.
    • ''num'' - Prefixes each follower with a number. Example Responses: Everyone welcome our 3 most recent followers: {readapi.https://api.crunchprank.net/twitch/followers/crunchprank?count=3&direction=desc}. Example Output(s): ''Everyone welcome our 3 most recent followers: woahh_jess, z0mbyte, yourfrienddustin.''

Description: Retrieves the creation date and time of a user. Response: {readapi.https://api.crunchprank.net/twitch/creation/USER}.

  • Optional Parameters:
    • ''tz'' - By default this query will output the result in UTC. However if you'd like to change the time zone, you can specify using the PHP list of all available time zones, check here. Example Responses: The account for $user was created on {readapi.https://api.crunchprank.net/twitch/creation/$user?tz=America/New_York}. Example Output(s): ''The account for crunchprank was created on Dec 26. 2013 - 09:31:06 PM (America/New_York).''

Description: Retrieves the age of an account. Response: {readapi.https://api.crunchprank.net/twitch/accountage/USER}.

  • Optional Parameters:
    • ''precision'' - How precise the timestamp should be in terms of years, months, weeks, days, hours, minutes & seconds (default: 2). Example Responses: The account for $user was created {readapi.https://api.crunchprank.net/twitch/accountage/$user} ago. Example Output(s): ''The account for crunchprank was created 3 years, 4 months ago.''

Description: Retrieves the latest highlight of the specified channel. Response: {readapi.https://api.crunchprank.net/twitch/highlight/CHANNEL}. Example Output: ''"Hunter" LuL - %%https://www.twitch.tv/videos/231566911%%''

Description: Returns the latest uploaded video for the specified channel. Response: {readapi.https://api.crunchprank.net/twitch/upload/CHANNEL} Example Output(s): ''Evil @ Twitchcon 2017 - %%https://www.twitch.tv/videos/182630172%%''

Description: Returns a list of channel names hosting the specified channel. Response: {readapi.https://api.crunchprank.net/twitch/hosts/CHANNEL}

  • Optional Parameters:
    • ''display_name'' - If specified, this will use the display names instead of the usernames of the users that are hosting.
    • ''list'' - If specified, the list will be in plaintext (using newlines) instead of in a JSON object.
    • ''implode'' - If specified, the list will be returned comma-separated (", ") instead of JSON/a "newlined" list. Example Responses: Thanks to all the users currently hosting: {readapi.https://api.crunchprank.net/twitch/hosts/crunchprank?implode}. Example Output(s): ''Thanks to all the users currently hosting: woahh_jess, yourfrienddustin, z0mbyte.''

Description: Retrieves the subscriber emotes for the specified channels and lists them. Response: {readapi.https://api.crunchprank.net/twitch/subscriber_emotes/{channel.name}} Example Output(s): ''bobrossDealWithIt bobrossGold bobrossGG bobrossPal bobrossCanvasH bobrossBeli bobrossEve bobrossBush bobrossKappaR...''

Description: Retrieves the members of a specified team. Response: {readapi.https://api.crunchprank.net/twitch/team_members/TEAM}

  • Optional Parameters:
    • ''sort'' - If this is specified, it will sort the members of the team alphabetically.
    • ''implode'' - If this is specified, the list will be returned in plaintext compared to a JSON array (use a ''+'' for space). Example Responses: Make sure to check out all the members of the Next Level team: {readapi.https://api.crunchprank.net/twitch/team_members/nextlevel?implode=,+}. Example Output(s): ''Make sure to check out all the members of the Next Level team: 360chrism, fuzzyness, nospimi99, redfalcongames, chrescendo, vespher, raysfire, theno1alex.''

==== Miscellaneous Commands ====

Description: Allows a user to generate a multi-stream link. Response: http://multitwitch.tv/CHANNEL/$targetid

==== Other Service API Commands ====

The following commands take use of AnkhBot's ''$readapi'' function the same way as above, however these are for other services than Twitch.

Description: Returns the latest tweet by the specified user. Response: {readapi.https://api.crunchprank.net/twitter/latest/USERNAME}

  • Optional Parameters:
    • ''no_rts'' - If specified, retweets will not be included.
    • ''include_replies'' - FIXME If specified at all, this includes replies from the specified user to other users as well.
    • ''no_exclude_replies'' - Works similarly to include replies, except this query string cannot be specified as just empty unlike include replies.
    • ''search'' - Goes through each of the latest tweets (up to 200) and then searches with the specified string (case-insensitive). If this is not specified, it will just return the latest tweet.
    • ''strict'' - This is used together with search. If specified, it will do a case-sensitive search.
    • ''url'' - If specified, the URL of the tweet will be appended to the result.
    • ''shorten'' - Used together with url. Shortens the URL using TinyURL.
    • ''howlong'' - Includes the time since the tweet was posted. Example Responses: Retweet my latest tweet: {readapi.https://api.crunchprank.net/twitter/latest/crunchprank?url}. Example Output(s): ''yesterday i ate captain crunch, salt and vinegar chips, and pizza. today the roof of my mouth is non-existent. - %%https://twitter.com/crunchprank/status/821484732324188161%%''

Description: Searches the YouTube API with the specified string and returns the first result it can find. Response: {readapi.https://api.crunchprank.net/youtube/videoid?search=TERM}

  • Optional Parameters:
    • ''show_url'' - Prepends ''%%https://youtu.be/%%'' before the video ID to make it a proper URL. Example Output(s): ''7rs6HuJj4TE''

Description: Retrieves the latest video uploaded to the specified channel and returns the title and URL for it. Response: {readapi.https://api.crunchprank.net/youtube/latest_video?user=USER} or {readapi.https://api.crunchprank.net/youtube/latest_video?id=USERID}

  • Optional Parameters:
    • ''user'' - For users with usernames in their URL.
    • ''id'' - For users with an ID number in their URL.
    • ''skip'' - Skips the specified amount of uploads (default: 0, maximum: 50). Example Responses: Check out my latest YouTube video: {readapi.https://api.crunchprank.net/youtube/latest_video?user=devinsupertramp}. Example Output(s): ''DevinSuperTramp BIGGEST FAILS 2.0! - %%https://youtu.be/rW_NzxoNK1Y%%''

Description: Finds the first returned definition of a specified word from Urban Dictionary. Response: $msg: {readapi.http://jwd.me/twitch/api/urban-dictionary.php?q=$msg}

  • Usage: If you have this response set to the command !urban, then a user would just type ''!urban word'' to get the Urban Dictionary's definition of that word.

==== Game Specific Commands ====

The following commands are to be used for specific games to retrieve information such as player statistics.

Description: Yes this is quite a block of text, but read it thoroughly as the overall concept is rather easy to understand. This allows users to issue commands to check various Overwatch stats of an Overwatch player and comes in two flavors for you to pick from. The first Response is for a command that checks a user-inputted Overwatch player. While this allows your viewers to check any Overwatch player on any platform, it makes it so the command can be longer for the user to type, as well as has a chance to become a source of chat spam if too many people are using it. The second Response is for a command that checks a defined Overwatch player, and what I personally recommend. This allows you to use a shorter command to check the stats, and also limits the usage so that any Overwatch player isn't able to be looked up - just you (or whoever you define). Credit to [xgerhard]https://twitter.com/gerhardoh) for creating the API. You can find an entire list of the various stats you're able to look up [here]https://2g.be/twitch/Overwatch/), and further general documentation [here]https://community.nightdev.com/t/how-to-retrieve-overwatch-stats-through-nightbot/8148). Important to note, that if you're playing on PC and not in the NA/US region, you will need to explicitly give the region.

  • First Response: {readapi.https://2g.be/twitch/Overwatch/command/action=$target&bot=ankhbot&user=$username&console=$target3&channel={channel.name}&defaultconsole=pc&gamertag=$target2}
  • Usage: This response is copy/paste friendly. The user interacts via commands such as ''!overwatch action username platform''. So for example if I wanted to check my Kill/Death ratio and I play Overwatch on PC, I would issue ''!overwatch kda crunchprank-1234 pc''. If I wanted to check the same thing, but my account was in Europe, I would need to type ''!overwatch kda crunchprank-1234-eu pc''. If I played on a console such as PS4, then there's no need for a Battletag or region and would look something like this ''!overwatch kda crunhprank ps''.
  • Second Response: {readapi.https://2g.be/twitch/Overwatch/command/action=$target&format=twitch&user=$username&bot=ankhbot&console=XX&channel={channel.name}&gamertag=USERNAME-XXXX&hideBnetID}
  • Usage: This command is not copy/paste friendly but my suggested method. It requires you to make two adjustments so that it knows what user name to look up by default. So in the above response example, the parts that say ''console=XX'' and ''gamertag=USERNAME-XXXX'' will need to be changed to whatever Overwatch player you want the command to check by default for and what platform they are playing on. So if I wanted to only allow viewers to check the PC stats for ''woahh_jess'', I would make sure that those parts were changed to ''console=pc'' and ''gamertag=woahh_jess-1234''. If woahh_jess' account was in Europe, then I would change the gamertag portion to ''gamertag=woahh_jess-1234-eu''. If for PS4, I would change them to ''console=ps'' and ''gamertag=woahh_jess''. Once you have set up the response correctly, all a user would need to do is type for example ''!overwatch time'' and that would return the "time played" for the player you specified in your response.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment