Skip to content

Instantly share code, notes, and snippets.

@fatchan
Last active August 1, 2020 08:10
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save fatchan/5be931881dc5aaf3dc62a581c065c08e to your computer and use it in GitHub Desktop.
Save fatchan/5be931881dc5aaf3dc62a581c065c08e to your computer and use it in GitHub Desktop.

TomBot Command Documentation

This is a list of commands available for TomBot. Commands are used by entering the prefix (default > or always @TomBot) followed by the command name and arguments, if applicable. For example >ping will execute the ping command. Commands are separated into the following categories:


General

help
Usage: help [command]
get general help info, or specific command help
Examples:
>help, >help hangman

profile
Usage: profile [@mention]
view profiles. use a mention to see a specific user, or no mention to see your own.
Examples:
>profile, >profile @Somebody

top
Usage: top [type]
show top votes or points. defaults to points.
Examples:
>top votes, >top points, >top

send
Usage: send <@mention> <number>
send points to somebody
Examples:
>send @somebody 50


Music

play
Usage: play [-now|-next] <URL or search terms>
play music from a link or search terms, start with -now to play immediately, or -next to add it after the currently playing song
Examples:
>play darude sandstorm, >play https://youtu.be/y6120QOlsfU, >play spotify:user:spotify:playlist:37i9dQZF1DXcBWIGoYBM5M, >play https://soundcloud.com/50_cent/body-bags, >play https://twitch.tv/monstercat, >play https://sunshineedm.radio.net

replay
Usage: replay
start the current song from the beginning
Examples:
>replay

pause
Usage: pause
pause song
Examples:
>pause

resume
Usage: resume
unpause song
Examples:
>resume

seek
Usage: seek <HH:mm:ss>
Seek to a timestamp in the currently playing song
Examples:
>seek 18, >seek 2:30, >seek 1:02:35

eq
Usage: eq [reset]
Open or reset the EQ (equalizer). This allows you to adjust the audio to bass boost, etc. Controlled with reactions.
Examples:
>eq, >eq reset

queue
Usage: queue [number]
see music queue
Examples:
>queue, >queue 5

queue-remove
Usage: queue-remove <number> [number]
remove items from music queue. either a single item, or an inclusive range
Examples:
>queue-remove 5, >queue-remove 3 5

queue-swap
Usage: queue-swap <first number> <second number>
swap the position of 2 songs in the queue
Examples:
>queue-swap 1 5

skip
Usage: skip [amount]
skip current song, or multiple songs
Examples:
>skip, >skip 5

summon
Usage: summon
summon the bot to you voice channel
Examples:
>summon

np
Usage: np
see what is currently playing
Examples:
>np

stop
Usage: stop
stop music and clear the queue
Examples:
>stop

leave
Usage: leave
leave the voice channel forcefully
Examples:
>leave

loop
Usage: loop
switch queue looping modes between 1, on or off. 1 will loop the current song, on wil repeat the whole queue, false will not loop in any way.
Examples:
>loop

shuffle
Usage: shuffle [-now]
shuffle the queue, use -now to start playing the next song immediately
Examples:
>shuffle, >shuffle -now


Playlist

playlist-list
Usage: playlist-list
list playlists saved by the bot
Examples:
>playlist-list

playlist-show
Usage: playlist-show <playlist name> [page]
show the contents of a saved playlist
Examples:
>playlist-show popmusic, >playlist-show popmusic 3

playlist-save
Usage: playlist-save <playlist name>
save a new playlist
Examples:
>playlist-save popmusic

playlist-load
Usage: playlist-load <playlist name>
load an existing playlist
Examples:
>playlist-load popmusic

playlist-create
Usage: playlist-create <playlist name>
create a new, blank playlist
Examples:
>playlist-create potato

playlist-add
Usage: playlist-add <playlist name> [index] <url/search terms>
add music to an existing playlist. either append it on the end, or specity a position to insert instead.
Examples:
>playlist-add potato the duck song

playlist-find
Usage: playlist-find <playlist name> <search term>
search a tombot playlist for tracks with a title containing a search term
Examples:
>playlist-find hiphop example

playlist-remove
Usage: playlist-remove <playlist name> <starting index> <amount>
remove items from a playlist starting from an index and specifying the amount.
Examples:
>playlist-remove potato 3 1

playlist-swap
Usage: playlist-swap <playlist name> <first number> <second number>
swap the position of 2 songs in a playlist.
Examples:
>playlist-swap potato 6 17

playlist-rename
Usage: playlist-rename <playlist name> <new name>
rename a playlist.
Examples:
>playlist-rename potato apple

playlist-export
Usage: playlist-export <playlist name>
get the share code for a playlist. import it again on any server with TomBot!
Examples:
>playlist-export popmusic

