Limnoria plugins

Introduction

@list

Lists all plugins loaded in the bot

@list <Plugin>

Lists all commands available in the given Plugin

@help <command>

Shows how to use a command and what it does

@config list supybot.plugins.<Plugin>

Lists configuration variables provided by the Plugin. See the configuration system documentation for details on how to get more information on configuration variables.

Messaging

Later

Allows anyone to send a message to someone while they are offline. The bot will send them the message when they are back online.

Note

Similar to Later, but with some authentication. It allows any user to send messages to other users, as long as they are registered to the bot.

Relay, LinkRelay, RelayNext

Relay messages across multiple channel/networks. Useful if your community is split between different networks, but you want everyone to communicate with each other.
LinkRelay and RelayNext are third-party plugins, you can get them with the commands: pip3 install 'git+https://github.com/progval/Supybot-plugins.git#subdirectory=LinkRelay' and pip3 install 'git+https://github.com/jlu5/Limnoria-RelayNext'

SedRegex

Allows you to "fix" a typo or mistake in a previous message. For example, if you wrote "I love pipes" and realize your mistake, you can write "s/pipes/pies/" and the bot will reply "X meant to say: I love pies".

Factoids and quotes

Factoids and MoobotFactoids

Classic IRC factoids: allow users to "teach" the bot information about a word, and recall it later. Very useful on help channels to provide links to new users and answer Frequently Asked Questions. Factoids and MoobotFactoids provide the same function but with a different flavor in their interface.

Quote

Allows users to register arbitrary quotes, and recall them later.

QuoteGrabs

Similar to Quotes, but only allows quoting something a user said recently in the same channel.

Internet utilities

Math

News

RSS

Provides access to RSS feeds, and announces them automatically on channels.

NuWeather

Provides commands to display the current weather and forecasts. This is a third-party plugin, you must install it with the command: pip3 install 'git+https://github.com/jlu5/Limnoria-NuWeather'

Development Forges

Creating custom commands

Limnoria allows you to create custom commands, that may call other commands themselves (aka. nested commands). This allows you powerful customization of your bot, without writing a single line of code.

This may remind you of shell scripting, but with [subcommand arg1 arg2] instead of $(subcommand arg1 arg2).

The following plugins provide handy commands to create your own custom commands.

Aka, Alias

Allows you to create a command with a name, that users can call like any other command. (Alias is the ancestor of Aka, and is only kept for backward compatibility, you usually won't use it anymore.)

Conditional

Provides commands that call other commands conditionally. For example, this allows you to run a command only if a target user is in the channel.

MessageParser

Allows you to configure triggers (regular expressions), that will automatically run a command when a user says something (a word, a message full of upper-case letters, numbers, ...).

Filter, Format, String, Utilities

Provide various utility commands, check them out with @list Utilities.

Scheduler

Allows you to run a command some time in the future; or at a recurring interval.

Bot management

Admin

Provides commands for bot administrators; mostly permission management and joining/leaving channels.

Config

Provides all the commands to configure the bot, see the documentation of the configuration system.

Owner

Provides commands for the bot owner: renaming commands, stopping the bot, granting capabilities globally to users.

Network

Provides commands to connect and disconnect to IRC networks, send whois queries, get latency, and network statistics.

PluginDownloader

Allows you to download and install third-party plugins from IRC -- without touching the shell

Services

Authenticates the bot to network services (eg. NickServ). Nowadays, this is usually not needed anymore, as most network support standard IRC authentication (SASL).

Channel management

AutoMode

Allows you to automatically make users op (+o) or voice (+v) when they join, or ban them (+b).

BadWords

Prevents the bot from saying some words, and/or to kick users who use them.

Channel

Generic commands to manage a channel: adding capabilities to users within a channel, ignoring users, opping/voicing, making the bot silent.

ChanTracker

Advanced ban management tracking, designed for operators of large channels This is a third-party plugin; you must install it with the shell command: cd ~/yourbot/plugins/; git clone https://github.com/ncoevoet/ChanTracker.git

ChannelLogger

Writes channel logs on disk

Protector

Automatically restores op status of users supposed to be op, if they happen to be deopped by someone.

Topic

Allows users to add and remove sections to the topic. Handy if you don't want to rewrite the whole topic every time.

User management

GPG

Allows users to authenticate to their account without a password, using their GnuPG key.

NickAuth

Allows users to authenticate to their account without a password, using their existing account with network services. (This only works on networks that provide this kind of service, usually called NickServ.)

User

Provides commands for users to manage their own accounts: registration, login, adding a hostmask to their account (to be recognized automatically).

And more!

• Anonymous
• ChannelStats
• Ctcp
• Debug
• Dict
• Dunno
• Games
• Hashes
• Herald
• Karma
• Lart
• Limiter
• Misc
• News
• NickCapture
• Nickometer
• Plugin
• Praise
• Relay
• Reply
• Seen
• Status
• Success
• Time
• Todo
• Unix
• URL