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

Admin

These are commands useful for administrating the bot; they all require their caller to have the ‘admin’ capability. This plugin is loaded by default.

Aka

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).

Anonymous

Allows folks to talk through the bot anonymously.

AutoMode

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

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.experimentalExtensions is 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

BadWords

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.

Channel

Basic channel management commands. Many of these commands require their caller to have the #channel,op capability. This plugin is loaded by default.

ChannelLogger

Logs each channel to its own individual logfile.

ChannelStats

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.

Conditional

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.

Config

Handles configuration of the bot while it is running.

Ctcp

Handles standard CTCP responses to PING, TIME, SOURCE, VERSION, USERINFO, and FINGER.

DDG

Searches for results on DuckDuckGo’s web search.

Debug

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.

Dict

Commands that use the dictd protocol to define words.

In order to use this plugin you must have the following modules installed:

Dunno

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.

Factoids

Handles ‘factoids,’ little tidbits of information held in a database and available on demand via several commands.

Fediverse

Fetches information from ActivityPub servers.

Filter

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.

Format

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

GPG: Provides authentication based on GPG keys.

Games

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.

Google

Accesses Google for various things.

Hashes

Provides various hash- and encryption-related commands.

Herald

Greets users who join the channel with a recognized hostmask with a nice little greeting.

Internet

This plugin provides commands to transform domains into IP addresses and IP addresses to domains. It can also search WHOIS information and return hexips.

Karma

Plugin for keeping track of Karma for users and things in a channel.

Lart

This plugin keeps a database of larts (Luser Attitude Readjustment Tool), and larts with it.

Later

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.

Limiter

This plugin sets channel limits (MODE +l) based on plugins.Limiter.MaximumExcess plus the current number of users in the channel. This is useful to prevent flood attacks.

LogToIrc

Allows for sending the bot’s logging output to channels or users.

Math

This plugin provides a calculator, converter, a list of units and other useful math functions.

MessageParser

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/

Misc

Miscellaneous commands.

MoobotFactoids

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.

Network

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.

News

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.

NickAuth

Support authentication based on nicks and network services.

NickCapture

This module attempts to capture the bot’s nick, watching for an opportunity to switch to that nick.

Nickometer

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.

Note

A complete messaging system that allows users to leave ‘notes’ for other users that can be retrieved later.

Owner

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.

Plugin

This plugin handles various plugin-related things, such as getting help for a plugin or retrieving author info.

PluginDownloader

This plugin allows you to quickly download and install a plugin from other repositories.

Poll

Poll: Provides a simple way to vote on answers to a question

Praise

Hand out praise to IRC denizens with this plugin.

Protector

Defends a channel against actions by people who don’t have the proper capabilities, even if they have +o or +h.

Quote

Maintains a Quotes database for each channel.

QuoteGrabs

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.

RSS

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/

Relay

Handles relaying between networks.

Reply

This plugin contains various commands which elicit certain types of responses from the bot.

Scheduler

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.

SedRegex

History replacer using sed-style expressions.

Seen

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

Services: Handles management of nicks with NickServ, and ops with ChanServ; to (re)gain access to its own nick and channels.

ShrinkUrl

Shrinks URLs using various URL shortening services, like tinyurl.

Status

A simple module to handle various informational commands querying the bot’s current status and statistics, like its uptime.

String

Provides various commands to manipulate characters and strings.

Success

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.

Time

A plugin for time-related functions.

Todo

The Todo plugin allows registered users to keep their own personal list of tasks to do, with an optional priority for each.

Topic

Provides commands for manipulating channel topics.

URL

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.

Unix

Provides commands available only on Unix.

User

Provides commands useful to users in general. This plugin is loaded by default.

Utilities

Various utility commands, mostly useful for manipulating nested commands.

Web

This plugin allows you to view website information, like the title of a page. Also provides a Snarfer for URLs.