playlist-import
Usage: playlist-import <share code>
import a playlist from a share code
Examples:
>playlist-import 735dfab1524655f95684dab8f6838cf2


Games

hangman
Usage: hangman
start hangman game
Examples:
>hangman

word
Usage: word <word>
guess a word
Examples:
>word potato, >word discord

letter
Usage: letter <letter>
guess a letter
Examples:
>letter a, >letter k

guesses
Usage: guesses
show all guesses
Examples:
>guesses

hangman-stop
Usage: hangman-stop
end hangman game
Examples:
>hangman-stop

cah
Usage: cah [card numbers...]
start or join cards against humanity game, or pick a card during a round
Examples:
>cah, >cah 5, >cah 2 6

cah-stop
Usage: cah-stop
force stop cards against humanity game
Examples:
>cah-stop

cah-kick
Usage: cah-kick @somebody
kick somebody from cards against humanity game
Examples:
>cah-kick @somebody

c4
Usage: c4
start or join connect 4 game
Examples:
>c4

c4-stop
Usage: c4-stop
force stop connect4 game
Examples:
>c4-stop

blackjack
Usage: blackjack [bet]
start or join blackjack game. 4 reaction options: hit, stand, double or surrender. play with or without a bet.
Examples:
>blackjack, >blackjack 100


OSRS

osrs-ge
Usage: osrs-ge <item name>
get oldschool runescape grand exchange information for an item
Examples:
>osrs-ge armadyl godsword, >osrs-ge nature rune

osrs-hs
Usage: osrs-hs <display name>
get oldschool runescape highscores data and combat level
Examples:
>osrs-hs zezima, >osrs-hs lynx titan

osrs-wiki
Usage: osrs-wiki <search terms>
get oldschool runescape wiki article information
Examples:
>osrs-wiki strength cape, >osrs-wiki armadyl godsword


Misc

ow
Usage: ow <battletag> <mode> [hero] [category]
get overwatch stats. battletags are case sensitive. Can either pick a battletag and mode for a quick overview, or add a hero and category for in-depth stats. Modes: competitive|quickplay Categories: specific|combat|assists|best|average|game|awards|miscellaneous
Examples:
>ow xQc#11273 competitive, >ow xQc#11273 quickplay, >ow xQc#11273 competitive winston combat, >ow xQc#11273 competitive overall game

urban
Usage: urban <search term>
get urban dictionary definition
Examples:
>urban potato, >urban discord

minecraft
Usage: minecraft
see minecraft server status
Examples:
>minecraft

emoji
Usage: emoji <text>
convert text to emojis. english letters, numbers, ! and ? supported. Max 80 characters.
Examples:
>emoji hello world!

vaporwave
Usage: vaporwave <text>
convert text to vaporwave.
Examples:
>vaporwave hello world!

omegalul
Usage: omegalul <text>
replace o's with OMEGALUL emojis.
Examples:
>omegalul hello world!

clap
Usage: clap <text>
Add claps between words.
Examples:
>clap this command is cool


Permissions

perms
Usage: perms <@mention> <command> <true/false>
change permissions for a user or role to a command
Examples:
>perms @somebody stop true, >perms @somebody hangman false

perms
Usage: perms <@mention>admin
grant a user or role admin permissions (all command true). anyone with perms command permissions can use this.
Examples:
>perms @somebody admin

perms
Usage: perms <@mention>show
see all permissions of a user or role
Examples:
>perms @somebody show

perms
Usage: perms <command> default <true/false>
change default permissions for a command
Examples:
>perms play default false, >perms stop default true

perms
Usage: perms [@mention | command] wipe
wipe permissions for a user, role, command or everything
Examples:
>perms @somebody wipe, >perms stop wipe, >perms wipe

perms
Usage: perms <command>
view current command permissions
Examples:
>perms list, >perms stop


Config

config
Usage: config
see all current bot configs
Examples:
>config

config-prefix
Usage: config-prefix [new prefix]
see or change bot prefix
Examples:
@TomBot config-prefix, @TomBot config-prefix !

config-np
Usage: config-np
toggle now playing messages
Examples:
>config-np

config-channel
Usage: config-channel
change the channel of now playing messages to the current channel
Examples:
>config-channel

config-limit
Usage: config-limit <HH:mm:ss>
set song length limit. time string to set, 0 to disable.
Examples:
>config-limit 0, >config-limit 30:00

config-voteskip
Usage: config-voteskip
toggle vote skipping
Examples:
>config-voteskip

config-queue
Usage: config-queue <number>
change queue size
Examples:
>config-queue 50

config-pick
Usage: config-pick
toggle song picking. when disabled, play command always picks first search result if you are searching for youtube videos
Examples:
>config-pick

config-247
Usage: config-247
dont leave empty channels automatically when playing music
Examples:
@TomBot config-247, @TomBot config-247

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment