ℹ️ {argsArray}
{argsArray}Gets user input as an array.
Example Code
Your input was {argsArray}Example Output
Your input was ["Hello","world!"]Subtags
Not sure how to use BBTag? Check out the documentation:
Filter:
Simple Subtags
Subtags that require no arguments.
ℹ️ {argsLength}
{argsLength}Return the number of arguments the user provided.
Example Code
You said {argsLength} words.Example Output
You said 4 words.
ℹ️ {isCustomCommand}
{isCustomCommand}Checks if the tag is being run from within a cc. Returns a boolean (true or false)
Example Code
{if;{isCustomCommand};{dm;{userId};You have mail!};Boo, this only works in cc's}Example Output
Boo, this only works in cc'sWill be replaced by { on execution.
ℹ️ {lb}
{lb}Returns {
Example Code
This is a bracket! {lb}Example Output
This is a bracket! {
ℹ️ {rb}
{rb}Returns }
Example Code
This is a bracket! {rb}Example Output
This is a bracket! }
ℹ️ {semi}
{semi}Returns ;
Example Code
This is a semicolon! {semi}Example Output
This is a semicolon! ;
ℹ️ {tagAuthor}
{tagAuthor}Returns the user id of the tag/cc author
Example Code
This tag was created by {username;{tagAuthor}}Example Output
This tag was created by stupid cat
ℹ️ {tagAuthorizer}
{tagAuthorizer}Returns the user id of the tag/cc authorizer
Example Code
{username;{tagAuthorizer}} authorized this tag!Example Output
stupid cat authorized this tag!
ℹ️ {zws}
{zws}Returns a single zero width space (unicode 200B)
Example Code
{zws}Example Output
Miscellaneous Subtags
Miscellaneous subtags for general things.
ℹ️ {base64Decode;<text>}
{base64Decode;<text>}Converts the provided base64 to a UTF-8 string.
Example Code
{base64decode;RmFuY3kh}Example Output
Fancy!
ℹ️ {base64Encode;<text>}
{base64Encode;<text>}Converts the provided text to base64.
Example Code
{base64decode;Fancy!}Example Output
RmFuY3kh!
ℹ️ {bool;<arg1>;<evaluator>;<arg2>}
{bool;<arg1>;<evaluator>;<arg2>}Evaluates arg1 and arg2 using the evaluator and returns true or false. Valid evaluators are ==, !=, >=, >, <=, <, startswith, endswith, includes and contains
The positions of evaluator and arg1 can be swapped.
Example Code
{bool;5;<=;10}Example Output
true
ℹ️ {brainfuck;<code>;[input]}
{brainfuck;<code>;[input]}Interprets code as brainfuck, using input as the text for ,.
Example Code
{brainfuck;-[------->+<]>-.-[->+++++<]>++.+++++++..+++.[--->+<]>-----.---[->+++<]>.-[--->+<]>---.+++.------.--------.-[--->+<]>.}Example Output
Hello World!
ℹ️ {capitalize;<text>}
{capitalize;<text>}Capitalizes the first letter of text, leaves the rest of the text untouched.
Example Code
{capitalize;hello world!}
{capitalize;hELLO world}Example Output
Hello world!
HELLO world
ℹ️ {capitalize;<text>;<lower>}
{capitalize;<text>;<lower>}Capitalizes the first letter of text, and converts the rest to lowercase.
Example Code
{capitalize;hELLO WORLD;true}
{capitalize;hello WORLD;anything goes here}
{capitalize;foo BAR;}Example Output
Hello world
Hello world
Foo bar
ℹ️ {choose;<choice>;<options>...}
{choose;<choice>;<options>...}Chooses from the given options, where choice is the index of the option to select.
Example Code
I feel like eating {choose;1;cake;pie;pudding} today.Example Output
I feel like eating pie today.
ℹ️ {clean;<text>}
{clean;<text>}Removes all duplicated whitespace from text, meaning a cleaner output.
Example Code
{clean;Hello!
Im here to help}Example Output
Hello!
Im here to helpIf inputFormat is omitted or left empty, the format of color is automatically calculated, but might be inaccurate. For accuracy and known color formats use inputFormat. It converts all ways between rgb, hsl, hsv, hwb, cmyk, ansi16, hex strings, and CSS keywords (will round to closest).
ℹ️ {color;<color>;[outputFormat]}
{color;<color>;[outputFormat]}outputFormat defaults to hex if omitted or left blank.
Converts a color to outputFormat.
Example Code
{color;#4286f4;RGB}Example Output
[66,134,244]
ℹ️ {color;<color>;<outputFormat>;<inputFormat>}
{color;<color>;<outputFormat>;<inputFormat>}outputFormat defaults to hex if left blank.
Converts a color of inputFormat to outputFormat. If inputFormat is left empty, it will be automatically calculated.
Example Code
{color;[66,134,244];hex;RGB}Example Output
#4286f4
ℹ️ {comment;<anything>...}
{comment;<anything>...}Does nothing. Your code is simply ignored.
Example Code
This is a sentence. {//;This is a comment.}Example Output
This is a sentence.
ℹ️ {decancer;<text>}
{decancer;<text>}Returns the decancered version of text.
Example Code
{decancer;ḩ̸̪̓̍a̶̗̤̎́h̵͉͓͗̀ā̷̜̼̄ ̷̧̓í̴̯̎m̵͚̜̽ ̸̛̝ͅs̴͚̜̈o̴̦̗̊ ̷͎͋ȩ̵͐d̶͎̂̇g̴̲͓̀͝y̶̠̓̿}Example Output
haha im so edgy
ℹ️ {escapeBBTag;<input>...}
{escapeBBTag;<input>...}Returns input without resolving any BBTagThis effectively returns the characters {, } and ; as is, without the use of {rb}, {lb} and {semi}.
NOTE: Brackets inside code must come in pairs. A { has to be followed by a } somewhere and a } has to have a { before it
Example Code
{escapeBBTag;{set;~index;1}}Example Output
{set;~index;1}
ℹ️ {hash;<text>}
{hash;<text>}Returns the numeric hash of text, based on the unicode value of each individual character. This results in seemingly randomly generated numbers that are constant for each specific query.
NOTE: This hash isn’t a particularly robust one, it is a quick implementation that was thrown together. To use a proper hash function, specify the algorithm
Example Code
The hash of brown is {hash;brown}.Example Output
The hash of brown is 94011702.
ℹ️ {hash;<algorithm>;<text>}
{hash;<algorithm>;<text>}Performs a hash on the given text. If the text starts with buffer: then it will first be decoded as a base64 string. If it starts with text: then it will be treated as plaintext. The hash result will be returned as a hex number.
Supported algorithms are: md5, sha1, sha256, sha512, whirlpool
Example Code
{hash;sha256;brown}Example Output
The hash of brown is 5eb67f9f8409b9c3f739735633cbdf92121393d0e13bd0f464b1b2a6a15ad2dc
ℹ️ {htmlDecode;<text>...}
{htmlDecode;<text>...}Decodes html entities from text.
Example Code
{htmlDecode;<hello, world>}Example Output
<hello, world>
ℹ️ {htmlEncode;<text>}
{htmlEncode;<text>}Encodes text with escaped html entities.
Example Code
{htmlEncode;<hello, world>}Example Output
<hello, world>If evaluator and value2 are provided, value1 is evaluated against value2 using evaluator. If they are not provided, value1 is read as true or false. If the resulting value is true then the tag returns then, otherwise it returns else.
Valid evaluators are ==, !=, >=, >, <=, <, startswith, endswith, includes and contains.
ℹ️ {if;<boolean>;<then>}
{if;<boolean>;<then>}If boolean is true, return then, else do nothing.
Example Code
{if;{isCustomCommand};This is a custom command!}Example Output
This is a custom command!
ℹ️ {if;<boolean>;<then>;<else>}
{if;<boolean>;<then>;<else>}If boolean is true, return then, else execute else
Example Code
{if;{isCustomCommand};This is a custom command!;This isn't a custom command!}Example Output
This isn't a custom command!
ℹ️ {if;<value1>;<evaluator>;<value2>;<then>}
{if;<value1>;<evaluator>;<value2>;<then>}Value1 is evaluated against value2 using evaluator, if the resulting value is true then the tag returns then.
Example Code
{if;{userId};==;103347843934212096;Hi stupid cat!}Example Output
Hi stupid cat!
ℹ️ {if;<value1>;<evaluator>;<value2>;<then>;<else>}
{if;<value1>;<evaluator>;<value2>;<then>;<else>}Value1 is evaluated against value2 using evaluator, if the resulting value is true then the tag returns then, otherwise it returns else
Example Code
{if;{userId};==;103347843934212096;Hi stupid cat!;Who are you stranger?}Example Output
Who are you stranger?
ℹ️ {indexOf;<text|array>;<searchfor>;[start]}
{indexOf;<text|array>;<searchfor>;[start]}start defaults to 0 if omitted or left blank.
Finds the index of searchFor in text|array, after start. text|array can either be plain text or an array. If it’s not found, returns -1.
Example Code
The index of "o" in "hello world" is {indexof;hello world;o}Example Output
The index of "o" in "hello world" is 4
ℹ️ {length;<value>}
{length;<value>}Gives the amount of characters in value, or the number of elements if it is an array.
Example Code
What you said is {length;{args}} chars long.Example Output
What you said is 5 chars long.
ℹ️ {logic;<operator>;<values>...}
{logic;<operator>;<values>...}Accepts 1 or more boolean values (true or false) and returns the result of operator on them. Valid logic operators are &&, ||, xor, ! and ^.See {operators} for a shorter way of performing logic operations.
Example Code
{logic;&&;true;false}Example Output
false
ℹ️ {lower;<text>}
{lower;<text>}Returns text as lowercase.
Example Code
{lower;THIS WILL BECOME LOWERCASE}Example Output
this will become lowercase
ℹ️ {md5;<text>}
{md5;<text>}Converts the provided text to md5.
Example Code
{md5;Woosh whap phew!}Example Output
71d97a11f770a34d7f8cf1f1d8749d85
ℹ️ {newline;[count]}
{newline;[count]}count defaults to 1 if omitted or left blank.
Will be replaced by count newline characters (\n).
Example Code
Hello,{newline}world!Example Output
Hello,
world!
ℹ️ {==;<values>...}
{==;<values>...}Returns true if all values are equal, otherwise false
Example Code
{==;a;b;c} {==;a;b;a} {==;a;a;b} {==;a;a;a;a;a}Example Output
false false false true
ℹ️ {!=;<values>...}
{!=;<values>...}Returns true if all pairs of values are not equal
Example Code
{!=;a;b;c} {!=;a;b;a} {!=;a;a;b}Example Output
true true false
ℹ️ {>=;<values>...}
{>=;<values>...}Returns true if each value is greater than or equal to the value after it, otherwise false
Example Code
{>=;a} {>=;c;c;b;a} {>=;2;4;3;2;1} {>=;d;c;b;a}Example Output
false true false true
ℹ️ {>;<values>...}
{>;<values>...}Returns true if each value is greater than the value after it, otherwise false
Example Code
{>;a} {>;c;c;b;a} {>;2;4;3;2;1} {>;d;c;b;a}Example Output
false false false true
ℹ️ {<=;<values>...}
{<=;<values>...}Returns true if each value is less than or equal to the value after it, otherwise false
Example Code
{<=;a} {<=;a;b;c;c} {<;1;2;3;4;2} {<=;a;b;c;d}Example Output
false true false true
ℹ️ {<;<values>...}
{<;<values>...}Returns true if each value is less than the value after it, otherwise false
Example Code
{<;a} {<;a;b;c;c} {<;1;2;3;4;2} {<;a;b;c;d}Example Output
false false false true
ℹ️ {startswith;<values>...}
{startswith;<values>...}Returns true if the first value starts with all the rest. If the first value is an array then the first element must equal all the remaining values.
Example Code
{startswith;abcdefghi;a;abcd;abc} {startswith;["abc","def","ghi"];["}Example Output
true false
ℹ️ {endswith;<values>...}
{endswith;<values>...}Returns true if the first value ends with all the rest. If the first value is an array then the last element must equal all the remaining values.
Example Code
{endswith;abcdefghi;ghi;hi} {endswith;["abc","def","ghi"];"]}Example Output
true false
ℹ️ {includes;<values>...}
{includes;<values>...}Returns true if the first value contains all the rest. If the first value is an array then the array must contain all the remaining values.
Example Code
{includes;abcdefghi;abc} {includes;["abc","def","ghi"];","}Example Output
true false
ℹ️ {contains;<values>...}
{contains;<values>...}Returns true if the first value contains all the rest. If the first value is an array then the array must contain all the remaining values.
Example Code
{contains;abcdefghi;abc} {contains;["abc","def","ghi"];","}Example Output
true false
ℹ️ {&&;<values>...}
{&&;<values>...}Returns true if all of the values are true, otherwise false
Example Code
{&&;true;true} {&&;true;false;true}Example Output
true false
ℹ️ {||;<values>...}
{||;<values>...}Returns true if any of the values are true, otherwise false
Example Code
{||;false;false} {||;true;false;true}Example Output
false true
ℹ️ {xor;<values>...}
{xor;<values>...}Returns true if exactly 1 of the values are true, otherwise false
Example Code
{^;false;false} {^;true;false;true} {^;false;true;false}Example Output
false false true
ℹ️ {!;<values>...}
{!;<values>...}Inverts a boolean value. All values after the first one are ignored.
Example Code
{!;true} {!;false}Example Output
false true
ℹ️ {+;<values>...}
{+;<values>...}Returns the result from summing all the valuess together
Example Code
{+;1;2;3;4}Example Output
10
ℹ️ {-;<values>...}
{-;<values>...}Returns the result from subtracting all the values from the first
Example Code
{-;4;3;2;1}Example Output
-2
ℹ️ {*;<values>...}
{*;<values>...}Returns the result from multiplying all the values together
Example Code
{*;1;2;3;4}Example Output
24
ℹ️ {/;<values>...}
{/;<values>...}Returns the result from dividing the first value by all the rest
Example Code
{/;5} {/;120;5;4;3}Example Output
5 2
ℹ️ {%;<values>...}
{%;<values>...}Returns the remainder after dividing each pair of values.
Example Code
{%;24;5} {%;24;5;3} {%;19;5;4}Example Output
4 1 0
ℹ️ {^;<values>...}
{^;<values>...}Returns the result of raising the first value to the power of all the rest
Example Code
{^;2;3} {^;2;2;2;2}Example Output
8 256
ℹ️ {??;<values>...}
{??;<values>...}Returns the first non-empty value given.
Example Code
{??;abc;;123} {??;;;;
;def;aaaa}Example Output
abc def
ℹ️ {pad;<direction>;<back>;<text>}
{pad;<direction>;<back>;<text>}Places text on top of back with it being aligned to the opposite of direction. If text is longer than back then it will simply overlap
Example Code
{pad;left;000000;ABC}Example Output
000ABC
ℹ️ {randomChoose;<choiceArray>}
{randomChoose;<choiceArray>}Picks one random entry from choiceArray.
Example Code
I feel like eating {randomChoose;["pie", "cake", "pudding"]} todayExample Output
I feel like eating pie today
ℹ️ {randomChoose;<choices>...}
{randomChoose;<choices>...}Picks one random entry from choices
Example Code
I feel like eating {randomChoose;cake;pie;pudding} todayExample Output
I feel like eating pudding today.
ℹ️ {randomString;<chars>;<length>}
{randomString;<chars>;<length>}Creates a random string with characters from chars that is length characters long.
Example Code
{randomString;abcdefghijklmnopqrstuvwxyz;9}Example Output
kgzyqcvda
ℹ️ {realPad;<text>;<length>}
{realPad;<text>;<length>}Pads text using space until it has length characters. Spaces are added on the right side.
Example Code
{realPad;Hello;10} world!Example Output
Hello world!
ℹ️ {realPad;<text>;<length>;<filler>;[direction]}
{realPad;<text>;<length>;<filler>;[direction]}filler defaults to if left blank.direction defaults to right if omitted or left blank.
Pads text using filler until it has length characters. filler is applied to the direction of text.
Example Code
{realPad;ABC;6;0;left}Example Output
000ABCAny bbtag in regex will not be resolved. Please consider using {apply} for a dynamic regex. regex will only succeed to compile if it is deemed a safe regular expression (safe regexes do not run in exponential time for any input)
ℹ️ {regexReplace;<regex>;<replaceWith>}
{regexReplace;<regex>;<replaceWith>}regex can at most be 50000 characters long
Replaces the regex phrase with replaceWith. This is executed on the output of the containing tag.
Example Code
I like to eat cheese. {regexReplace;/cheese/;pie}Example Output
I like to eat pie.
ℹ️ {regexReplace;<text>;<regex>;<replaceWith>}
{regexReplace;<text>;<regex>;<replaceWith>}regex can at most be 50000 characters long
Replace the regex phrase with replaceWith. This is executed on text.
Example Code
I like {regexReplace;to consume;/o/gi;a} cheese. {regexReplace;/e/gi;n}Example Output
I likn ta cansumn chnnsn.
ℹ️ {regexSplit;<text>;<regex>}
{regexSplit;<text>;<regex>}regex can at most be 50000 characters long
Splits the given text using the given regex as the split rule. Any bbtag in regex will not be resolved. Please consider using {apply} for a dynamic regex. regex will only succeed to compile if it is deemed a safe regular expression (safe regexes do not run in exponential time for any input)
Example Code
{regexSplit;Hello there, I am hungry;/[\s,]+/}Example Output
["Hello","there","I","am","hungry"]
ℹ️ {regexTest;<text>;<regex>}
{regexTest;<text>;<regex>}regex can at most be 50000 characters long
Tests if the regex phrase matches the text, and returns a boolean (true/false). Any bbtag in regex will not be resolved. Please consider using {apply} for a dynamic regex. regex will only succeed to compile if it is deemed a safe regular expression (safe regexes do not run in exponential time for any input)
Example Code
{regexTest;apple;/p+/i} {regexTest;banana;/p+/i}Example Output
true false
ℹ️ {replace;<phrase>;<replaceWith>}
{replace;<phrase>;<replaceWith>}Replaces the first occurrence of phrase with replaceWith. This is executed on the output from the containing tag.
Example Code
Hello world! {replace;Hello;Bye}Example Output
Bye world!
ℹ️ {replace;<text>;<phrase>;<replaceWith>}
{replace;<text>;<phrase>;<replaceWith>}Replaces the first occurrence of phrase in text with replaceWith.
Example Code
I like {replace;to eat;eat;nom} cheese. {replace;cheese;ham}Example Output
I like to nom ham. ham
ℹ️ {reverse;<text>}
{reverse;<text>}Reverses the order of text. If text is an array, the array will be reversed. If {get} is used with an array, this will modify the original array.
Example Code
{reverse;palindrome}Example Output
emordnilap
ℹ️ {space;[count]}
{space;[count]}count defaults to 1 if omitted or left blank.
Will be replaced by count spaces. If count is less than 0, no spaces will be returned.
Example Code
Hello,{space;4}world!Example Output
Hello, world!
ℹ️ {substring;<text>;<start>;[end]}
{substring;<text>;<start>;[end]}Returns all text from text between the start and end. end defaults to the length of text.
Example Code
Hello {substring;world;2;3}!Example Output
Hello r!
ℹ️ {switch;<value>;(<case>;<then>)...;[default]}
{switch;<value>;(<case>;<then>)...;[default]}Compares value against each case and executes the first then that matches. If no matches are found, default is executed. Each case can optionally be an array to allow matching against multiple values.
Example Code
{switch;{args;0};
hi;Hello!;
["punch","bop","hit"];Got it, i'll hit {args;1} for you!;
I don't know how to do that!
}Example Output
Got it, i'll hit Danny for you!If you provide time, you should also provide parseFormat to ensure it is being interpreted correctly.
See the moment documentation for more format information.
See here for parsing documentation. See here for a list of timezone codes.
ℹ️ {time;[format];[time];[parseFormat];[fromTimezone];[toTimezone]}
{time;[format];[time];[parseFormat];[fromTimezone];[toTimezone]}format defaults to YYYY-MM-DDTHH:mm:ssZ if omitted or left blank.time defaults to now if omitted or left blank.fromTimezone defaults to Etc/UTC if omitted or left blank.toTimezone defaults to Etc/UTC if omitted or left blank.
time is in fromTimezone and converted to toTimezone using format.
Example Code
Berlin (as toTimezone): {time;HH:mm;;;;Europe/Berlin}
Berlin from UTC 12:00: {time;HH:mm;12:00;HH:mm;;Europe/Berlin}
Berlin (as fromTimezone): {time;HH:mm;;;Europe/Berlin}
Berlin (as fromTimezone and empty toTimezone): {time;HH:mm;;;Europe/Berlin;}
New York from Berlin (12:00 in Berlin): {time;HH:mm;12:00;HH:mm;Europe/Berlin;America/New_York}Example Output
Time Berlin (as toTimezone): 23:33
Berlin from UTC 12:00: 13:00
Berlin (as fromTimezone): 23:33
Berlin (as fromTimezone and empty toTimezone): 21:33
New York from Berlin (12:00 in Berlin): 06:00
ℹ️ {trim;<text>}
{trim;<text>}Trims whitespace and newlines before and after text.
Example Code
Hello {trim;{space;10}beautiful{space;10}} WorldExample Output
Hello beautiful World
ℹ️ {unindent;<text>;[level]}
{unindent;<text>;[level]}Unindents text (or code!). If no level is provided, attempts to guess the indentation level past the first line.
Example Code
```
{unindent;
hello
world
}
```Example Output
```
hello
world
```
ℹ️ {upper;<text>}
{upper;<text>}Returns text as uppercase.
Example Code
{upper;this will become uppercase}Example Output
THIS WILL BECOME UPPERCASE
ℹ️ {uriDecode;<text>}
{uriDecode;<text>}Decodes text from URI format.
Example Code
{uriDecode;Hello%20world}Example Output
Hello world!
ℹ️ {uriEncode;<text>}
{uriEncode;<text>}Encodes text in URI format. Useful for constructing links.
Example Code
{uriEncode;Hello world!}Example Output
Hello%20world!
ℹ️ {void;<code>...}
{void;<code>...}Executes code but does not return the output from it. Useful for silent functionality
Example Code
{void;This won't be output!}Example Output
Array Subtags
Subtags designed specifically for arrays.
ℹ️ {concat;<values>...}
{concat;<values>...}Takes values and joins them together to form a single array. If values is an array, it’s flattened into the resulting array.
Example Code
Two arrays: {concat;["this", "is"];["an", "array"]}
Strings and an array: {concat;a;b;c;[1, 2, 3]}Example Output
Two arrays: ["this","is","an","array"]
Strings and an array: ["a","b","c", 1, 2, 3]
ℹ️ {isArray;<text>}
{isArray;<text>}Determines whether text is a valid array.
Example Code
{isarray;["array?"]} {isarray;array?}Example Output
true false
ℹ️ {join;<array>;<text>}
{join;<array>;<text>}Joins the elements of array together with text as the separator.
Example Code
{join;["this", "is", "an", "array"];!}Example Output
this!is!an!array
ℹ️ {map;<variable>;<array>;<code>}
{map;<variable>;<array>;<code>}array can at most be 10000000 characters long
Provides a way to populate an array by executing a function on each of its elements, more info here
For every element in array, a variable called variable will be set to the current element. The output of function will be the new value of the element. This will return the new array, and will not modify the original.
Example Code
{map;~item;["apples","oranges","pears"];{upper;{get;~item}}}Example Output
["APPLES","ORANGES","PEARS"]
ℹ️ {pop;<array>}
{pop;<array>}Returns the last element in array. If provided a variable, this will remove the last element from arrayas well.
Example Code
{pop;["this", "is", "an", "array"]}Example Output
array
ℹ️ {push;<array>;<values>...}
{push;<array>;<values>...}Pushes values onto the end of array. If provided a variable, this will update the original variable. Otherwise, it will simply output the new array.
Example Code
{push;["this", "is", "an"];array}Example Output
["this","is","an","array"]
ℹ️ {shift;<array>}
{shift;<array>}Returns the first element in array. If used with a variable this will remove the first element from array as well.
Example Code
{shift;["this", "is", "an", "array"]}Example Output
this
ℹ️ {shuffle}
{shuffle}Shuffles the {args} the user provided.
Example Code
{shuffle} {args;0} {args;1} {args;2}Example Output
three one two
ℹ️ {shuffle;<array>}
{shuffle;<array>}Shuffles the {args} the user provided, or the elements of array. If used with a variable this will modify the original array
Example Code
{shuffle;[1,2,3,4,5,6]}Example Output
[5,3,2,6,1,4]
ℹ️ {slice;<array>;<start>;[end]}
{slice;<array>;<start>;[end]}end defaults to 999999999999 if omitted or left blank.
Grabs elements between the zero-indexed start and end points (inclusive) from array.
Example Code
{slice;["this", "is", "an", "array"];1}Example Output
["is","an","array"]
ℹ️ {sort;<array>;[descending]}
{sort;<array>;[descending]}descending defaults to false if omitted or left blank.
Sorts the array in ascending order. If descending is provided, sorts in descending order. If provided a variable, will modify the original array.
Example Code
{sort;[3, 2, 5, 1, 4]}Example Output
[1,2,3,4,5]If used with a variable this will modify the original array.
Returns an array of removed items.
ℹ️ {splice;<array>;<start>;[deleteCount]}
{splice;<array>;<start>;[deleteCount]}deleteCount defaults to 0 if omitted or left blank.
Removes deleteCount elements from array starting at start.
Example Code
{splice;["this", "is", "an", "array"];1;1}Example Output
["is"]
ℹ️ {splice;<array>;<start>;<deleteCount>;<items>...}
{splice;<array>;<start>;<deleteCount>;<items>...}deleteCount defaults to 0 if left blank.
Removes deleteCount elements from array starting at start. Then, adds each item at that position in array. Returns the removed items.
Example Code
{set;~array;["this", "is", "an", "array"]} {splice;{get;~array};1;1;was} {get;~array}Example Output
["is"] {"v":["this","was","an","array"],"n":"~array"}
ℹ️ {split;<text>;[splitter]}
{split;<text>;[splitter]}Splits text using splitter, and the returns an array.
Example Code
{split;Hello! This is a sentence.;{space}}Example Output
["Hello!","This","is","a","sentence."]
ℹ️ {apply;<subtag>;<args>...}
{apply;<subtag>;<args>...}Executes subtag, using the args as parameters. If args is an array, it will get deconstructed to it’s individual elements.
Example Code
{apply;randomInt;[1,4]}Example Output
3
ℹ️ {regexMatch;<text>;<regex>}
{regexMatch;<text>;<regex>}regex can at most be 50000 characters long
Returns an array of everything in text that matches regex. Any bbtag in regex will not be resolved. Please consider using {apply} for a dynamic regex. regex will only succeed to compile if it is deemed a safe regular expression (safe regexes do not run in exponential time for any input)
Example Code
{regexMatch;I have $1 and 25 cents;/\d+/g}Example Output
["1", "25"]JSON Subtags
Subtags designed for JSON objects.
ℹ️ {json;[input]}
{json;[input]}input defaults to {} if omitted or left blank.
Defines a raw JSON object. Usage of subtags is disabled in input, inside input all brackets are required to match.
Example Code
{json;{
"key": "value"
}}Example Output
{
"key": "value"
}
ℹ️ {jsonClean;<input>}
{jsonClean;<input>}input defaults to {} if left blank.
Using the input as a base, cleans up the JSON file structure, parsing stringified nested objects/arrays. Will not mutate the original object.
Example Code
{jsonClean;{j;{"test":"[]"}}}Example Output
{"test":[]}
ℹ️ {jsonGet;<input>}
{jsonGet;<input>}input can at most be 10000000 characters long, and defaults to {} if left blank.
Gets a json value. Works with arrays too!input can be a JSON object, array, or string. If a string is provided, a variable with the same name will be used.
Example Code
{jsonGet;{j;{
"array": [
"zero",
{ "value": "one" },
"two"
]
}};array.1.value}Example Output
one
ℹ️ {jsonGet;<input>;<path>}
{jsonGet;<input>;<path>}input can at most be 10000000 characters long, and defaults to {} if left blank.
Navigates the path of a JSON object. Works with arrays too!input can be a JSON object, array, or string. If a string is provided, a variable with the same name will be used.path is a dot-noted series of properties.
Example Code
{jsonGet;{j;{
"array": [
"zero",
{ "value": "one" },
"two"
]
}};array.1.value}Example Output
one
ℹ️ {jsonKeys;<object>;[path]}
{jsonKeys;<object>;[path]}object can at most be 10000000 characters long, and defaults to {} if left blank.
Retrieves all keys from provided the JSON object. object can be a JSON object, array, or string. If a string is provided, a variable with the same name will be used.path is a dot-noted series of properties.
Example Code
{set;~json;{json;{"key": "value", "key2" : "value2"}}
{jsonKeys;~json}Example Output
["key","key2"]
ℹ️ {jsonSet;<input>;<path>}
{jsonSet;<input>;<path>}input defaults to {} if left blank.
Deletes the value at path. input can be a JSON object or array
Example Code
{set;~json;{json;{"key" : "value"}}}
{jsonSet;~json;key}
{get;~json}Example Output
{}
ℹ️ {jsonSet;<input>;<path>;<value>}
{jsonSet;<input>;<path>;<value>}input defaults to {} if left blank.
Using the input as a base, navigates the provided dot-notated path and assigns the value. input can be a JSON object, array, or string. If a string is provided, a variable with the same name will be used.If create is not empty, will create/convert any missing keys.
Example Code
{jsonSet;;path.to.key;value;create}Example Output
{"path":{"to":{"key":"value"}}}
ℹ️ {jsonSet;<input>;<path>;<value>;<create>}
{jsonSet;<input>;<path>;<value>;<create>}input defaults to {} if left blank.
Using the input as a base, navigates the provided dot-notated path and assigns the value. input can be a JSON object, array, or string. If a string is provided, a variable with the same name will be used.If create is not empty, will create/convert any missing keys.
Example Code
{jsonSet;;path.to.key;value;create}Example Output
{"path":{"to":{"key":"value"}}}
ℹ️ {jsonSort;<array>;<path>;[descending]}
{jsonSort;<array>;<path>;[descending]}Sorts an array of objects based on the provided path.path is a dot-noted series of properties.
If descending is provided, sorts in descending order.
If provided a variable, will modify the original array.
Example Code
{set;~array;{json;[
{"points" : 10, "name" : "Blargbot"},
{"points" : 3, "name" : "UNO"},
{"points" : 6, "name" : "Stupid cat"},
{"points" : 12, "name" : "Winner"}
]}}
{jsonStringify;{jsonSort;{slice;{get;~array};0};points};2}Example Output
[
"{\"points\":3,\"name\":\"UNO\"}",
"{\"points\":6,\"name\":\"Stupid cat\"}",
"{\"points\":10,\"name\":\"Blargbot\"}",
"{\"points\":12,\"name\":\"Winner\"}"
]
ℹ️ {jsonStringify;<input>;[indent]}
{jsonStringify;<input>;[indent]}input defaults to {} if left blank.indent defaults to 4 if omitted or left blank.
Pretty-prints the provided JSON input with the provided indent.
Example Code
{jsonStringify;["one","two","three"]}Example Output
[
"one",
"two",
"three"
]
ℹ️ {jsonValues;<object>;[path]}
{jsonValues;<object>;[path]}object can at most be 10000000 characters long, and defaults to {} if left blank.
Retrieves all values from provided the JSON object. object can be a JSON object, array, or string. If a string is provided, a variable with the same name will be used.path is a dot-noted series of properties.
Example Code
{set;~json;{json;{"key": "value", "key2" : "value2"}}
{jsonValues;~json}Example Output
["value","value2"]Math Subtags
Subtags designed for mathematical purposes.
ℹ️ {absolute;<number>}
{absolute;<number>}Gets the absolute value of number
Example Code
{absolute;-535}Example Output
535
ℹ️ {absolute;<numbers>...}
{absolute;<numbers>...}Gets the absolute value of each numbers and returns an array containing the results
Example Code
{absolute;-535;123;-42}Example Output
[535, 123, 42]
ℹ️ {base;<integer>;[origin];<radix>}
{base;<integer>;[origin];<radix>}origin defaults to 10 if omitted or left blank.
Converts integer from a base origin number into a base radix number. radix and origin must be between 2 and 36.
Example Code
{base;FF;16;10}Example Output
255
ℹ️ {decrement;<varName>}
{decrement;<varName>}Decreases varName‘s value by 1.
Example Code
{set;~counter;0} {repeat;{decrement;~counter},;10}Example Output
-1,-2,-3,-4,-5,-6,-7,-8,-9,-10
ℹ️ {decrement;<varName>;<amount>;[floor]}
{decrement;<varName>;<amount>;[floor]}amount defaults to 1 if left blank.floor defaults to true if omitted or left blank.
Decreases varName‘s value by amount. floor is a boolean, and if it is true then the value will be rounded down.
Example Code
{set;~counter;0} {repeat;{decrement;~counter;-2},;10}Example Output
-2,-4,-6,-8,-10,-12,-14,-16,-18,-20
ℹ️ {increment;<varName>}
{increment;<varName>}Increases varName‘s value by 1.
Example Code
{set;~counter;0} {repeat;{increment;~counter},;10}Example Output
1,2,3,4,5,6,7,8,9,10
ℹ️ {increment;<varName>;<amount>;[floor]}
{increment;<varName>;<amount>;[floor]}amount defaults to 1 if left blank.floor defaults to true if omitted or left blank.
Increases varName‘s value by amount. floor is a boolean, and if it is true then the value will be rounded down.
Example Code
{set;~counter;0} {repeat;{increment;~counter;-2},;10}Example Output
2,4,6,8,10,12,14,16,18,20
ℹ️ {math;<operator>;<numbers>...}
{math;<operator>;<numbers>...}Accepts multiple values and returns the result of operator on them. Valid operators are +, -, *, /, % and ^
See {operators} for a shorter way of performing numeric operations.
Example Code
2 + 3 + 6 - 2 = {math;-;{math;+;2;3;6};2}Example Output
2 + 3 + 6 - 2 = 9
ℹ️ {max;<numbers>...}
{max;<numbers>...}Returns the largest entry out of numbers. If an array is provided, it will be expanded to its individual values.
Example Code
{max;50;2;65}Example Output
65
ℹ️ {min;<numbers>...}
{min;<numbers>...}Returns the smallest entry out of numbers. If an array is provided, it will be expanded to its individual values.
Example Code
{min;50;2;65}Example Output
2If roundTo is not provided, but the number does have decimals, rounds to 3 by default. Any precision for decimals will be lost e.g: 100.000000000becomes 100 and 100.3100000000 becomes 100.31
ℹ️ {numberFormat;<number>;<roundTo>}
{numberFormat;<number>;<roundTo>}Rounds number to roundTo digits. roundTo can be left empty.
Example Code
{numberFormat;123456.789;2}
{numberFormat;123456.789;-3}
{numberFormat;100.10000;}Example Output
123456.79
123000
100.1
ℹ️ {numberFormat;<number>;<roundTo>;<decimal>;[thousands]}
{numberFormat;<number>;<roundTo>;<decimal>;[thousands]}decimal defaults to . if left blank.
Rounds number to roundTo digits. Uses decimal as the decimal separator and thousands for the thousands separator. To skip roundTo or decimal leave them empty.
Example Code
{numberFormat;3.1415;4;,}
{numberFormat;100000;;;.}Example Output
3,1415
100.000
ℹ️ {parseFloat;<number>}
{parseFloat;<number>}Returns an floating point number from text. If it wasn’t a number, returns NaN.
Example Code
{parseFloat;abcd} {parseFloat;12.34} {parseFloat;1.2cd}Example Output
NaN 12.34 1.2
ℹ️ {parseInt;<number>}
{parseInt;<number>}Returns an integer from text. If it wasn’t a number, returns NaN.
Example Code
{parseInt;abcd} {parseInt;1234} {parseInt;12cd}Example Output
NaN 1234 12
ℹ️ {randomInt;[min];<max>}
{randomInt;[min];<max>}min defaults to 0 if omitted or left blank.
Chooses a random whole number between min and max (inclusive).
Example Code
You rolled a {randomInt;1;6}.Example Output
You rolled a 5.
ℹ️ {round;<number>}
{round;<number>}Rounds number to the nearest whole number.
Example Code
{round;1.23}Example Output
1
ℹ️ {roundDown;<number>}
{roundDown;<number>}Rounds number down.
Example Code
{roundDown;1.23}Example Output
1
ℹ️ {roundUp;<number>}
{roundUp;<number>}Rounds number up.
Example Code
{roundUp;1.23}Example Output
2Loops Subtags
Subtags that iterate over arrays/strings.
ℹ️ {filter;<variable>;<array>;<code>}
{filter;<variable>;<array>;<code>}array can at most be 10000000 characters long
For every element in array, a variable called variable will be set and code will be executed. Returns a new array containing all the elements that returned the value true.
While inside the code parameter, none of the following subtags may be used: {dm}, {send}, {edit}, {delete}, {kick}, {ban}, {reactadd}, {reactremove}, {roleadd}, {rolecreate}, {roledelete}, {roleremove}, {rolesetmentionable}, {webhook}, {warn}, {modlog}, {pardon}, {embed}, {waitmessage}, {waitreact}, {sleep}
Example Code
{set;~array;apples;apple juice;grapefruit}
{filter;~element;~array;{bool;{get;~element};startswith;apple}}Example Output
["apples","apple juice"]
ℹ️ {for;<variable>;<initial>;<comparison>;<limit>;[increment];<code>}
{for;<variable>;<initial>;<comparison>;<limit>;[increment];<code>}increment defaults to 1 if omitted or left blank.
To start, variable is set to initial. Then, the tag will loop, first checking variable against limit using comparison. If the check succeeds, code will be run before variable being incremented by increment and the cycle repeating.
This is very useful for repeating an action (or similar action) a set number of times. Edits to variable inside code will be ignored
Example Code
{for;~index;0;<;10;{get;~index},}Example Output
0,1,2,3,4,5,6,7,8,9,
ℹ️ {forEach;<variable>;<array>;<code>}
{forEach;<variable>;<array>;<code>}array can at most be 10000000 characters long
For every element in array, a variable called variable will be set and then code will be run.
If element is not an array, it will iterate over each character instead.
Example Code
{set;~array;apples;oranges;c#}
{forEach;~element;~array;I like {get;~element}{newline}}Example Output
I like apples
I like oranges
I like c#
ℹ️ {repeat;<code>;<amount>}
{repeat;<code>;<amount>}Repeatedly executes code amount times.
Example Code
{repeat;e;10}Example Output
eeeeeeeeee
ℹ️ {while;<boolean>;<code>}
{while;<boolean>;<code>}This will continuously execute code for as long as boolean returns true.
Example Code
{set;~x;0}
{set;~end;false}
{while;{get;~end};
{if;{increment;~x};==;10;
{set;~end;true}
}
}
{get;~end}Example Output
10
ℹ️ {while;<value1>;<evaluator>;<value2>;<code>}
{while;<value1>;<evaluator>;<value2>;<code>}This will continuously execute code for as long as the condition returns true. The condition is as follows:
If evaluator and value2 are provided, value1 is evaluated against value2 using evaluator. Valid evaluators are ==, !=, >=, >, <=, <, startswith, endswith, includes and contains.
Example Code
{set;~x;0}
{while;{get;~x};<=;10;{increment;~x},}Example Output
1,2,3,4,5,6,7,8,9,10,11,Blargbot Subtags
Subtags that integrate with blargbot's custom functions.
ℹ️ {args}
{args}Gets the whole user input
Example Code
You said {args}Example Output
You said Hello world! BBtag is so cool
ℹ️ {args;<index>}
{args;<index>}Gets a word from the user input at the index position
Example Code
{args;1}Example Output
world!
ℹ️ {args;<start>;<end>}
{args;<start>;<end>}Gets all the words in the user input from start up to end. If end is n then all words after start will be returned
Example Code
{args;2;4}Example Output
BBtag is
ℹ️ {commandName}
{commandName}Gets the name of the current tag or custom command.
Example Code
This command is {commandName}Example Output
This command is testFor optimization reasons, variables are not stored in the database immediately when you use {set}. Instead they are cached, and will be saved to the database when the tag finishes. If you have some variables that you need to be saved to the database immediately, use this to force an update right now.
This comes at a slight performance cost, so use only when needed.variables defaults to all values accessed up to this point.{rollback} is the counterpart to this.
ℹ️ {commit}
{commit}Commit all variables
Example Code
{set;var;Hello!}
{commit}
{set;var;GoodBye!}
{rollback}
{get;var}Example Output
Hello!
ℹ️ {commit;<variables>...}
{commit;<variables>...}Commit provided variables
Example Code
{set;var;Hello!}
{commit;var}
{set;var;GoodBye!}
{rollback;var}
{get;var}Example Output
Hello!
ℹ️ {debug;<text>...}
{debug;<text>...}Adds the specified text to the debug output. This output is only shown via tag debug, ccommand debug, tag test debug and ccommand test debug.The line number is also included in the debug entry
Example Code
{debug;current value;{get;~i}}Example Output
(in debug output)[10]current value 1
ℹ️ {dump;<text>}
{dump;<text>}Dumps the provided text to a blargbot output page. These expire after 7 days.
Example Code
{dump;Hello, world!}Example Output
https://blargbot.xyz/output/1111111111111111
ℹ️ {execTag;<name>;<args>...}
{execTag;<name>;<args>...}Executes the name tag, giving it args as the input. Useful for modules.{execTag} executes the tag as if its code was in the root command.
Example Code
Let me do a tag for you. {execTag;f}Example Output
Let me do a tag for you. User#1111 has paid their respects. Total respects given: 5
ℹ️ {execCustomCommand;<name>;<args>...}
{execCustomCommand;<name>;<args>...}Executes the name custom command, giving it args as the input. Useful for modules.{execCustomCommand} executes the command as if its code was in the root command.
Example Code
Let me do a command for you. {execCustomCommand;f}Example Output
Let me do a command for you. User#1111 has paid their respects. Total respects given: 5
ℹ️ {fallback;<message>}
{fallback;<message>}Should any tag fail to parse, it will be replaced with message instead of an error.
Example Code
{fallback;This tag failed} {abc}Example Output
This tag failed
ℹ️ {fallback}
{fallback}Clears the current fallback text.
Example Code
{fallback;This tag failed} {abc} {fallback} {xyz}Example Output
This tag failed `Unknown subtag xyz`
ℹ️ {flag;<flagName>}
{flag;<flagName>}Returns the value of the specified case-sensitive flag code. Use _ to get the values without a flag.
Example Code
{flag;a} {flag;_}Example Output
world! Hello,
ℹ️ {flagsArray}
{flagsArray}Returns an array of all flags provided.
Example Code
{flagsArray}Example Output
["_","d","c"]
ℹ️ {flagSet;<flagName>}
{flagSet;<flagName>}Returns true or false, depending on whether the specified case-sensitive flag code has been set or not.
Example Code
{flagSet;a} {flagSet;_}Example Output
true false
ℹ️ {function;<name>;<code>}
{function;<name>;<code>}Defines a function called name. Functions are called in the same way as subtags, however they are prefixed with func.. While inside the code block of a function, you may use the params, paramsArray and paramsLength subtags to access the values passed to the function. These function identically to their args counterparts.
Please note that there is a recursion limit of 200 which is also shared by {execTag}, {execCustomCommand} and {inject}.
Example Code
{function;test;{paramsArray}} {func.test;1;2;3;4}Example Output
["1","2","3","4"]
ℹ️ {get;<name>}
{get;<name>}Returns the stored variable varName.
You can use a character prefix to determine the scope of your variable.
Valid scopes are: _ (Server variables), @ (Author variables), * (Global variables), ~ (Temporary variables) and no prefix (Local variables). For more information, use b!t docs variable or b!cc docs variable
Example Code
{set;var1;This is local var1}
{set;~var2;This is temporary var2}
{get;var1}
{get;~var2}Example Output
This is local var1
This is temporary var2
ℹ️ {get;<name>;<index>}
{get;<name>;<index>}When variable name is an array this will return the element at index index. If index is empty the entire array will be returned. If variable is not an array it will return the whole variable.
Example Code
{set;myArray;["abc","def","ghi"]}{get;myArray;1}Example Output
def
ℹ️ {inject;<code>}
{inject;<code>}Executes any arbitrary BBTag that is within code and returns the result. Useful for making dynamic code, or as a testing tool ({inject;{args}})
Example Code
Random Number: {inject;{lb}randomInt{semi}1{semi}4{rb}}Example Output
Random Number: 3
ℹ️ {lock;<mode>;<key>;<code>}
{lock;<mode>;<key>;<code>}Provides read/write locking functionality for bbtag. This is a very advanced feature, so it is recommended that you first read about the concept of locks.
In simple terms, a lock allows commands running at the same time to cooperate and wait for each other to finish what they are doing before “releasing the lock” and letting other commands use that lock. This can be used to secure against data being edited by 2 things at the same time, which can cause inconsistencies.
There can be multiple read locks held at once or a single write lock. This means that if all your command is doing is reading some data then as long as nothing is writing to it, it will be allowed, otherwise the command will wait until it can acquire a lock.
mode must be either read or write.key can be anything. This follows the same scoping rules as variables do.code will be run once the lock is acquired
Example Code
{//;in 2 command run in quick succession}
{lock;write;key;
{void;
{send;{channelId};Start}
{send;{channelId};Middle}
{send;{channelId};End}
}
}
This order is guaranteed always. Without a lock it isn'tExample Output
Start
Middle
End
Start
Middle
End
This order is guaranteed always. Without a lock it isn'tIf moderator is not provided or left empty, it will default to blargbot.
ℹ️ {modLog;<action>;<user>;[moderator];[reason];[color]}
{modLog;<action>;<user>;[moderator];[reason];[color]}Creates a custom modLog entry with the given action and user with reason. color can be a HTML color, hex, (r,g,b) or a valid color number. .
Example Code
You did a bad! {modLog;Bad;{userId};;They did a bad;#ffffff}Example Output
You did a bad! (modLog entry with white embed colour and reason 'They did a bad!')
ℹ️ {nsfw;[message]}
{nsfw;[message]}message defaults to ❌ This contains NSFW content! Go to a NSFW channel. ❌ if omitted or left blank.
Marks the output as being NSFW, and only to be sent in NSFW channels. A requirement for any tag with NSFW content. message is the error to show
Example Code
This command is not safe! {nsfw}Example Output
This command is not safe!
ℹ️ {params}
{params}Gets the whole input given to the current function call
Example Code
{func;test;You gave the parameters `{params}`}
{func.test;Hello world!;BBtag is so cool}Example Output
You gave the parameters `Hello world! BBtag is so cool`
ℹ️ {params;<index>}
{params;<index>}Gets a parameter passed to the current function call
Example Code
{func;test;The first parameter is `{params;0}`}
{func.test;Hello world!;BBtag is so cool}Example Output
The first parameter is `Hello world!`
ℹ️ {params;<start>;<end>}
{params;<start>;<end>}Gets all the parameters given from start up to end. If end is n then all parameters after start will be returned
Example Code
{func;test;The first parameter is `{params;2;4}`}
{func.test;A;B;C;D;E;F}Example Output
C D
ℹ️ {paramsArray}
{paramsArray}Gets the parameters passed to the current function as an array
Example Code
{func.test;{paramsArray}}
{func.test;a;b;c;d}Example Output
["a","b","c","d"]
ℹ️ {paramsLength}
{paramsLength}Gets the number of parameters passed to the current function
Example Code
{func.test;{paramsLength}}
{func.test;a;b;c;d}Example Output
["a","b","c","d"]
ℹ️ {prefix}
{prefix}Gets the command prefix used to call this bbtag.
Example Code
Your prefix is {prefix}Example Output
Your prefix is b!
ℹ️ {quiet;[isQuiet]}
{quiet;[isQuiet]}isQuiet defaults to true if omitted or left blank.
Tells any subtags that rely on a quiet field to be/not be quiet based on isQuiet. isQuiet` must be a boolean
Example Code
{quiet} {userMention;cat}Example Output
cat
ℹ️ {reason;[reason]}
{reason;[reason]}Sets the reason for the next API call (ex. roleAdd, roleRemove, ban, etc.). If reason is empty the reason will be empty
Example Code
{reason;This will show up in the audit logs!}{roleAdd;111111111111}Example Output
("This will show up in the audit logs" showed up)Only certain whitelisted domains can be used for url. See here for the list.The output is a JSON object with the following structure. It is recommended to use {jsonGet} to navigate it.
{
"body": {}, // the body of the request
"status": 200, // the HTTP status code
"statusText": "OK", // the human readable translation of the status code
"date": "Thu, 1 Jan 1970 00:00:00 GMT", // the date sent in the headers
"contentType": "application/json", // the content type of the response
"url": "https://fancy.url/here" // the url that was requested
}
ℹ️ {request;<url>;[options];[data]}
{request;<url>;[options];[data]}Performs a HTTP request to url, with provided options and data.options is a JSON object with the following structure. It is recommended to use {jsonSet} to create it.
json { "method": "GET|POST|PUT|PATCH|DELETE", // defaults to GET "headers": { "key": "value" } } If the method is GET and a JSON object is provided for data, it will be formatted as query strings.
Example Code
{jGet;{request;https://example.com/update/user;{jset;;method;POST};{jset;;user;Stupid cat}};body}Example Output
Stupid cat updated!
ℹ️ {return;[force]}
{return;[force]}force defaults to true if omitted or left blank.
Stops execution of the tag and returns what has been parsed. If force is true then it will also return from any tags calling this tag.
Example Code
This will display. {return} This will not.Example Output
This will display.For optimization reasons, variables are not stored in the database immediately when you use {set}. Instead they are cached, and will be saved to the database when the tag finishes. If you have some variables that you don’t want to be changed, you can use this to revert them back to their value at the start of the tag, or the most recent {commit}.variables defaults to all values accessed up to this point.{commit} is the counterpart to this.
ℹ️ {rollback}
{rollback}Rollback all variables
Example Code
{set;var;Hello!}
{commit}
{set;var;GoodBye!}
{rollback}
{get;var}Example Output
Hello!
ℹ️ {rollback;<variables>...}
{rollback;<variables>...}Rollback provided variables
Example Code
{set;var;Hello!}
{commit;var}
{set;var;GoodBye!}
{rollback;var}
{get;var}Example Output
Hello!
ℹ️ {set;<name>}
{set;<name>}Sets the name variable to nothing.
Example Code
{set;~var;something}
{set;~var}
{get;~var}Example Output
(returns nothing)
ℹ️ {set;<name>;<value>}
{set;<name>;<value>}Stores value under name. These variables are saved between sessions. You can use a character prefix to determine the scope of your variable.
Valid scopes are: _ (Server variables), @ (Author variables), * (Global variables), ~ (Temporary variables) and no prefix (Local variables).
For performance reasons, variables are not immediately stored to the database. See {commit} and {rollback}for more information, or use b!t docs variable or b!cc docs variable
Example Code
{set;var1;This is local var1}
{set;~var2;This is temporary var2}
{get;var1}
{get;~var2}Example Output
This is local var1
This is temporary var2
ℹ️ {set;<name>;<values>...}
{set;<name>;<values>...}Stores an array under name.
When getting the array, you’ll notice it retrieved an object, In this object v is the array itself, and n is the name of the variable. If the array itself needs to be returned instead of object, in for example {jSet;;array;{get;~array}}, you can use {slice;<arrayName>;0}. In array subtags {get} will work as intended.
Example Code
{set;var3;this;is;an;array}
{get;var3}Example Output
{"v":["this","is","an","array"],"n":"var3"}
ℹ️ {sleep;<duration>}
{sleep;<duration>}Pauses the current tag for the specified amount of time. Maximum is 5 minutes
Example Code
{sleep;10s}{send;{channelId};Hi!}Example Output
(After 10s) Hi!
ℹ️ {subtagExists;<subtag>}
{subtagExists;<subtag>}Checks to see if subtag exists.
Example Code
{subtagExists;ban} {subtagExists;AllenKey}Example Output
true false
ℹ️ {suppressLookup;[value]}
{suppressLookup;[value]}value defaults to true if omitted or left blank.
Sets whether error messages in the lookup system (query canceled, nothing found) should be suppressed. value must be a boolean
Example Code
{suppressLookup}Example Output
ℹ️ {throw;[error]}
{throw;[error]}error defaults to A custom error occurred if omitted or left blank.
Throws error.
Example Code
{throw;Custom Error}Example Output
`Custom Error`
ℹ️ {timer;<code>;<duration>}
{timer;<code>;<duration>}Executes code after duration. Three timers are allowed per custom command, with no recursive timers.
Example Code
{timer;Hello!;20s}Example Output
(after 20 seconds:) Hello!Message Subtags
Subtags that interact with messages.
Only custom commands can delete other messages.
ℹ️ {delete}
{delete}Deletes the message that invoked the command
Example Code
{//;The message that triggered this will be deleted} {delete}Example Output
(the message got deleted idk how to do examples for this)
ℹ️ {delete;<messageId>}
{delete;<messageId>}Deletes the specified messageId from the current channel.
Example Code
{//;The message with id `111111111111111111` will be deleted}
{delete;111111111111111111}Example Output
(the message `111111111111111111` got deleted idk how to do examples for this)
ℹ️ {delete;<channel>;<messageId>}
{delete;<channel>;<messageId>}Deletes the specified messageId from channel channel.
Example Code
{//;The message with id `2222222222222222` from channel `1111111111111111` will be deleted}
{delete;111111111111111111;2222222222222222}Example Output
(the message `2222222222222222` from channel `1111111111111111` got deleted)text and embed can both be set to _delete to remove either the message content or embed.Please note that embed is the JSON for an embed object or an array of embed objects, don’t put {embed} there, as nothing will show. Only messages created by the bot may be edited.
ℹ️ {edit;<messageId>;<text>}
{edit;<messageId>;<text>}Edits messageId in the current channel to say text
Example Code
{edit;111111111111111111;{embedBuild;title:Hello world}}Example Output
ℹ️ {edit;<messageId>;<embed>}
{edit;<messageId>;<embed>}Edits messageId in the current channel to say embed
Example Code
{edit;111111111111111111;{embedBuild;title:Hello world}}Example Output
ℹ️ {edit;<messageId>;<text>;<embed>}
{edit;<messageId>;<text>;<embed>}Edits messageId in the current channel to say text and embed
Example Code
{edit;111111111111111111;Hello world;{embedBuild;title:Foo bar}}Example Output
ℹ️ {edit;<channel>;<messageId>;<text>}
{edit;<channel>;<messageId>;<text>}Edits messageId in channelId to say text
Example Code
{edit;111111111111111111;222222222222222222;Hello world}Example Output
ℹ️ {edit;<channel>;<messageId>;<embed>}
{edit;<channel>;<messageId>;<embed>}Edits messageId in channelId to say embed
Example Code
{edit;111111111111111111;222222222222222222;Hello world}Example Output
ℹ️ {edit;<channel>;<messageID>;<text>;<embed>}
{edit;<channel>;<messageID>;<text>;<embed>}Edits messageId in channelId to say text and embed
Example Code
{edit;111111111111111111;222222222222222222;Hello world;{embedBuild;title:Foo bar}}Example Output
ℹ️ {embed;<embed>...}
{embed;<embed>...}Takes whatever input you pass to embed and attempts to form an embed from it. embed must be a valid json embed object. Multiple embeds can be provided.
This subtag works well with {embedBuild}. If attempting to use inside of a {send}, {edit} or {dm}, you should not include {embed}, and instead just pass the content direct to {send}/{edit}/{dm}
You can find information about embeds here (embed structure) and here (embed limits) as well as a useful tool for testing embeds here
Example Code
{embed;{lb}"title":"Hello!"{rb}}Example Output
(an embed with "Hello!" as the title)This tag is designed to allow you to generate embed code for {webhook} and {embed} with much less effort.
This tag uses a key/value system, with each entry in values looking like key:value.
Valid keys are:title, description, url, color, timestamp, footer.icon_url, footer.text, thumbnail.url, image.url, author.name, author.url, author.icon_url, fields.name, fields.value, fields.inline
You can find information about embeds here (embed structure) and here (embed limits) as well as a useful tool for testing embeds here
ℹ️ {embedBuild;<values>...}
{embedBuild;<values>...}Builds the embed json
Example Code
{embedBuild;
title:hello!;
description:I am an example embed;
fields.name:Field 1;
fields.value:This is the first field!;
fields.name:Field 2;
fields.value:This is the next field and is inline!;
fields.inline:true
}Example Output
{"title":"hello!","description":"I am an example embed","fields":[{"name":"Field 1","value":"This is the first field!"},{"name":"Field 2","value":"This is the next field and is inline!","inline":true}]}
ℹ️ {everyoneMention;[mention]}
{everyoneMention;[mention]}Returns the mention of @everyone.
This requires the disableeveryone setting to be false. If mention is set to true, @everyone will ping, else it will be silent.
Example Code
{everyoneMention}Example Output
@everyone
ℹ️ {file;<file>;<filename>}
{file;<file>;<filename>}Sets the output attachment to the provided file and filename. If file starts with buffer:, the following text will be parsed as base64 to a raw buffer - useful for uploading images.
Example Code
{file;Hello, world!;readme.txt}Example Output
(a file labeled readme.txt containing "Hello, world!")
ℹ️ {hereMention;[mention]}
{hereMention;[mention]}Returns the mention of @here.
This requires the disableeveryone setting to be false. If mention is set to true, @here will ping, else it will be silent.
Example Code
{hereMention}Example Output
@here
ℹ️ {messageAttachments}
{messageAttachments}Returns an array of attachments of the invoking message.
Example Code
You sent the attachments "{messageAttachments}"Example Output
You sent the attachments "["https://cdn.discordapp.com/attachments/1111111111111/111111111111111/thisisntreal.png"]"
ℹ️ {messageAttachments;<messageid>}
{messageAttachments;<messageid>}Returns an array of attachments of messageId in the current channel
Example Code
Someone sent a message with attachments: "{messageAttachments;1111111111111}"Example Output
Someone sent a message with attachments: "["https://cdn.discordapp.com/attachments/1111111111111/111111111111111/thisisntreal.png"]"
ℹ️ {messageAttachments;<channel>;<messageid>;[quiet]}
{messageAttachments;<channel>;<messageid>;[quiet]}Returns an array of attachments of messageId from channel. If quiet is provided and channel cannot be found, this will return an empty array.
Example Code
Someone sent a message in #support with attachments: "{messageAttachments;support;1111111111111}"Example Output
Someone sent a message in #support with attachments: "["https://cdn.discordapp.com/attachments/1111111111111/111111111111111/thisisntreal.png"]"If the message is not edited, this will return the current time instead.
Note: there are plans to change this behaviour, but due to backwards-compatibility this remains unchanged.
ℹ️ {messageEditTime;[format]}
{messageEditTime;[format]}format defaults to x if omitted or left blank.
Returns the edit time of the executing message in format
Example Code
The edit timestamp of your message is "{messageEditTime}"Example Output
The edit timestamp of your message is "1628782144703"
ℹ️ {messageEditTime;<messageid>;[format]}
{messageEditTime;<messageid>;[format]}format defaults to x if omitted or left blank.
Returns the edit time of messageId in format
Example Code
The edit timestamp of message 11111111111111 is "{messageEditTime;11111111111111}Example Output
The edit timestamp of message 11111111111111 is "1628782144703"
ℹ️ {messageEditTime;<channel>;<messageid>;[format]}
{messageEditTime;<channel>;<messageid>;[format]}format defaults to x if omitted or left blank.
Returns the edit time of messageId from channel in format.
Example Code
Message 11111111111111 in #support was edited at {messageEditTime;support;11111111111111;HH:mm}Example Output
Message 11111111111111 in #support was edited at 18:09
ℹ️ {messageEmbeds}
{messageEmbeds}Returns an array of embeds of the invoking message.
Example Code
You sent an embed: "{messageEmbeds}"Example Output
You sent an embed: "[{"title":"Hello!"}]"
ℹ️ {messageEmbeds;<messageid>}
{messageEmbeds;<messageid>}Returns an array of embeds of messageId in the current channel
Example Code
Someone sent a message with embeds: "{messageEmbeds;1111111111111}"Example Output
Someone sent a message with attachments: "[{"title":"Hello!"}]"
ℹ️ {messageEmbeds;<channel>;<messageid>;[quiet]}
{messageEmbeds;<channel>;<messageid>;[quiet]}Returns an array of embeds of messageId from channel. If quiet is provided and channel cannot be found, this will return an empty array.
Example Code
Someone sent a message in #support with embeds: "{messageEmbeds;support;1111111111111}"Example Output
Someone sent a message in #support with embeds: "[{"title":"Hello!"}]"
ℹ️ {messageId}
{messageId}Returns the id of the invoking message.
Example Code
The message id was {messageId}Example Output
The message id was 111111111111111111
ℹ️ {messageReply}
{messageReply}Returns the id of the invoking message’s parent message.
Example Code
You replied to the message {messageReply}Example Output
You replied to the message 1111111111111
ℹ️ {messageReply;<messageid>}
{messageReply;<messageid>}Returns the id of the parent message of the provided message.
Example Code
Someone replied to the message {messageReply;2222222222222}Example Output
Someone replied to the message 1111111111111
ℹ️ {messageReply;<channel>;<messageid>;[quiet]}
{messageReply;<channel>;<messageid>;[quiet]}Returns the id of the parent message of the provided message.
Example Code
Someone replied to the message {messageReply;general;2222222222222}Example Output
Someone replied to the message 1111111111111
ℹ️ {messageSender}
{messageSender}Returns the id of the author of the executing message.
Example Code
That was sent by "{messageSender}"Example Output
That was sent by "1111111111111"
ℹ️ {messageSender;<messageid>}
{messageSender;<messageid>}Returns the id of the author of messageId in the current channel.
Example Code
Message 1111111111111 was sent by {messageSender;1111111111111}Example Output
Message 1111111111111 was sent by 2222222222222
ℹ️ {messageSender;<channel>;<messageid>;[quiet]}
{messageSender;<channel>;<messageid>;[quiet]}Returns the id of the author of messageId in channel. If quiet is provided and channel cannot be found, this will return nothing.
Example Code
Message 1111111111111 in #support was sent by {messageSender;support;1111111111111}Example Output
Message 1111111111111 in #support was sent by 2222222222222
ℹ️ {messageText}
{messageText}Returns the text of the executing message.
Example Code
You sent "b!t test You sent "{messageText}""`Example Output
You sent "text"
ℹ️ {messageText;<messageid>}
{messageText;<messageid>}Returns the text of messageId in the current channel.
Example Code
Message 1111111111111 contained: "{messageText;1111111111111}"Example Output
Message 1111111111111 contained: "Hello world!"
ℹ️ {messageText;<channel>;<messageid>;[quiet]}
{messageText;<channel>;<messageid>;[quiet]}Returns the text of messageId in channel. If quiet is provided and channel cannot be found, this will return nothing.
Example Code
Message 1111111111111 in #support contained: "{messageText;support;1111111111111}"Example Output
Message 1111111111111 in #support contained: "Spooky Stuff"
ℹ️ {messageTime;[format]}
{messageTime;[format]}format defaults to x if omitted or left blank.
Returns the send time of the executing message in format
Example Code
The send timestamp of your message is "{messageTime}"Example Output
The send timestamp of your message is "1628782144703"
ℹ️ {messageTime;<messageid>;[format]}
{messageTime;<messageid>;[format]}format defaults to x if omitted or left blank.
Returns the send time of messageId in format
Example Code
The send timestamp of message 11111111111111 is "{messageTime;11111111111111}Example Output
The send timestamp of message 11111111111111 is "1628782144703"
ℹ️ {messageTime;<channel>;<messageid>;[format]}
{messageTime;<channel>;<messageid>;[format]}format defaults to x if omitted or left blank.
Returns the send time of messageId from channel in format.
Example Code
Message 11111111111111 in #support was sent at {messageTime;support;11111111111111;HH:mm}Example Output
Message 11111111111111 in #support was sent at 18:09For more info about message types, visit the discord docs.
ℹ️ {messageType}
{messageType}Returns the message type of the executing message.
Example Code
{messageType}Example Output
0
ℹ️ {messageType;[channel];<messageID>}
{messageType;[channel];<messageID>}channel defaults to the current channel.
Returns the message type of messageId in channel
Example Code
{messageType;12345678912345;123465145791}
{messageType;1234567891234}Example Output
19
0
ℹ️ {output;[text]}
{output;[text]}Forces an early send of the default output message, using text as the text to show. If this is used then there will be no output sent once the tag finishes. Only 1 {output} may be used per tag/cc. If a second {output} is used then the result of the first {output} will be returned instead.
The message id of the output that was sent will be returned.
Example Code
{output;Hello!}Example Output
Hello!Please note that to be able to add a reaction, I must be on the server that you got that reaction from. If I am not, then I will return an error if you are trying to apply the reaction to another message.
ℹ️ {reactionAdd;<reactions>...}
{reactionAdd;<reactions>...}Adds reactions to the output message of this tag.
Example Code
This will have reactions! {reactionAdd;🤔;👀}Example Output
This will have reactions! (reacted with 🤔 and 👀)
ℹ️ {reactionAdd;<messageid>;<reactions>...}
{reactionAdd;<messageid>;<reactions>...}Adds reactions to messageId in the current channel.
Example Code
{reactionAdd;11111111111111111;🤔;👀}Example Output
(11111111111111111 now has reactions 🤔 and 👀)
ℹ️ {reactionAdd;<channel>;<messageid>;<reactions>...}
{reactionAdd;<channel>;<messageid>;<reactions>...}Adds reactions to messageId in channelId. channelId must be an id, use of {channelId} is advised.
Example Code
{reactionAdd;11111111111111111;22222222222222222;🤔;👀}Example Output
(22222222222222222 in 11111111111111111 now has reactions 🤔 and 👀)
ℹ️ {reaction}
{reaction}Gets the reaction that triggered {waitReaction}
Example Code
{waitReaction;11111111111111111;{bool;{reaction};==;✅}}Example Output
["111111111111111","12345678912345","3333333333333","✅"]
ℹ️ {reactionUser}
{reactionUser}Gets the user whose reaction that triggered {waitReaction}
Example Code
{waitReaction;11111111111111111;{bool;{reactionUser};==;3333333333333}}Example Output
["111111111111111","12345678912345","3333333333333","✅"]
ℹ️ {reactionList;[channel];<messageId>}
{reactionList;[channel];<messageId>}Returns an array of reactions on messageId in channelId.
Example Code
{reactionList;111111111111111111}Example Output
["🤔", "👀"]
ℹ️ {reactionList;[channel];<messageId>;<reactions>...}
{reactionList;[channel];<messageId>;<reactions>...}Returns an array of users who reacted reactions on messageId in channelId. A user only needs to react to one reaction to be included in the resulting array.
Example Code
{reactionList;111111111111111111;🤔;👀}
{reactionList;222222222222222222;111111111111111111;👀}Example Output
["278237925009784832", "134133271750639616"]
["134133271750639616"]
ℹ️ {reactionRemove;[channel];<messageId>}
{reactionRemove;[channel];<messageId>}Removes all reactions of the executing user from messageId in channel.
Example Code
{reactionRemove;12345678901234}Example Output
(removed all reactions on 12345678901234)
ℹ️ {reactionRemove;[channel];<messageId>;<reactions>...}
{reactionRemove;[channel];<messageId>;<reactions>...}Removes reactions user reacted on messageId in channel.
Example Code
{reactionRemove;12345678901234;111111111111111111;🤔}Example Output
(removed the 🤔 reaction on 12345678901234 from user 111111111111111111)
ℹ️ {reactionRemoveAll;[channel];<messageId>}
{reactionRemoveAll;[channel];<messageId>}Removes all reactions from messageId.channelId defaults to the current channel.
Example Code
{reactionRemoveAll;12345678901234;:thinking:}Example Output
(removed all the reactions)If embed is an array, multiple embeds will be added to the message payload.
ℹ️ {send;<channel>;<message>;<embed>;<fileContent>;[fileName]}
{send;<channel>;<message>;<embed>;<fileContent>;[fileName]}fileName defaults to file.txt if omitted or left blank.
Sends message and embed to channel with an attachment, and returns the message id. channel is either an id or channel mention. If fileContent starts with buffer: then the following text will be parsed as base64 to a raw buffer.
Note: embed is the JSON for an embed, don’t put the {embed} subtag there, as nothing will show
Example Code
{send;{channelId};Hello there!;{embedBuild;title:This is a cool embed};Wow, look at this text file!;test.txt}Example Output
23946728937462847243
ℹ️ {send;<channel>;<message>;<embed>}
{send;<channel>;<message>;<embed>}Sends message and embed to channel, and returns the message id. channel is either an id or channel mention.
Note: embed is the JSON for an embed, don’t put the {embed} subtag there, as nothing will show
Example Code
{send;{channelId};Hello there!;{embedBuild;title:This is a cool embed}}Example Output
349587638464585678545
ℹ️ {send;<channel>;<content>}
{send;<channel>;<content>}Sends content to channel, and returns the message id. channel is either an id or channel mention.
Note: content is the text to send or the JSON for an embed, don’t put the {embed} subtag there, as nothing will show
Example Code
{send;{channelId};{embedBuild;title:This is a cool embed}Example Output
9458678957457694324Pauses the command until one of the given users sends a message in any of the given channels. When a message is sent, condition will be run to determine if the message can be accepted. If no message has been accepted within timeout then the subtag returns Wait timed out, otherwise it returns an array containing the channel id, then the message id.
channels defaults to the current channel.users defaults to the current user.condition must return true or falsetimeout is a number of seconds. This is limited to 300
While inside the condition parameter, none of the following subtags may be used: dm, send, edit, delete, kick, ban, reactadd, reactremove, roleadd, rolecreate, roledelete, roleremove, rolesetmentionable, webhook, warn, modlog, pardon, embed, waitmessage, waitreact, sleep
Also, the current message becomes the users message that is to be checked. This means that {channelId}, {messageId}, {userId} and all related subtags will change their values.
ℹ️ {waitMessage}
{waitMessage}Pauses the command until the executing user sends a message in the current channel.
Example Code
{waitMessage}Example Output
["111111111111111","2222222222222"]
ℹ️ {waitMessage;<channelIDs>;[userIDs];[condition];[timeout]}
{waitMessage;<channelIDs>;[userIDs];[condition];[timeout]}condition defaults to true if omitted or left blank.timeout defaults to 60 if omitted or left blank.
Pauses the command until condition returns true when one of userIds sends a message in one of channelIds.
Example Code
{waitMessage;111111111111111;{userId;stupid cat};{bool;{username};startswith;stupid};50}Example Output
["111111111111111", "103347843934212096"]Pauses the command until one of the given users adds any given reaction on any of the given messages. When a reaction is added, condition will be run to determine if the reaction can be accepted. If no reaction has been accepted within timeout then the subtag returns Wait timed out, otherwise it returns an array containing the channel id, the message id, the user id and the reaction, in that order.
userIds defaults to the current user if left blank or omitted.reactions defaults to any reaction if left blank or omitted.condition must return true or falsetimeout is a number of seconds. This is limited to 300
While inside the condition parameter, none of the following subtags may be used: dm, send, edit, delete, kick, ban, reactadd, reactremove, roleadd, rolecreate, roledelete, roleremove, rolesetmentionable, webhook, warn, modlog, pardon, embed, waitmessage, waitreact, sleep
Also, the current message becomes the message the reaction was added to, and the user becomes the person who sent the message. This means that {channelId}, {messageId}, {userId} and all related subtags will change their values.
Finally, while inside the condition parameter, you can use the temporary subtag {reaction} to get the current reaction and the {reactionUser} temporary subtag to get the user who reacted.messages, users and reactions can either be single values eg: {waitReaction;1234567891234;stupid cat;🤔}, or they can be arrays eg: `{waitReaction;[“1234567891234”,”98765432219876”];stupid cat;[“🤔”]}
ℹ️ {waitReaction;<messages>;[userIDs]}
{waitReaction;<messages>;[userIDs]}Waits for any reaction on messages from the executing user or userIds if provided.
Example Code
{waitReaction;12345678912345;stupid cat}Example Output
["111111111111111","12345678912345","3333333333333","🤔"]
ℹ️ {waitReaction;<messages>;<userIDs>;<reactions>;[condition];[timeout]}
{waitReaction;<messages>;<userIDs>;<reactions>;[condition];[timeout]}condition defaults to true if omitted or left blank.timeout defaults to 60 if omitted or left blank.
Waits for any of reactions on messages from userIds, if condition returns true this will return the response array. If no reaction was matched within timeout, Wait timed out will be returned.
Example Code
{waitReaction;12345678912345;["{userId;stupid cat}","{userId;blargbot}"];["🤔", "👀"];;120}Example Output
["111111111111111","12345678912345","134133271750639616","🤔"]Please assign your webhook credentials to private variables! Do not leave them in your code.embed can be an array of embed objects.
ℹ️ {webhook;<id>;<token>}
{webhook;<id>;<token>}Executes a webhook.
Example Code
{webhook;1111111111111111;t.OK-en}Example Output
Error executing webhook: Cannot send an empty message
ℹ️ {webhook;<id>;<token>;<content>;[embed]}
{webhook;<id>;<token>;<content>;[embed]}Executes a webhook. If embed is provided it must be provided in a raw JSON format, properly escaped for BBTag. Using {json} is advised.
Example Code
{webhook;1111111111111111;t.OK-en;This is the webhook content!;{json;{"title":"This is the embed title!"}}}Example Output
(in the webhook channel) This is the webhook content! (and with an embed with the title "This is the embed title" idk how to make this example)
ℹ️ {webhook;<id>;<token>;<content>;<embed>;<username>;[avatarURL]}
{webhook;<id>;<token>;<content>;<embed>;<username>;[avatarURL]}Executes a webhook. avatarURL must be a valid URL.
Example Code
{webhook;1111111111111111;t.OK-en;Some content!;;Not blargbot;{userAvatar;blargbot}}Example Output
(in the webhook channel) Some content! (sent by "Not blargbot" with blargbot's pfp
ℹ️ {webhook;<id>;<token>;<content>;<embed>;<username>;<avatarURL>;<file>;[filename]}
{webhook;<id>;<token>;<content>;<embed>;<username>;<avatarURL>;<file>;[filename]}filename defaults to file.txt if omitted or left blank.
Executes a webhook. If file starts with buffer:, the following text will be parsed as base64 to a raw buffer.
Example Code
{webhook;1111111111111111;t.OK-en;;;;;Hello, world!;readme.txt}Example Output
(in the webhook channel a file labeled readme.txt containing "Hello, world!")Channel Subtags
Subtags that interact with channels.
ℹ️ {channelCategories}
{channelCategories}Returns an array of category ids on the current guild.
Example Code
This guild has {length;{categories}} categories.Example Output
This guild has 7 categories.
ℹ️ {channelCategory}
{channelCategory}Returns the category id of the current channel.
Example Code
{channelCategory}Example Output
111111111111111
ℹ️ {channelCategory;<channel>;[quiet]}
{channelCategory;<channel>;[quiet]}Returns the category id of the provided channel. If the provided channel is a category this returns nothing. If it cannot be found returns No channel found, or nothing if quiet is true.
Example Code
{channelCategory;cool channel}
{channelCategory;cool category}Example Output
111111111111111
(nothing is returned here)type is either text, voice, category, news or store.
ℹ️ {channelCreate;<name>;[type];[options]}
{channelCreate;<name>;[type];[options]}type defaults to text if omitted or left blank.options defaults to {} if omitted or left blank.
Creates a channel with the specified options of type type``options is a JSON object, containing any or all of the following properties:
topicnsfwparentIdreason(displayed in audit log)rateLimitPerUserbitrate(voice)userLimit(voice)
Returns the new channel’s id.
Example Code
{channelCreate;super-channel;;{json;{"parentId":"11111111111111111"}}}Example Output
22222222222222222
ℹ️ {channelDelete;<id>}
{channelDelete;<id>}Deletes the provided channel.
Example Code
{channelDelete;11111111111111111}Example Output
ℹ️ {channelEdit;<channel>;[options]}
{channelEdit;<channel>;[options]}options defaults to {} if omitted or left blank.
Edits a channel with the given information.options is a JSON object, containing any or all of the following properties:
nametopicnsfwparentIdreason(displayed in audit log)rateLimitPerUserbitrate(voice)userLimit(voice)
Returns the channel’s id.
Example Code
{channelEdit;11111111111111111;{j;{"name": "super-cool-channel"}}}Example Output
11111111111111111
ℹ️ {channelId}
{channelId}Returns the id of the current channel.
Example Code
{channelId}Example Output
111111111111111
ℹ️ {channelId;<channel>;[quiet]}
{channelId;<channel>;[quiet]}Returns the id of the given channel. If it cannot be found returns No channel found, or nothing if quiet is true.
Example Code
{channelId;cool channel}
{channelId;some channel that doesn't exist;true}Example Output
111111111111111
(nothing is returned here)
ℹ️ {channelIsCategory;<channel>;[quiet]}
{channelIsCategory;<channel>;[quiet]}Checks if channel is a category. If it cannot be found returns No channel found, or false if quiet is true.
Example Code
{channelIsCategory;cool category}
{channelIsCategory;category that doesn't exist}Example Output
true
(nothing is returned here)
ℹ️ {channelIsNsfw}
{channelIsNsfw}Checks if the current channel is a NSFW channel.
Example Code
{if;{channelIsNsfw};Spooky nsfw stuff;fluffy bunnies}Example Output
fluffy bunnies
ℹ️ {channelIsNsfw;<channel>;[quiet]}
{channelIsNsfw;<channel>;[quiet]}Checks if channel is a NSFW channel. If it cannot be found returns No channel found, or false if quiet is true.
Example Code
{channelIsNsfw;SFW Cat pics}Example Output
true
ℹ️ {channelIsText}
{channelIsText}Checks if the current channel is a text channel.
Example Code
{if;{channelIsText};Yeah you can write stuff here;How did you even call the command?}Example Output
Yeah you can write stuff here
ℹ️ {channelIsText;<channel>;[quiet]}
{channelIsText;<channel>;[quiet]}Checks if channel is a text channel. If it cannot be found returns No channel found, or false if quiet is true.
Example Code
{channelIsText;feature discussions}Example Output
true
ℹ️ {channelIsThread}
{channelIsThread}Checks if the current channel is a thread channel.
Example Code
{if;{channelIsThread};Cool, this is a thread channel!;Boo, this is a regular text channel}Example Output
Cool, this is a thread channel!
ℹ️ {channelIsThread;<channel>;[quiet]}
{channelIsThread;<channel>;[quiet]}Checks if channel is a thread channel. If it cannot be found returns No channel found, or false if quiet is true.
Example Code
{channelIsThread;blargbot podcast}Example Output
true
ℹ️ {channelIsVoice}
{channelIsVoice}Checks if the current channel is a voice channel.
Example Code
{if;{channelIsVoice};How did you even call the command?;Yeah you can write stuff here}Example Output
Yeah you can write stuff here
ℹ️ {channelIsVoice;<channel>;[quiet]}
{channelIsVoice;<channel>;[quiet]}Checks if channel is a voice channel. If it cannot be found returns No channel found, or false if quiet is true.
Example Code
{channelIsVoice;blargbot podcast}Example Output
true
ℹ️ {channelName}
{channelName}Returns the name of the current channel.
Example Code
This channel's name is {channelName}Example Output
This channel's name is test-channel
ℹ️ {channelName;<channel>;[quiet]}
{channelName;<channel>;[quiet]}Returns the name of the given channel. If it cannot be found returns No channel found, or nothing if quiet is true.
Example Code
{channelName;111111111111111}Example Output
cooler-test-channelThe position is the index per channel type (text, voice or category) in the channel list.
ℹ️ {channelPosition}
{channelPosition}Returns the position of the current channel.
Example Code
This channel is in position {channelPosition}Example Output
This channel is in position 1
ℹ️ {channelPosition;<channel>;[quiet]}
{channelPosition;<channel>;[quiet]}Returns the position of the given channel. If it cannot be found returns No channel found, or nothing if quiet is true.
Example Code
The position of test-channel is {channelPosition;test-channel}Example Output
The position of test-channel is 0
ℹ️ {channels}
{channels}Returns an array of channel ids in the current guild
Example Code
This guild has {length;{channels}} channels.Example Output
This guild has {length;{channels}} channels.
ℹ️ {channels;<category>;[quiet]}
{channels;<category>;[quiet]}Returns an array of channel ids in within the given category. If category is not a category, returns an empty array. If category cannot be found returns No channel found, or nothing if quiet is true.
Example Code
Category cat-channels has {length;{channels;cat-channels}} channels.Example Output
Category cat-channels has 6 channels.
ℹ️ {channelSetPermissions;<channel>;<type>;<memberid|roleid>}
{channelSetPermissions;<channel>;<type>;<memberid|roleid>}Deletes the permission overwrites of memberId|roleId in channel.
Returns the channel’s id.
Example Code
{channelSetPermissions;11111111111111111;member;222222222222222222}Example Output
11111111111111111
ℹ️ {channelSetPermissions;<channel>;<type>;<memberid|roleid>;<allow>;[deny]}
{channelSetPermissions;<channel>;<type>;<memberid|roleid>;<allow>;[deny]}Sets the permissions of a member or role in channeltype is either member or role, and memberId|roleId corresponds to the id of the member or role.
Provide allow and deny as numbers, which can be calculated here. Returns the channel’s id.
Example Code
{channelSetPermissions;11111111111111111;member;222222222222222222;1024;2048}Example Output
11111111111111111
ℹ️ {channelSetPosition;<channel>;<position>}
{channelSetPosition;<channel>;<position>}Moves a channel to the provided position.
Example Code
{channelSetPosition;11111111111111111;5}Example Output
Possible results: text, dm, voice, group-dm, category, news, store, news-thread, public-thread, private-thread, stage-voice
ℹ️ {channelType}
{channelType}Returns the type the current channel.
Example Code
{channelType}Example Output
text
ℹ️ {channelType;<channel>;[quiet]}
{channelType;<channel>;[quiet]}Returns the type the given channel. If it cannot be found returns No channel found, or nothing if quiet is true.
Example Code
{channelType;cool channel}
{channelType;some channel that doesn't exist;true}Example Output
voice
(nothing is returned here)Returns nothing if the channel doesn’t have any messages.
ℹ️ {lastMessageId}
{lastMessageId}Returns the messageId of the last message in the current channel.
Example Code
{lastMessageId}Example Output
1111111111111111
ℹ️ {lastMessageId;<channel>}
{lastMessageId;<channel>}Returns the messageId of the last message in channel.
Example Code
{lastMessageId;1111111111111111}Example Output
2222222222222222
ℹ️ {slowMode}
{slowMode}Removes slow mode for the current channel.
Example Code
{slowMode}Example Output
(slow mode is now disabled)
ℹ️ {slowMode;<channel>}
{slowMode;<channel>}Removes slow mode for the given channel
Example Code
{slowMode;testing-grounds}Example Output
(disabled slow mode in testing-grounds)
ℹ️ {slowMode;<time>}
{slowMode;<time>}Enables slow mode in the current channel and set the cooldown to time.
Example Code
{slowMode;10}Example Output
(set slow mode to 10 seconds)
ℹ️ {slowMode;<channel>;<time>}
{slowMode;<channel>;<time>}time defaults to 0 if left blank.
Enables slow mode in channel and set the cooldown to time.
Example Code
{slowMode;testing-grounds;10}
{slowMode;50;doesn't matter}Example Output
(set slow mode cooldown to 10 seconds in testing-grounds)
(set slow mode to 50s in the current channel)User Subtags
Subtags that interact with users.
daysToDelete is the number of days to delete messages for. duration
ℹ️ {ban;<user>;[daysToDelete]}
{ban;<user>;[daysToDelete]}daysToDelete defaults to 1 if omitted or left blank.
Bans user. If the ban is successful true will be returned, else it will return an error.
Example Code
{ban;Stupid cat;4}Example Output
true
ℹ️ {ban;<user>;<daysToDelete>;<reason>;[timeToUnban]}
{ban;<user>;<daysToDelete>;<reason>;[timeToUnban]}daysToDelete defaults to 1 if left blank.
Bans user for duration timeToUnban with reason.
Example Code
{ban;Stupid cat;;Not clicking enough kittens;30d}Example Output
true (stupid cat will be unbanned after 30d)
ℹ️ {ban;<user>;<daysToDelete>;<reason>;<timeToUnban>;<noPerms>}
{ban;<user>;<daysToDelete>;<reason>;<timeToUnban>;<noPerms>}daysToDelete defaults to 1 if left blank.
Bans user for duration timeToUnban with reason. If noPerms is provided and not an empty string, do not check if the command executor is actually able to ban people.Only provide this if you know what you’re doing.
Example Code
{ban;Stupid cat;;For being stupid;;anythingcangohere}Example Output
true (anyone can use this cc regardless of perms)
ℹ️ {dm;<user>;<message>}
{dm;<user>;<message>}DMs user the given message. You may only send one DM per execution. Requires author to be staff, and the user to be on the current guild.
Example Code
{dm;stupid cat;Hello;{embedBuild;title:You're cool}}Example Output
DM: Hello
Embed: You're cool
ℹ️ {dm;<user>;<embed>}
{dm;<user>;<embed>}DMs user the given embed. You may only send one DM per execution. Requires author to be staff, and the user to be on the current guild.
Please note that embed is the JSON for an embed object, don’t put the {embed} subtag there, as nothing will show.
Example Code
{dm;stupid cat;Hello;{embedBuild;title:You're cool}}Example Output
DM: Hello
Embed: You're cool
ℹ️ {dm;<user>;<message>;<embed>}
{dm;<user>;<message>;<embed>}DMs user the given message and embed. You may only send one DM per execution. Requires author to be staff, and the user to be on the current guild.
Please note that embed is the JSON for an embed object, don’t put the {embed} subtag there, as nothing will show.
Example Code
{dm;stupid cat;Hello;{embedBuild;title:You're cool}}Example Output
DM: Hello
Embed: You're cool
ℹ️ {isStaff}
{isStaff}Checks if the tag author is staff
Example Code
{if;{isStaff};The author is a staff member!;The author is not a staff member :(}Example Output
The author is a staff member!
ℹ️ {isStaff;<user>;[quiet]}
{isStaff;<user>;[quiet]}Checks if user is a member of staff. If the user cannot be found false will be returned.
Example Code
{if;{isStaff;{userId}};You are a staff member!;You are not a staff member :(}Example Output
You are not a staff member :(
ℹ️ {isUserBoosting}
{isUserBoosting}Returns true if the executing user is boosting the guild and false if not.
Example Code
{if;{isUserBoosting};Yes you are boosting;You should consider boosting}Example Output
You should consider boosting
ℹ️ {isUserBoosting;<user>;[quiet]}
{isUserBoosting;<user>;[quiet]}Returns true if the user is boosting the guild and false if not. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
{if;{isUserBoosting;stupid cat};stupid cat is boosting!; no boosting here :(}Example Output
stupid cat is boosting!If the kick is successful, Success will be returned, otherwise the error will be given.
ℹ️ {kick;<user>}
{kick;<user>}Kicks user.
Example Code
{kick;stupid cat} @stupid cat was kicked!Example Output
Success @stupid cat was kicked!
ℹ️ {kick;<user>;<reason>;[noPerms]}
{kick;<user>;<reason>;[noPerms]}Kicks user. If noPerms is provided and not an empty string, do not check if the command executor is actually able to kick people. Only provide this if you know what you’re doing.
Example Code
{kick;stupid cat;because I can} @stupid cat was kicked!Example Output
Success @stupid cat was kicked, because I can!user defaults to the executing user. Returns the new warning count
ℹ️ {pardon;[user]}
{pardon;[user]}Gives user one pardon.
Example Code
Be pardoned! {pardon}Example Output
Be pardoned! 0
ℹ️ {pardon;<user>;<count>;[reason]}
{pardon;<user>;<count>;[reason]}count defaults to 1 if left blank.
Gives user count pardons with reason.
Example Code
Be pardoned 9001 times, Stupid cat! {pardon;Stupid cat;9001}Example Output
Be pardoned 9001 times, Stupid cat! 0
ℹ️ {randomUser}
{randomUser}Returns the id of a random user on the current guild.
Example Code
{username;{randomUser}} is a lovely person! {username;{randomUser}} isn't as good.Example Output
abalabahaha is a lovely person! stupid cat isn't as good.If the timeout is successful, Success will be returned, otherwise the error will be given.
ℹ️ {timeout;<user>;<duration>}
{timeout;<user>;<duration>}Times out user for the specified amount of time. Maximum is 28 days.
Example Code
{timeout;stupid cat;1d} @stupid cat was timed out for 1 day!Example Output
Success @stupid cat was timed out for 1 day!
ℹ️ {timeout;<user>;<duration>;<reason>;[noPerms]}
{timeout;<user>;<duration>;<reason>;[noPerms]}Times out user for the specified amount of time. Maximum is 28 days.If noPerms is provided and not an empty string, do not check if the command executor is actually able to time out people. Only provide this if you know what you’re doing.
Example Code
{timeout;stupid cat;1d;because I can} @stupid cat was timed out for 1 day!Example Output
Success @stupid cat was timed out for 1 day, because I can!
ℹ️ {unban;<user>}
{unban;<user>}Unbans user.
Example Code
{unban;@user} @user was unbanned!Example Output
@user was unbanned!
ℹ️ {unban;<user>;<reason>;[noPerms]}
{unban;<user>;<reason>;[noPerms]}Unbans user with the given reason.If noPerms is provided and not an empty string, do not check if the command executor is actually able to ban people. Only provide this if you know what you’re doing.
Example Code
{unban;@stupid cat;I made a mistake} @stupid cat has been unbannedExample Output
true @stupid cat has been unbannedIf no game is being played, this will return ‘nothing’
ℹ️ {userActivity}
{userActivity}Returns the name of the activity the executing user is currently doing.
Example Code
You are listening to {userActivity}Example Output
You are listening to bad music
ℹ️ {userActivity;<user>;[quiet]}
{userActivity;<user>;[quiet]}Returns the name of the activity user is currently doing. If user can’t be found it will simply return nothing.
Example Code
Stupid cat is playing {userActivity;Stupid cat}Example Output
Stupid cat is playing nothingActivity types can be any of playing, streaming, listening, watching, custom, competing or ``
ℹ️ {userActivityType}
{userActivityType}Returns the type of activity the executing user is currently doing (playing, streaming).
Example Code
You are {userActivityType} right now!Example Output
You are streaming right now!
ℹ️ {userActivityType;<user>;[quiet]}
{userActivityType;<user>;[quiet]}Returns the activity type user is currently doing. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Stupid cat is {userActivityType;Stupid cat} catsExample Output
Stupid cat is streaming catsIf no game is being played, this will return ‘nothing’
ℹ️ {userAvatar}
{userAvatar}Returns the avatar of the executing user.
Example Code
Your avatar is {userAvatar}Example Output
Your avatar is (avatar url)
ℹ️ {userAvatar;<user>;[quiet]}
{userAvatar;<user>;[quiet]}Returns the avatar of user. If user can’t be found it will simply return nothing.
Example Code
Stupid cat's avatar is {userAvatar;Stupid cat}Example Output
Stupid cat's avatar is (avatar url)See the moment documentation for more information about formats. If user is not boosting the guild, returns User not boosting
ℹ️ {userBoostDate;[format]}
{userBoostDate;[format]}format defaults to YYYY-MM-DDTHH:mm:ssZ if omitted or left blank.
Returns the date that the executing user started boosting the guild using format for the output, in UTC+0.
Example Code
Your account started boosting this guild on {userBoostDate;YYYY/MM/DD HH:mm:ss}Example Output
Your account started boosting this guild on 2020/02/27 00:00:00
ℹ️ {userBoostDate;<format>;<user>;[quiet]}
{userBoostDate;<format>;<user>;[quiet]}format defaults to YYYY-MM-DDTHH:mm:ssZ if left blank.
Returns the date that user started boosting the current guild using format for the output, in UTC+0. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Stupid cat started boosting this guild on {userBoostDate;YYYY/MM/DD HH:mm:ss;stupid cat}Example Output
Stupid cat started boosting this guild on 2020/02/27 00:00:00
ℹ️ {userCreatedAt;[format]}
{userCreatedAt;[format]}format defaults to YYYY-MM-DDTHH:mm:ssZ if omitted or left blank.
Returns the account creation date of the executing user in format.
Example Code
Your account was created on {userCreatedAt}Example Output
Your account was created on 2017-02-06T18:58:10+00:00
ℹ️ {userCreatedAt;<format>;<user>;[quiet]}
{userCreatedAt;<format>;<user>;[quiet]}format defaults to YYYY-MM-DDTHH:mm:ssZ if left blank.
Returns the account creation date of user in format. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Stupid cat's account was created on {userCreatedAt;;Stupid cat}Example Output
Stupid cat's account was created on 2015-10-13T04:27:26ZIf no game is being played, this will return ‘nothing’
ℹ️ {userDiscriminator}
{userDiscriminator}Returns the discriminator of the executing user.
Example Code
Your discriminator is {userDiscriminator}Example Output
Your discriminator is 1234
ℹ️ {userDiscriminator;<user>;[quiet]}
{userDiscriminator;<user>;[quiet]}Returns user‘s discriminator. If user can’t be found it will simply return nothing.
Example Code
Stupid cat's discriminator is {userDiscriminator;Stupid cat}Example Output
Stupid cat's discriminator is 8160This subtag checks if a user has any of the provided roleIds. Use {userHasRoles} to check if a user has all of the provided roleIds. roleIds can be an array of role ids, or a single role id. For a list of roles and their corresponding ids, use b!roles
Returns a boolean.
ℹ️ {userHasRole;<roleids>}
{userHasRole;<roleids>}Checks if the executing user has any of the provided roleIds.
Example Code
{if;{userHasRole;{roleId;moderator}};You are a moderator; You are not a moderator}Example Output
You are a moderator
ℹ️ {userHasRole;<roleids>;<user>;[quiet]}
{userHasRole;<roleids>;<user>;[quiet]}Checks if user has any of the provided roleIds. If quiet is specified, if user or any roleId can’t be found it will simply return false.
Example Code
{if;{userHasRole;{userId;moderator};Stupid cat};Stupid cat is a moderator;Stupid cat is not a moderator}Example Output
Stupid cat is a moderatorThis subtag checks if a user has all of the provided roleIds. Use {userHasRole} to check if a user has any of the provided roleIds. roleIds can be an array of role ids, or a single role id. For a list of roles and their corresponding ids, use b!roles
Returns a boolean.
ℹ️ {userHasRoles;<roleIds>}
{userHasRoles;<roleIds>}Checks if the executing user has all of the provided roleIds.
Example Code
{if;{userHasRoles;["{roleId;moderator}","{roleId;admin}"];You are a moderator and admin; You are not a moderator and admin}Example Output
You are not a moderator and admin
ℹ️ {userHasRoles;<roleIds>;<user>;[quiet]}
{userHasRoles;<roleIds>;<user>;[quiet]}Checks if user has all of the provided roleIds. If quiet is specified, if user or any roleId can’t be found it will simply return false.
Example Code
{if;{userHasRoles;["{roleId;moderator}","{roleId;admin}"];Stupid cat};Stupid cat is a moderator and admin;Stupid cat is not a moderator and admin}Example Output
Stupid cat is a moderator and admin
ℹ️ {userId}
{userId}Returns the user id of the executing user.
Example Code
Your id is {userId}Example Output
Your id is 123456789123456
ℹ️ {userId;<user>;[quiet]}
{userId;<user>;[quiet]}Returns user‘s id. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
This is Stupid cat's user id {userId;Stupid cat}Example Output
This is Stupid cat's user id 103347843934212096
ℹ️ {userIsBot}
{userIsBot}Returns whether the executing user is a bot.
Example Code
Are you a bot? {userIsBot}Example Output
Are you a bot? false
ℹ️ {userIsBot;<user>;[quiet]}
{userIsBot;<user>;[quiet]}Returns whether a user is a bot. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Is Stupid cat a bot? {userIsBot;Stupid cat}Example Output
Is Stupid cat a bot? falseFor a list of formats see the moment documentation for more information.
ℹ️ {userJoinedAt;[format]}
{userJoinedAt;[format]}format defaults to YYYY-MM-DDTHH:mm:ssZ if omitted or left blank.
Returns the date that the executing user joined the guild, using format for the output, in UTC+0.
Example Code
Your account joined this guild on {userJoinedAt;YYYY/MM/DD HH:mm:ss}Example Output
Your account joined this guild on 2016/01/01 01:00:00.
ℹ️ {userJoinedAt;<format>;<user>;[quiet]}
{userJoinedAt;<format>;<user>;[quiet]}format defaults to YYYY-MM-DDTHH:mm:ssZ if left blank.
Returns the date that user joined the current guild using format for the output, in UTC+0. if user can’t be found it will simply return nothing.
Example Code
Stupid cat joined this guild on {userJoinedAt;YYYY/MM/DD HH:mm:ss;Stupid cat}Example Output
Stupid cat joined this guild on 2016/06/19 23:30:30
ℹ️ {userMention}
{userMention}Mentions the executing user.
Example Code
Hello, {userMention}!Example Output
Hello, @user!
ℹ️ {userMention;<user>;[quiet];[noPing]}
{userMention;<user>;[quiet];[noPing]}noPing defaults to false if omitted or left blank.
Mentions user. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Hello, {userMention;stupid cat}!Example Output
Hello, @Stupid cat!
ℹ️ {userName}
{userName}Returns the username of the executing user.
Example Code
Your username is {userName}!Example Output
Your username is Cool Dude 1337!
ℹ️ {userName;<user>;[quiet]}
{userName;<user>;[quiet]}Returns user‘s username. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Stupid cat's username is {userName;Stupid cat}!Example Output
Stupid cat's username is Stupid cat!
ℹ️ {userNickname}
{userNickname}Returns the nickname of the executing user.
Example Code
Your nick is {userNickname}!Example Output
Your nick is Cool Dude 1337!
ℹ️ {userNickname;<user>;[quiet]}
{userNickname;<user>;[quiet]}Returns user‘s nickname. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Stupid cat's nickname is {userNickname;Stupid cat}!Example Output
Stupid cat's nickname is Secretly Awoken
ℹ️ {userRoles}
{userRoles}Returns the roles of the executing user.
Example Code
Your roles are {userRoles}!Example Output
Your roles are ["1111111111111111","2222222222222222"]!
ℹ️ {userRoles;<user>;[quiet]}
{userRoles;<user>;[quiet]}Returns user‘s roles as an array. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Stupid cat's roles are {userRoles;stupid cat}Example Output
Stupid cat's roles are ["1111111111111111","2222222222222222", "3333333333333333"]
ℹ️ {userSetNickname;<nick>;[user]}
{userSetNickname;<nick>;[user]}Sets user‘s nickname to nick. Leave nick blank to reset their nickname.
Example Code
{userSetNickname;super cool nickname}
{//;Reset the the nickname}
{userSetNickname;}Example Output
roleArray must be an array formatted like ["role1", "role2"]
ℹ️ {userSetRoles;[roleArray]}
{userSetRoles;[roleArray]}Sets the roles of the current user to roleArray.
Example Code
{userSetRoles;["1111111111111"]}Example Output
true
ℹ️ {userSetRoles;<roleArray>;<user>;[quiet]}
{userSetRoles;<roleArray>;<user>;[quiet]}Sets the roles of user to roleArray. If quiet is provided, all errors will return false.
Example Code
{userSetRoles;["1111111111111"];stupid cat}Example Output
trueReturned status can be one of online, idle, dnd or offline
ℹ️ {userStatus}
{userStatus}Returns the status of the user.
Example Code
You are currently {userStatus}Example Output
You are currently online
ℹ️ {userStatus;<user>;[quiet]}
{userStatus;<user>;[quiet]}Returns the status of user. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Stupid cat is currently {userStatus;stupid cat}Example Output
Stupid cat is currently onlineSee the moment documentation for more information about formats. If user has never been timed out in the guild, returns User not timed out
ℹ️ {userTimeout;[format]}
{userTimeout;[format]}format defaults to YYYY-MM-DDTHH:mm:ssZ if omitted or left blank.
Returns the executing user’s timeout date using format for the output, in UTC+0.
Example Code
You have been timed out until {userTimeout;YYYY/MM/DD HH:mm:ss}Example Output
You have been timed out until 2021/01/01 00:00:00
ℹ️ {userTimeout;[format];<user>;[quiet]}
{userTimeout;[format];<user>;[quiet]}format defaults to YYYY-MM-DDTHH:mm:ssZ if omitted or left blank.
Returns a user‘s timeout date using format for the output, in UTC+0. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
stupid cat is timed out until {userTimeout;YYYY/MM/DD HH:mm:ss;stupid cat}Example Output
stupid cat is timed out until 2021/01/01 00:00:00
ℹ️ {userTimeZone}
{userTimeZone}Returns the set timezone of the user executing the containing tag.
Example Code
{userTimeZone}Example Output
UTC
ℹ️ {userTimeZone;<user>;[quiet]}
{userTimeZone;<user>;[quiet]}Returns the set timezone code of the specified user. If quiet is specified, if user can’t be found it will simply return nothing.If the user has no set timezone, the output will be UTC.
Example Code
Discord official's timezone is {userTimeZone;Discord official}Example Output
Discord official's timezone is Europe/Berlinuser defaults to the executing user.
ℹ️ {warn;[user]}
{warn;[user]}Gives user one warning. This will return the amount of warnings user has after executing.
Example Code
Be warned! {warn}Example Output
Be warned! 1
ℹ️ {warn;<user>;<count>;[reason]}
{warn;<user>;<count>;[reason]}count defaults to 1 if left blank.
Gives user count warnings.
Example Code
Be warned Stupid cat! {warn;Stupid cat;9001;For being too cool}Example Output
Be warned Stupid cat! 9001
ℹ️ {warnings;[user];[quiet]}
{warnings;[user];[quiet]}Gets the number of warnings user has. user defaults to the user who executed the containing tag.
Example Code
You have {warnings} warning(s)!Example Output
You have 0 warning(s)!Role Subtags
Subtags that interact with roles.
role can be either a roleId or role mention.
ℹ️ {roleAdd;<role>}
{roleAdd;<role>}Gives the executing user role. Returns true if role was given, else an error will be shown.
Example Code
Have a role! {roleAdd;11111111111111111}Example Output
Have a role! true
ℹ️ {roleAdd;<role>;<user>;[quiet]}
{roleAdd;<role>;<user>;[quiet]}Gives user the chosen role. Returns true if role was given, else an error will be shown. If quiet is specified, if a user can’t be found it will simply return false
Example Code
Stupid cat have a role! {roleAdd;Bot;Stupid cat}Example Output
Stupid cat have a role! true
ℹ️ {roleColor;<role>;[quiet]}
{roleColor;<role>;[quiet]}Returns role‘s hex color code. If quiet is specified, if role can’t be found it will simply return nothing.
Example Code
The admin role color is: #{roleColor;admin}.Example Output
The admin role id is: #1b1b1b.
ℹ️ {roleCreate;<name>;[color];[permissions];[mentionable];[hoisted]}
{roleCreate;<name>;[color];[permissions];[mentionable];[hoisted]}color defaults to 000000 if omitted or left blank.permissions defaults to 0 if omitted or left blank.mentionable defaults to false if omitted or left blank.hoisted defaults to false if omitted or left blank.
color can be a HTML color, hex, (r,g,b) or a valid color number. Provide permissions as a number, which can be calculated here hoisted is if the role should be displayed separately from other roles.
Returns the new role’s id.
Example Code
{roleCreate;myNewRole;red}Example Output
1298731238361728931
ℹ️ {roleDelete;<role>;[quiet]}
{roleDelete;<role>;[quiet]}Deletes role. If quiet is specified, if role can’t be found it will return nothing.
Warning: this subtag is able to delete roles managed by integrations.
Example Code
{roleDelete;Super Cool Role!}Example Output
(rip no more super cool roles for anyone)
ℹ️ {roleId;<role>;[quiet]}
{roleId;<role>;[quiet]}Returns role‘s id. If quiet is specified, if role can’t be found it will simply return nothing.
Example Code
The admin role id is: {roleId;admin}.Example Output
The admin role id is: 123456789123456.
ℹ️ {roleMembers;<role>;[quiet]}
{roleMembers;<role>;[quiet]}Returns an array of members in role. If quiet is specified, if role can’t be found it will simply return nothing.
Example Code
The admins are: {roleMembers;Admin}.Example Output
The admins are: ["11111111111111111","22222222222222222"].
ℹ️ {roleMention;<role>;[quiet];[noPing]}
{roleMention;<role>;[quiet];[noPing]}noPing defaults to false if omitted or left blank.
Returns a mention of role. If quiet is specified, if role can’t be found it will simply return nothing.
Example Code
The admin role will be mentioned: {roleMention;Admin}Example Output
The admin role will be mentioned: @Administrator
ℹ️ {roleName;<role>;[quiet]}
{roleName;<role>;[quiet]}Returns role‘s name. If quiet is specified, if role can’t be found it will simply return nothing.
Example Code
The admin role name is: {roleName;admin}.Example Output
The admin role name is: Administrator.
ℹ️ {rolePermissions;<role>;[quiet]}
{rolePermissions;<role>;[quiet]}Returns role‘s permission number. If quiet is specified, if role can’t be found it will simply return nothing.
Example Code
The admin role's permissions are: {rolePermissions;admin}.Example Output
The admin role's permissions are: 8.
ℹ️ {rolePosition;<role>;[quiet]}
{rolePosition;<role>;[quiet]}Returns the position of role. If quiet is specified, if role can’t be found it will simply return nothing.
Note: the highest role will have the highest position, and the lowest role will have the lowest position and therefore return 0 (@everyone).
Example Code
The position of Mayor is {rolePosition;Mayor}Example Output
The position of Mayor is 10role can be either a roleId or role mention.
ℹ️ {roleRemove;<role>}
{roleRemove;<role>}Removes role from the executing user. Returns true if role was removed, else an error will be shown.
Example Code
No more role! {roleRemove;11111111111111111}Example Output
No more role! true
ℹ️ {roleRemove;<role>;<user>;[quiet]}
{roleRemove;<role>;<user>;[quiet]}Remove the chosen role from user. Returns true if role was removed, else an error will be shown. If quiet is specified, if a user can’t be found it will simply return false
Example Code
Stupid cat no more role! {roleRemove;Bot;Stupid cat}Example Output
Stupid cat no more role! true
ℹ️ {roles}
{roles}Returns an array of roles on the current guild.
Example Code
The roles on this guild are: {roles}.Example Output
The roles on this guild are: ["11111111111111111","22222222222222222"].
ℹ️ {roles;<user>;[quiet]}
{roles;<user>;[quiet]}Returns user‘s roles in the current guild. If quiet is specified, if user can’t be found it will simply return nothing.
Example Code
Stupid cat has the roles: {roles;Stupid cat}Example Output
Stupid cat has the roles: ["11111111111111111","22222222222222222"]
ℹ️ {roleSetColor;<role>}
{roleSetColor;<role>}Sets the color of role to ‘#000000’. This is transparent.
Example Code
The admin role is now colourless. {roleSetColor;admin}Example Output
The admin role is now colourless.
ℹ️ {roleSetColor;<role>;<color>;[quiet]}
{roleSetColor;<role>;<color>;[quiet]}Sets the color of role.If quiet is specified, if role can’t be found it will simply return nothing
Example Code
The admin role is now white. {roleSetColor;admin;white}Example Output
The admin role is now white.
ℹ️ {roleSetMentionable;<role>}
{roleSetMentionable;<role>}Set role to mentionable.
Example Code
The admin role is now mentionable. {roleSetMentionable;admin}Example Output
The admin role is now mentionable.
ℹ️ {roleSetMentionable;<role>;<value>;[quiet]}
{roleSetMentionable;<role>;<value>;[quiet]}value defaults to true if left blank.
Sets whether role can be mentioned. value can be either true to set the role as mentionable, or anything else to set it to unmentionable. If quiet is specified, if role can’t be found it will simply return nothing
Example Code
The admin role is no longer mentionable. {roleSetMentionable;admin;false}Example Output
The admin role is no longer mentionable.
ℹ️ {roleSetName;<role>;<name>;[quiet]}
{roleSetName;<role>;<name>;[quiet]}Sets the name of role.If quiet is specified, if role can’t be found it will simply return nothing
Example Code
The admin role is now called administrator. {roleSetName;admin;administrator}Example Output
The admin role is now called administrator.
ℹ️ {roleSetPermissions;<role>}
{roleSetPermissions;<role>}Removes all perms from role
Example Code
{roleSetPermissions;Support}Example Output
(perms have been changed)
ℹ️ {roleSetPermissions;<role>;<permissions>;[quiet]}
{roleSetPermissions;<role>;<permissions>;[quiet]}permissions defaults to 0 if left blank.
Sets the permissions of role with the provided permissions number. This will not apply any permissions the authorizer can’t grant. Additionally, this will completely overwrite the role’s existing permissions. If quiet is specified, if role can’t be found it will simply return nothing
Example Code
The admin role now has the administrator permission. {roleSetPermissions;admin;8}Example Output
The admin role now has the administrator permission.
ℹ️ {roleSetPosition;<role>;<position>;[quiet]}
{roleSetPosition;<role>;<position>;[quiet]}Sets the position of role. If quiet is specified, if role can’t be found it will simply return nothing.
Example Code
The admin role is now at position 3. {roleSetPosition;admin;3}Example Output
The admin role is now at position 3.
ℹ️ {roleSize;<role>}
{roleSize;<role>}Returns the amount of people in role role
Example Code
There are {roleSize;11111111111111111} people in the role!Example Output
There are 5 people in the role!Guild Subtags
Subtags that interact with guilds.
ℹ️ {emojiCreate;<name>;<image>;[roles]}
{emojiCreate;<name>;<image>;[roles]}Creates a emoji with the given name and image. image is either a link to an image, or a base64 encoded data url (data:<content-type>;base64,<base64-data>). You may need to use {semi} for the latter.roles, if provided, will restrict the emoji’s usage to the specified roles. Must be an array of roles.Returns the new emojis’s id.
Example Code
{emojiCreate;fancy_emote;https://some.cool/image.png;["Cool gang"]}Example Output
11111111111111111
ℹ️ {emojiDelete;<id>}
{emojiDelete;<id>}Deletes an emoji with the provided id
Example Code
{emojiDelete;11111111111111111}Example Output
Please note that Discord will remove all the emojis from a message which contains an emoji that blargbot can’t use. For example, blargbot can’t use a role-restricted emoji if it doesn’t have the role. Learn more here.
ℹ️ {emojis}
{emojis}Returns an array of emojis in the current guild.
Example Code
This guild has {length;{emojis}} emojis.Example Output
This guild has 23 emojis.
ℹ️ {emojis;<role>}
{emojis;<role>}Returns an array of emojis whitelisted for the provided role
Example Code
Cool gang has {length;{emojis;Cool gang}} emojis.Example Output
Cool gang has 6 emojis.
ℹ️ {guildBans}
{guildBans}Returns an array of banned users in the current guild.
Example Code
This guild has {length;{guildBans}} banned users.Example Output
This guild has 123 banned users.
ℹ️ {guildCreatedAt;[format]}
{guildCreatedAt;[format]}Returns the date the current guild was created, in UTC+0. If a format code is specified, the date is formatted accordingly. Leave blank for default formatting. See the moment documentation for more information.
Example Code
This guild was created on {guildCreatedAt;YYYY/MM/DD HH:mm:ss}Example Output
This guild was created on 2016/01/01 01:00:00
ℹ️ {guildFeatures}
{guildFeatures}Returns an array of guild feature strings. For a full list click this link.
Example Code
{guildFeatures}Example Output
["COMMUNITY","COMMERCE","NEWS","PREVIEW_ENABLED","WELCOME_SCREEN_ENABLED","MEMBER_VERIFICATION_GATE_ENABLED","THREADS_ENABLED"]
ℹ️ {guildIcon}
{guildIcon}Returns the icon of the current guild. If it doesn’t exist returns nothing.
Example Code
The guild's icon is {guildIcon}Example Output
The guild's icon is (icon url)
ℹ️ {guildId}
{guildId}Returns the id of the current guild.
Example Code
The guild's id is {guildId}Example Output
The guild's id is 1234567890123456
ℹ️ {guildMembers}
{guildMembers}Returns an array of user ids of the members on the current guild.
Example Code
This guild has {length;{guildMembers}} members.Example Output
This guild has 123 members.
ℹ️ {guildName}
{guildName}Returns the name of the current guild.
Example Code
This guild's name is {guildName}.Example Output
This guild's name is TestGuild.
ℹ️ {guildOwnerId}
{guildOwnerId}Returns the id of the guild’s owner.
Example Code
The owner's id is {guildOwnerId}.Example Output
The owner's id is 1234567890123456.
ℹ️ {guildSetIcon;<image>}
{guildSetIcon;<image>}Updates the current guild’s icon with the provided image. image is either a link to an image, or a base64 encoded data url (data:<content-type>;base64,<base64-data>). You may need to use {semi} for the latter.
Example Code
{guildSetIcon;https://some.cool/image.png}Example Output
ℹ️ {guildSize}
{guildSize}Returns the number of members on the current guild.
Example Code
This guild has {guildSize} members.Example Output
This guild has 123 members.