Commands

From ShoutIRC RadioBot Wiki
Jump to navigation Jump to search

RadioBot Commands / Usage Manual

This page only lists the commands that are built-in to RadioBot and AutoDJ/SimpleDJ. There are many more commands available in plugins and defined in ircbot.text.

Built-in Commands (Private Message)

Commands Flags Needed Description
!hello   If this bot has no registered users, this will create your new admin account. After that:
  • If AutoRegOnHello is 1, it will create an account for anyone who doesn't have one, or if AutoRegOnHello is 0:
  • Will say hello to them and tell them their user flags if they are a user, or tell them they are unrecognized if they arent.
!commands [#] [ex]   This will show you a list of commands available to you.

If you PM the bot this command it will show you all available commands, or you can use it in-channel to get only channel commands.
You can also use '!commands #' to get the commands just for a specific plugin or '!commands ex' to append all available contexts to each command.

!help command   This will show you the description of whatever command you selected.
!whoami   This will show you your hostmask as the bot sees it and your username and level if you are recognized.
!identify user pass   This will add your current hostmask to your account if you are logging in from an unrecognized hostmask.
!reqlogin [off] +d This command marks you are the current DJ and logs you in to the request system.
You can also use '!reqlogin off' to mark yourself as the current DJ but not taking requests
!reqlogout +d Logs you out of the request system. If you are +m or +o it will let your override.
!sendreq / !dedicate +d Lets the active DJ announce a requested song, with different texts (defined in ircbot.text).
!current +mo (any) See who the current DJ is.
!topic +mo (any) Sets a replacement channel topic to use on all channels while the radio of offline. Bot resets to normal topic management when the radio comes back online.
!adduser username +flags password [hostmask] +m Adds a user to the bot, password is case-sensitive.

See the User Flags page to learn more about user flags, or the LevelEmul plugin for some good suggested defaults.
An operator cannot add a master or given them the die flag (+i) if they don't have it themselves.
Hostmask is optional and if given that hostmask will be added to the user's account instead of the default (*username*!*@*)

!deluser username +mo (any) Removes a user from the bot.
!viewuser username +mo (any) Will tell you the user’s flags, password, and hostmask(s).
!viewusers [*wildcard*] +mo (any) Will show you a list of users from the RadioBot DB, optionally matching a wildcard pattern.
!chflags [username] +-=flags +mo (any) Changes your or username's access level.
!+host [username] hostmask +mohd (any) Adds a hostmask to yourself or username. (Must have +m to add to another username)
!-host [username] hostmask +mohd (any) Removes a hostmask to yourself or username. (Must have +m to del from another username)
!chpass [username] newpass +mohd (any) Changes your or username's password. (Must have +m to change another username's pass)
!modules +mo (any) See the currently loaded modules (plugins).
!modinfo x +mo (any) Information on module number x (!modules to get #).
!modload x +m Loads module number x (!modules to get #).
!modunload x +m Unload module number x (!modules to get #).
!die +i Shuts down the bot
!reload +i Reloads the IRC and Timer sections of ircbot.conf
!restart +i Restarts the bot
!rehash [filename] +i Reloads ircbot.text, if filename is given uses that file instead of the current ircbot.text
!dospam [#channel] +mho (any) Toggles topic changes, announcements, globally or in a specific channel.
!dotopic [#channel] +mho (any) Toggles topic management globally or in a specific channel.
!doonjoin [#channel] +mho (any) Toggles the OnJoin message globally or in a specific channel.
!version   This will show you the bot version.
!rate 0-5   Let's you rate the currently playing song (if ratings are enabled) from 1-5, or 0 to remove your existing rating.
!rating   This will show you the rating of the current song.
@find +q If enabled, will let users search for songs when a source plugin is playing.
!request [#/filename] +q This will let users request songs from Live DJs who want to take requests and from source plugins like AutoDJ.
!raw raw IRC command +mo (any) This is for advanced users only, executes a raw IRC command.
!sendq-stats +m Shows some basic stats from the SendQ.
!sendq-set bps +m Changes the maximum bytes per second of the SendQ to a new setting.
!cfgdump +m This will dump your ircbot.conf to the console as the bot sees it. Useful for finding any missed closing brackets, etc.

Built-in Commands (Channel)

Commands Flags Needed Description
!commands [#] [ex]   This will show you a list of channel commands available to you.

If you PM the bot this command it will show you all available commands, or you can use it in-channel to get only channel commands.
You can also use '!commands #' to get the commands just for a specific plugin or '!commands ex' to append all available contexts to each command.

!sendreq / !dedicate +d Lets the active DJ announce a requested song, with different texts (defined in ircbot.text).
!dospam +mho (any) Toggles topic changes in the current channel.
!dotopic +mho (any) Toggles topic management in the current channel.
!doonjoin +mho (any) Toggles the OnJoin message in the current channel.
!version [public]   This will notice you the bot version. You can also use "!version public" and it will display the version in the channel.
!rate 0-5   Let's you rate the currently playing song (if ratings are enabled) from 1-5, or 0 to remove your existing rating.
!rating   This will show you the rating of the current song.
!playlist   This will show you the URL of the current DJ's playlist.
@find +q If enabled, will let users search for songs when a source plugin is playing.
!request [#/filename] +q This will let users request songs from Live DJs who want to take requests and from source plugins like AutoDJ.

AutoDJ/SimpleDJ Commands / Usage Manual

Remember: Commands in the following sections *ONLY* apply to the bot's own AutoDJ and SimpleDJ plugins.
They do not work for any other AutoDJ solution such as SAM Broadcaster or Centovacast. See the page for the source control plugin you are using for commands applicable to that plugin.

Built-in Commands (Private Message)

Commands Flags Needed Description
!autodj-stop +s Counts down until song is over and disconnects so a Live DJ can connect. AutoDJ will turn back on after a timeout (default: 10 seconds)
!autodj-force +a Force AutoDJ to disconnect and stop anything it is doing.
!autodj-play +s Connect and start playing MP3s.
!autodj-reload +a Reloads the playlist and re-writes the HTML playlist (if specified in .conf)
!autodj-next +a Stops playing current song and goes to the next one.
!autodj-move
!autodj-move now
!autodj-move filename
+mo (any) When the current song is over it will be moved into the MoveDir defined in the AutoDJ/Options section of your ircbot.conf.
If now is specified it also skips to the next song immediately.
If a filename is specified it will move that file instead. This parameter takes just a filename just like !request, not a full path and filename.
!youtube-dl url or keyword(s) +a Downloads a YouTube video to the YouTubeDir folder.
!youtube-play [once] url or keyword(s) +a Downloads a YouTube video to the YouTubeDir folder and plays the audio. If once is specified the file is deleted afterwards.
!autodj-reqlist +a This will make AutoDJ show you a list of the currently requested/scheduled songs.
!autodj-reqdelete filename/wildcard +a This will make AutoDJ delete the first requested/scheduled song that matches the filename/wildcard you give.
!autodj-requests [on][off] +a This will make toggle whether AutoDJ will take requests from users.
You can also specify on or off to turn requests on or off.
!autodj-relay +mo (any) Queue's any file on the filesystem, or a stream (stream://host:port/;file.mp3)
!autodj-speak text +mo (any) This will make AutoDJ speak the specified text at the end of the current song (Voice must be enabled).
!autodj-chroot dir[;dir] +mo (any) Changes the content directory on the fly.
!autodj-name +mo (any) Changes the name sent to the sound server on the fly.
!autodj-modules +mo (any) This will display the currently loaded AutoDJ plugins.
!autodj-songtitle title +a This will make AutoDJ send the specified song title to your song server.
!autodj-dopromo +a This will make AutoDJ play a set of your promos after the current song.
!autodj-countdown   This will countdown the current song until it is over (but will not disconnect the bot for a DJ to connect like !autodj-stop)

Built-in Commands (Channel)

Commands Flags Needed Description
!next +a Stops playing current song and goes to the next one.
!songby artist +q Queue's a random song by the specified artist.
!countdown   This will countdown the current song until it is over (but will not disconnect the bot for a DJ to connect like !autodj-stop).
!move
!move now
!move filename
+mo (any) When the current song is over it will be moved into the MoveDir defined in the AutoDJ/Options section of your ircbot.conf.
If now is specified it also skips to the next song immediately.
If a filename is specified it will move that file instead. This parameter takes just a filename just like !request, not a full path and filename.
!relay +mo (any) Queue's any file on the filesystem, or a stream (stream://host:port/;file.mp3).
!youtube-dl url or keyword(s) +a Downloads a YouTube video to the YouTubeDir folder.
!youtube-play [once] url or keyword(s) +a Downloads a YouTube video to the YouTubeDir folder and plays the audio. If once is specified the file is deleted afterwards.


RadioBot vde

RadioBot main pages
Main PageInstallationChangelogCommandsPluginsFAQConfigurationCreditsRemote ClientBuilt-In VariablesMulti Sound Server ModeUsername Character Restrictions
Auto DJ Pages
Auto DJ Main PageWebRequest SystemSchedulerMP3 EncoderVoice SupportMySQL Plugin