Twitch Command Documentation
This page contains documentation for each of SlugBot's Twitch commands.
help
!help [command]
Use this command to get info on how to use a specific command. Use the command with no arguments to get a link to this documentation.
- Will function in DMs.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
[command]
|
command |
name of command to display information on |
Examples
!help giveme
This will display documentation on the giveme
command.
math
!math <expression>
Use this command to calculate the value of a mathematical expression
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
<expression>
|
mathematical expression |
A resolvable mathematical expression |
Examples
!math 84^2 / pi
This will get a response with the value of the expression.
slugballs
!slugballs <question>
Use this command to ask SlugBot a question, like a magic eight ball - only more rude.
- Will function in DMs.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
<question>
|
String |
The question you wish to ask SlugBot |
Examples
!slugballs Should I play dark souls?
This will make SlugBot respond with an answer to the question.
igot
!igot [ds1|ds3|er] <souls received>
Use this command to get a readout containing the estimated level of another player killed in DS1, DS3, or ER.
- Will function in DMs.
- Will function in edit.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
[ds1|ds3]
|
ds1 |
specify to calculate the soul level of a Dark Souls 1 player. |
ds3 |
specify to calculate the soul level of a Dark Souls 3 player. | |
er |
specify to calculate the rune level of an Elden Ring player. | |
<souls received>
|
Integer number |
Corresponding to the number of souls you received when killing another player. |
Examples
!igot 1919
This show the possible soul level of a player depending on their phantom type.
weaponds3
!weaponds3 [weapon name [vs ...]] [upgrade level] [str [dex [int [faith [luck]]]]]
Use this command to calculate the AR of any DS3 weapon, along with the expected damage on R1s/L1s, backstabs and ripostes.
listing up to four weapons separated by vs
will allow you to compare them. Note that the upgrade and stats need to be specified only once, and at the end.
In the case of an incomplete input, like !weapon caestus
, the missing upgrade and stat data will be collected from the build you currently have set through the !setbuild
command.
Typing out the command without a [weapon name]
argument will make SlugBot calculate the ten best weapons based on expected R1 damage for the upgrade level and stats provided. The printout for this kind of input will include reactions to toggle between various weapon classes. SlugBot will also note if any of the weapons are usable only when 2-handed.
- Will function in DMs.
- Will function in edit.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
[weapon name]
|
Dark Souls 3 weapon name |
Should include infusion type if desired. Spelling is lenient. |
null |
If no weapon name is given, info on all weapons will be given. | |
[upgrade level]
|
Weapon upgrade level |
For special weapons, UPGRADE LEVELS SHOULD BE CONVERTED TO STANDARD UPGRADE LEVEL EQUIVALENTS so weapons can be compared. In the format of '+2' |
null |
If no upgrade level is given, the upgrade level of your set build will be used. | |
[str [dex [int [faith [luck]]]]]
|
Stat levels |
List of stat levels given in order and separated by spaces or '/'s |
null |
If no stat level is given, the corresponding stat level of your set build will be used. |
Examples
!weaponds3 sharp claymore +7 16 35 10 10 10
The 1-hand/2-hand and weapon self-buff states can be toggled via appropriate reactions. The normal upgrade path input is used for special weapons; !weapon black knight sword +10 20 18 10 10 10
will print out the data for a black knight sword at an upgrade level of +5.
!weaponds3 fire dagger vs chaos dagger +3 10 10 10 10 10
This will compare the fire dagger and chaos dagger weapons at the given stats. Use the number reactions to view each of the given weapons.
roll
!roll <dice count>D<dice type>[+|- <dice count>D<dice type> [...]] [+|- modifier]
Use this command to get SlugBot to roll dice.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
<dice count>
|
Integer number |
Corresponding to the number of dice to roll |
<dice type>
|
Integer number |
Corresponding to the type of dice to roll |
[+|- modifier]
|
Integer number |
Corresponding to a value to add or subtract from the total roll |
Examples
!roll 4d6 - 2
This will roll four D6s, subtract 2, then display the outcome.
!roll 4d8 + 2d6 + 5
This will roll four D8s, add two D6s, add 5, then display the outcome.
!roll 1000
This will bet 1000sc on a dice roll against SlugBot.
weaponer
!weaponer [weapon name [vs ...]] [upgrade level] [str [dex [int [faith [luck]]]]]
Use this command to calculate the AR of any DS3 weapon, along with the expected damage on R1s/L1s, backstabs and ripostes.
listing up to four weapons separated by vs
will allow you to compare them. Note that the upgrade and stats need to be specified only once, and at the end.
In the case of an incomplete input, like !weapon caestus
, the missing upgrade and stat data will be collected from the build you currently have set through the !setbuild
command.
Typing out the command without a [weapon name]
argument will make SlugBot calculate the ten best weapons based on expected R1 damage for the upgrade level and stats provided. The printout for this kind of input will include reactions to toggle between various weapon classes. SlugBot will also note if any of the weapons are usable only when 2-handed.
- Will function in DMs.
- Will function in edit.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
[weapon name]
|
Elden Ring weapon name |
Should include infusion type if desired. Spelling is lenient. |
null |
If no weapon name is given, info on all weapons will be given. | |
[upgrade level]
|
Weapon upgrade level |
For special weapons, UPGRADE LEVELS SHOULD BE CONVERTED TO STANDARD UPGRADE LEVEL EQUIVALENTS so weapons can be compared. In the format of '+2' |
null |
If no upgrade level is given, the upgrade level of your set build will be used. | |
[str [dex [int [faith [luck]]]]]
|
Stat levels |
List of stat levels given in order and separated by spaces or '/'s |
null |
If no stat level is given, the corresponding stat level of your set build will be used. |
Examples
!weaponer sharp claymore +7 16 35 10 10 10
The 1-hand/2-hand and weapon self-buff states can be toggled via appropriate reactions. The normal upgrade path input is used for special weapons; !weapon black knight sword +10 20 18 10 10 10
will print out the data for a black knight sword at an upgrade level of +5.
!weaponer fire dagger vs chaos dagger +3 10 10 10 10 10
This will compare the fire dagger and chaos dagger weapons at the given stats. Use the number reactions to view each of the given weapons.
elo
!elo [member] [ladder name]
Use this command to view your ladder stats or the stats of another member.
- Requires permissions:
USER
Examples
!elo
This will display your own ladder stats.
!elo Aether
This will display Aether’s ladder stats.
fightclub
!fightclub (start [discord server ID] <fight club name>) | end | (remove <flightclub name>)
Use this command to start a twitch fight club. If a discord server ID is given and the fight club name matches an existing ladder name, the FC will sync the ladder.
- Requires permissions:
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
[discord server ID]
|
Discord Server ID |
ID of discord server you are a BotAdmin in. |
Examples
!fightclub start Weekend Fight club
This will start a fight club for this twitch channel.
!fightclub start 672205714047107074 DS3 Ladder
This will start a fight club for this twitch channel that will sync to an existing leaderboard in a discord server.
join
!join [in-game name]
Use this command to join a twitch fight club.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
[in-game name]
|
String |
Name of your character in-game |
Examples
!join The Balance
This will join the fight club queue with in-game name “The Balance”.
next
!next
Use this command to display the combatants for the next fight in the fight club.
- Requires permissions:
TWITCH_MOD
Examples
!next
This will reply with a message stating the next two combatants in the current fight club.
skip
!skip
Use this command to skip a member in the fight club queue. Give no arguments to skip the next player.
- Requires permissions:
TWITCH_MOD
Examples
!skip
This will skip the next player in the queue, pairing the player after with the current champion.
!skip Gabri
This will reply with a message stating the next two combatants in the current fight club.
winner
!winner <winner name>
Use this to declare a winner of a fight club fight.
- Requires permissions:
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
<winner name>
|
String |
Name of winner |
String |
Name of winner character in-game |
Examples
!winner Halvard
This will declare Halvard the winner, award points, and state the next combatant.
addquote
!addquote <quote>
Adds quote to quote list to be randomly selected by !quote.
- Requires permissions:
MODERATOR
Parameters
Parameter | Value | Description |
---|---|---|
<quote>
|
String |
Examples
!addquote Potion seller. Enough of these games.
This will add the quote to the streamer’s list of quotes.
quote
!quote [list]
Use this command to pull a random quote from the streamer’s list of quotes. add quotes to the list using !addquote.
Including the ‘list’ parameter will display all quotes with their corresponding quote number. This can only be done by moderators.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
[list]
|
list |
Optional parameter used by moderators to display a list of all quotes with their quote numbers. |
removequote
!removequote <quote number>
Use this command to remove a quote by referencing its quote number. Quote numbers can be viewed using !quote list
- Requires permissions:
MODERATOR
Parameters
Parameter | Value | Description |
---|---|---|
<quote number>
|
Number |
The quote number - displayed in the quote list. |
Examples
!removequote 1
This will remove quote with quote number ‘1’ from the list.
reminder
!reminder <add [interval period] <message> | remove <reminderId>| list>
Use this command to add/remove/list periodic reminders in twitch chat.
- Requires permissions:
ADMINISTRATOR
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
add|remove|list
|
add |
Specify that a reminder is being added. |
remove |
Specify that a reminder is being removed. must be followed by a reminder ID. | |
list |
Get a list of all reminders. | |
[interval period]
|
Number |
Number of minutes between the reminder message being sent in chat. |
<reminderId>
|
ID number |
The unique number given to each reminder. Can be viwed in the reminder list. |
Examples
!reminder add 20 remember to follow to get notified when I go live!
This will create a reminder that will be sent in chat every 20 minutes.
!reminder remove 1
This will remove the reminder with ID 1
!reminder list
This will list all reminders along with their IDs.
activate
!activate slugbot
Use this command to activate slugbot in the twitch chat the command was used in. SlugBot must first be summoned to the twitch chat using the !twitch <twitch name>
command IN A DISCORD SERVER WITH SLUGBOT PRESENT.
- Requires permissions:
TWITCH_MOD
addcommand
!addcommand <command> <response>
Used to add/edit a custom command that will respond with a specified string. alternatively regex can be used in place of a command to make SlugBot send a response message whenever the regex matches a members message.
The response can contain certain replacer flags that will be replaced will specific values when sent by slugbot.
Documentation on replacer flags can be found here
- Requires permissions:
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
<command>
|
New command string |
|
Existing command string |
Will overwrite its response | |
Regex keyword |
indicated by a string starting and ending with `/` | |
<response>
|
String |
will be displayed when the custom command is used or the regex is matched |
Examples
!addcommand flip You flipped a coin and got ${rand:heads|tails}!
This will add a command that will respond with You flipped a coin and got heads!
OR You flipped a coin and got tails!
when the command !flip
is used.
!addcommand /don't\s@\sme/ <@${id}>
This will create a regex keyword match that will respond with a discord mention whenever a message contains the string don't @ me
.
commands
!commands
Used to get a list of all custom commands in the server DMed to you.
- Requires permissions:
USER
cooldown
!cooldown [set <seconds>]
Use this command to set a cooldown period where slugbot will not respond to custom commands after one is used.
- Requires permissions:
TWITCH_MOD
deactivate
!deactivate slugbot
Use this command to deactivate slugbot in the twitch chat the command was used in.
- Requires permissions:
TWITCH_MOD
maldron
!maldron <viewer> <number>
Sneaky_Maldron’s command for SaintRiots chat.
- Requires permissions:
TWITCH_MOD
permissions
!permissions module|command <command> [setting]
Use this command to add or remove constraints on command usage.
Adding a channel constraint will mean the specified command can only be used in that channel.
Adding a role constraint will mean the specified command can only be used by members with that role. ADDING ROLE CONSTRAINTS WILL OVERRIDE DEFAULT PERMISSION REQUIREMENTS.
- Requires permissions:
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
<command>
|
slugbot command |
The name of the command you wish to set permission constraints for. |
<setting>
|
disable |
disable the command/module. |
enable |
enable the command/module. | |
user |
specify that the command can be used by all users | |
subscriber |
specify that the command can only be used by subscribers | |
moderator |
specify that the command can only be used by moderators | |
broadcaster |
specify that the command can only be used by the broadcaster |
removecommand
!removecommand <command>
Used to remove an existing custom command.
- Requires permissions:
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
<command>
|
Existing command |
Must match existing command exactly |
Existing regex keyword to remove |
Must match existing command exactly |
Examples
!removecommand ping
This will remove the custom command !ping
.
so
!so <streamer>
Shoutouts a streamer and links to their channel.
- Requires permissions:
TWITCH_MOD
Examples
!so king_necrow
This will shoutout the streamer King_Necrow and link to their channel.
uptime
!uptime
Use this command to get a response stating the amount of time the stream has been live for.
- Requires permissions:
USER
addbuild
!addbuild [build name] [soul level] [upgrade level] [link]
Used to add a build to your build list. Stating soul level
, upgrade level
and build planner link
are optional but recommended. If a soulsplanner link is suplied, any missing data will be taken from the build directly - In most cases, a build link is all that is needed.
- Will function in DMs.
- Requires permissions:
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
[build name]
|
Name of build |
Unique identifier for build. |
[soul level]
|
Soul level |
Soul level of a Dark Souls build. |
Blood level |
Blood level of a Bloodborne build. | |
[Upgrade level]
|
Upgrade level |
Weapon upgrade level of build. |
<link>
|
DS1 SoulsPlanner link |
|
DS2 SoulsPlanner link |
||
DS3 SoulsPlanner link |
All optional parameters will be filled in with the data from build planner link. | |
Bloodborne SoulsPlanner link |
Examples
!addbuild Vilhelm's Squire SL60 +7 https://soulsplanner.com/darksouls3/1381
This will add a build by the name of ‘Vilhelm’s Squire’ to the build list. If a build by the same name already exists in the list, its information will be updated with the new information stated.
!addbuild https://soulsplanner.com/darksouls3/1139
This will take the name, soul level, and upgrade level directly from the build linked.
bl
!bl
Use this command to get the name, blood level, and upgrade level of streamer’s current Bloodborne build. A build must be in the streamer’s build list and set as their current build using !addbuild and !setbuild for this command to work.
- Requires permissions:
USER
build
!build [list]
Use this command to get info on the streamer’s currently set build. Use the !setbuild command to change the current set build.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
[list]
|
list |
Optional parameter to get SlugBot to DM you a full list of the streamer's builds. |
Examples
!build
This will display info on the streamer’s currently set build.
!build list
This will make SlugBot DM you with a list of all of the streamer’s builds.
iam
!iam <member event info>
Use this command to create a notification for a Member Event (such as a dry finger run).
Provide at least a location and what you are doing there. Passwords and character names must be in quotes. If you have multiple platform roles, remember to state which one the event will be on. How you word it doesn’t matter too much. You can add extra event information by including info: "<extra info here>"
when using the command.
Use ${PREFIX}iam done
command to end the event.
- Requires permissions:
TWITCH_MOD
Examples
!iam dry fingered in the archives. soul level 81 +10. character name "The Balnace", password: "slug"
This will create a member Event notification in all member event channels, stating where you are, what you are doing, your soul level, upgrade level, character name, and password. You can update the information in the member event without having to re-enter everything again. Simply use the command again and specify your updates.
!iam now SL90 at the ringed city streets.
This will update the soul level and location, leaving everything else unchanged.
!am done
This will end the event.
removebuild
!removebuild <build id>
Used to remove a build from a your build list.
- Will function in DMs.
- Requires permissions:
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
<build id>
|
build name |
|
build ID |
Number of a build in the build list |
Examples
!removebuild Vilhelm's Squire
This will remove the build ‘Vilhelm’s Squire’ from the build list. Build name is case insensitive.
setbuild
!setbuild <build name|build number>
Use this command to set your current build from your list of added builds.
- Will function in DMs.
- Will function in edit.
- Requires permissions:
TWITCH_MOD
Parameters
Parameter | Value | Description |
---|---|---|
<build name|build number>
|
build name |
Approximate name of an added build |
build number |
Number of build in your build list |
Examples
!setbuild Knight Laran
This will set your current build to Knight Laran as long as its in your build list.
sl
!sl
Use this command to get the name, soul level, and upgrade level of streamer’s current Dark Souls build. A build must be in the streamer’s build list and set as their current build using !addbuild and !setbuild for this command to work.
- Requires permissions:
USER
whowas
!whowas <character name>
Use this command to find the owner of a character you met in-game. SlugBot will attempt to find three builds in its database with the most similar names.
- Requires permissions:
USER
Parameters
Parameter | Value | Description |
---|---|---|
<character name>
|
String |
Approximate name of a character |
Examples
!whowas Amil of the Deep
This will show three builds from SlugBots build database that most closely match the name Amil of the Deep
.
song
!song [setuser <lastFM username>]
Use this command to get the streamers currently playing song.
- Requires permissions:
USER
vip
!vip <add | remove> <twitch name>
-
- Requires permissions:
TWITCH_MOD
vipslain
!vipslain
-
- Requires permissions:
USER