Built-in plugins reference¶
Here is a list of all built-in plugins and their commands and configuration. For an overview of all major plugins, see Limnoria.net’s plugin page
These are commands useful for administrating the bot; they all require their caller to have the ‘admin’ capability. This plugin is loaded by default.
This plugin allows the user to create various aliases (known as “Akas”, since Alias is the name of another plugin Aka is based on) to other commands or combinations of other commands (via nested commands).
Allows folks to talk through the bot anonymously.
Automatically ops, voices, or halfops, or bans people when they join a channel, according to their capabilities. If you want your bot automatically op users when they join your channel, this is the plugin to load.
Autocomplete: Provides command autocompletion for IRC clients that support it.
This plugin implements an early draft of the IRCv3 autocompletion client tags. As this is not yet a released specification, it does nothing unless
supybot.protocols.irc.experimentalExtensionsis set to True (keep it set to False unless you know what you are doing).If you are interested in this feature, please contribute to the discussion
Filters bad words on outgoing messages from the bot, so the bot can’t be made to say bad words. As an additional capability, it can (optionally) kick users who use such words from channels that have that capability enabled.
Basic channel management commands. Many of these commands require their caller to have the #channel,op capability. This plugin is loaded by default.
Logs each channel to its own individual logfile.
Silently listens to every message received on a channel and keeps statistics concerning joins, parts, and various other commands in addition to tracking statistics about smileys, actions, characters, and words.
Contains numerous conditional commands (such as ‘if’, ‘and’, and ‘or’), which can be used on their own or with another plugin. Also provides logic operators for writing conditions.
Useful for bot scripting / nested commands.
Handles configuration of the bot while it is running.
Handles standard CTCP responses to PING, TIME, SOURCE, VERSION, USERINFO, and FINGER.
Searches for results on DuckDuckGo’s web search.
This is for developers debugging their plugins; it provides an eval command as well as some other useful commands. It should not be loaded with a default installation.
Commands that use the dictd protocol to define words.
In order to use this plugin you must have the following modules installed:
dictclient: http://quux.org:70/devel/dictclient
The Dunno module is used to spice up the reply when given an invalid command with random ‘I dunno’-like responses. If you want something spicier than ‘<x> is not a valid command’-like responses, use this plugin. Like Success does for the ‘The operation succeeded.’ reply.
Handles ‘factoids,’ little tidbits of information held in a database and available on demand via several commands.
Fetches information from ActivityPub servers.
Provides numerous filters, and a command (outfilter) to set them as filters on the output of the bot. For instance, you could make everything the bot says be in leetspeak, or Morse code, or any number of other kinds of filters. Not very useful, but definitely quite fun :)
See also the Format plugin for format manipulation commands.
Provides simple commands for formatting text on IRC (like bold), and to change the output of the bot for a particular command. See also the Filter plugin to configure the output format for all commands.
GPG: Provides authentication based on GPG keys.
This plugin provides some fun games like (Russian) roulette, 8ball, monologue which tells you how many lines you have spoken without anyone interrupting you, coin and dice.
Geography: Provides geography facts, such as timezones.
Accesses Google for various things.
Provides various hash- and encryption-related commands.
Greets users who join the channel with a recognized hostmask with a nice little greeting.
This plugin provides commands to transform domains into IP addresses and IP addresses to domains. It can also search WHOIS information and return hexips.
Plugin for keeping track of Karma for users and things in a channel.
This plugin keeps a database of larts (Luser Attitude Readjustment Tool), and larts with it.
Informal notes, mostly for compatibility with other bots. Based entirely on nicks, it’s an easy way to tell users who refuse to register notes when they arrive later.
This plugin sets channel limits (MODE +l) based on
plugins.Limiter.MaximumExcessplus the current number of users in the channel. This is useful to prevent flood attacks.
Allows for sending the bot’s logging output to channels or users.
This plugin provides a calculator, converter, a list of units and other useful math functions.
The MessageParser plugin allows you to set custom regexp triggers, which will trigger the bot to respond if they match anywhere in the message. This is useful for those cases when you want a bot response even when the bot was not explicitly addressed by name or prefix character.
An updated page of this plugin’s documentation is located here: https://sourceforge.net/p/gribble/wiki/MessageParser_Plugin/
Miscellaneous commands.
Moobot factoid compatibility module. Moobot’s factoids were originally designed to emulate Blootbot’s factoids, so in either case, you should find this plugin comfortable.
Includes commands for connecting, disconnecting, and reconnecting to multiple networks, as well as several other utility functions related to IRC networks like showing the latency.
A module to allow each channel to have “news”. News items may have expiration dates. It was partially inspired by the news system used on #debian’s bot.
Support authentication based on nicks and network services.
This module attempts to capture the bot’s nick, watching for an opportunity to switch to that nick.
A port of Infobot’s nickometer command from Perl. This plugin provides one command (called nickometer) which will tell you how ‘lame’ an IRC nick is. It’s an elitist hacker thing, but quite fun.
A complete messaging system that allows users to leave ‘notes’ for other users that can be retrieved later.
Provides commands useful to the owner of the bot; the commands here require their caller to have the ‘owner’ capability. This plugin is loaded by default.
This plugin handles various plugin-related things, such as getting help for a plugin or retrieving author info.
This plugin allows you to quickly download and install a plugin from other repositories.
Poll: Provides a simple way to vote on answers to a question
Hand out praise to IRC denizens with this plugin.
Defends a channel against actions by people who don’t have the proper capabilities, even if they have +o or +h.
Maintains a Quotes database for each channel.
Quotegrabs are like IRC sound bites. When someone says something funny, incriminating, stupid, outrageous, … anything that might be worth remembering, you can grab that quote for that person. With this plugin, you can store many quotes per person and display their most recent quote, as well as see who “grabbed” the quote in the first place.
Provides basic functionality for handling RSS/RDF feeds, and allows announcing them periodically to channels. In order to use this plugin you must have the following modules installed: * feedparser: http://feedparser.org/
Handles relaying between networks.
This plugin contains various commands which elicit certain types of responses from the bot.
Gives the user the ability to schedule commands to run at a particular time, or repeatedly run at a particular interval. For example,
scheduler add [time seconds 30m] "utilities echo [status cpu]"will schedule the command cpu to be sent to the channel in 30 minutes.
History replacer using sed-style expressions.
Keeps track of the last time a user was seen on a channel and what they last said. It also allows you to see what you missed since you parted the channel.
Services: Handles management of nicks with NickServ, and ops with ChanServ; to (re)gain access to its own nick and channels.
Shrinks URLs using various URL shortening services, like tinyurl.
A simple module to handle various informational commands querying the bot’s current status and statistics, like its uptime.
Provides various commands to manipulate characters and strings.
The Success plugin spices up success replies by allowing custom messages instead of the default ‘The operation succeeded.’ message; like Dunno does for “no such command” replies.
A plugin for time-related functions.
The Todo plugin allows registered users to keep their own personal list of tasks to do, with an optional priority for each.
Provides commands for manipulating channel topics.
Keeps track of URLs posted to a channel, along with relevant context. Allows searching for URLs and returning random URLs. Also provides statistics on the URLs in the database.
Provides commands available only on Unix.
Provides commands useful to users in general. This plugin is loaded by default.
Various utility commands, mostly useful for manipulating nested commands.
This plugin allows you to view website information, like the title of a page. Also provides a Snarfer for URLs.