ubottu plugins

ubotu, ubottu and all derivatives of ubottu run supybot. In addition to the core supybot code, ubottu runs a number of plugins—some official, some custom-built.

This page is supposed to give a listing of the plugins used with ubottu, and what their purpose is.

This plugin us used to manage bans. It logs every ban/mute/kick/remove done in a channel and saves a log preceding that action, it also allows comments to be stored by operators and access to this information via a web-based interface.

Configs can be configured with the command “@config <config name> <new value>”. For the case of channel specific configs, the command is “@config channel <channel name> <config name> <new value>”

Stores and retrieves factoids. Also adds ignore/unignore capabilities to factoid editors.

The Encyclopedia plugin is used to store, retrieve and edit factoids; short pieces of information triggered by a specific term. In order to add/edit/forget factoids, a user must have the editfactoids capability; to add editors, a user must have the addeditors capability.

<tsimpson> !factoid
<ubottu> Hi! I'm #ubuntu's favorite infobot, you can search my brain yourself at http://ubottu.com/factoids.cgi - Usage info: http://wiki.ubuntu.com/UbuntuBots

<tsimpson> !foo
<ubottu> Sorry, I don't know anything about foo
<tsimpson> !foo is bar
<ubottu> I'll remember that tsimpson
<tsimpson> !foo
<ubottu> foo is bar

If the format “<term> is <factoid>” is not suitable, you can use the <reply> keyword:

<tsimpson> !bar is <reply> baz
<ubottu> I'll remember that tsimpson
<tsimpson> !bar
<ubottu> baz

Editing existing factoids is done with the no keyword:

<tsimpson> !foo is <reply> bar
<ubottu> But foo already means something else.
<tsimpson> !no foo is <reply> bar
<ubottu> I'll remember that tsimpson
<tsimpson> !foo
<ubottu> bar

Factoids can also be edited with the <sed> keyword, this works similarly to the sed command-line tool:

<tsimpson> !foo
<ubottu> bar
<tsimpson> !foo is <sed> /$/./
<ubottu> I'll remember that tsimpson
<tsimpson> !foo
<ubottu> bar.

You can alias a factoid to another with the <alias> keyword, this is useful when you want more than one term to refer to the same information:

<tsimpson> !foobar
<ubottu> Sorry, I know nothing about foobar
<tsimpson> !foobar is <alias> foo
<ubottu> I'll remember that tsimpson
<tsimpson> !foobar
<ubottu> baz
<tsimpson> !no foo is <reply> FOO!
<ubottu> I'll remember that tsimpson
<tsimpson> !foobar
<ubottu> FOO!

When editing a factoid, always edit what the alias points to, so in the example above you edit “foo”, not “foobar”.

If you want to remove a factoid you use the forget keyword:

<tsimpson> !foo
<ubottu> FOO!
<tsimpson> !forget foo
<ubottu> I'll forget that tsimpson
<tsimpson> !foo
<ubottu> Sorry, I don't know anything about foo

The factoid is not deleted, just marked as forgotten. This means that attempting to add a new factoid with the same name will not work:

<tsimpson> !foo
<ubottu> Sorry, I don't know anything about foo
<tsimpson> !foo is <reply> bar
<ubottu> But foo already means something else!

You must first unforget a factoid to edit it:

<tsimpson> !unforget foo
<ubottu> I suddenly remember foo again, tsimpson
<tsimpson> !no foo is <reply> bar
<ubottu> I'll remember that tsimpson

If you are looking for a specific factoid but cannot remember which one, you can search the factoid database by factoid name or fact:

!search <string>

You can also browse and search the factoids on-line Here

Sorted by:

• Most popular first
• By date
• Alphabetical

Some information on factoids can be retrieved by using the '-' modifier when calling a factoid. This information includes information on if the factoid is an alias to another, what factoids are aliases to the factoid, when the factoid was created, and when the factoid was last modified.

You can see this information by added the '-' modifier before the factoid name:

<User> !-bot
<Bot> bot is <alias> ubotu - added by SomeNick on 2006-06-18 00:41:01 - last edited by AnotherNick on 2010-09-02 10:30:22
<User> !-ubotu
<Bot> ubotu aliases: yourself, bot, usage, factoid, brain, add, help me, syntax, factoids, everything, me, ubottu, bots, fact - added by SomeNick on 2006-06-19 12:15:56 - last edited by AnotherNick on 2010-09-18 20:14:50

The raw factoid, as it is stored in the database, can be retrieved by using the '+' modifier when calling a factoid. Sometimes it can be useful to see a raw factoid as it is stored in the database, for instance when working with variable substitutions.

You can see the raw factoid by adding the '+' modifier before the factoid name:

<User> !+ubotu
<Bot> <reply> Hi! I'm $chan's favorite infobot, you can search my brain yourself at http://ubottu.com/factoids.cgi | Usage info: http://ubottu.com/devel/wiki/Plugins | Bot channels and general info: https://wiki.ubuntu.com/IRC/Bots
<User> !+lts
<Bot> <reply> LTS means Long Term Support. LTS versions of Ubuntu will be supported for 3 years on the desktop, and 5 years on the server. The current LTS version of Ubuntu is !$curLTS ($curLTSLong $curLTSNum)

Ubottu also understands some variables and will substitute them when the factoid is called.

<User> !lts is <reply> LTS means Long Term Support. LTS versions of Ubuntu will be supported for 3 years on the desktop, and 5 years on the server. The current LTS version of Ubuntu is !$curLTS ($curLTSLong $curLTSNum)
<Bot> I'll remember that, User
<User> !lts
<Bot> LTS means Long Term Support. LTS versions of Ubuntu will be supported for 3 years on the desktop, and 5 years on the server. The current LTS version of Ubuntu is !Hardy (Hardy Herron 8.04)

This variable will be replaced with the nick-name of the bot. E.g: ubottu

This variable will be repalced with the nick-name of the person who called the factoid. E.g: tsimpson

This variable will be replaced with the current channel the factoid is called in. E.g: #ubuntu

This variable will be replaced with the name of the current stable version of Ubuntu. E.g: Jaunty

This variable will be replaced with the long name of current stable version of Ubuntu. E.g: Jaunty Jackalope

Same as $curStable, but lower-case.

This variable will be replaced with the version number of the current stable version of Ubuntu. E.g: 9.04

This variable will be replaced with the name of the current stable version of Ubuntu. E.g: Hardy

This variable will be replaced with the long name of current stable version of Ubuntu. E.g: Hardy Heron

Same as $curLTS, but lower-case.

This variable will be replaced with the version number of the current stable version of Ubuntu. E.g: 8.04

This variable will be replaced with the name of the current stable version of Ubuntu. E.g: Karmic

This variable will be replaced with the long name of current stable version of Ubuntu. E.g: Karmic Koala

Same as $curDevel, but lower-case.

This variable will be replaced with the version number of the current stable version of Ubuntu. E.g: 9.10

Configs can be configured with the command “@config <config name> <new value>”. For the case of channel specific configs, the command is “@config channel <channel name> <config name> <new value>”

This plugin is used to allow users to login without a password and automatically update the user list from the Ubuntu IRC Operators Launchpad team.