mikaela.github.io/pages/irc/bot.markdown

Please read also rules of my channels.

• Web interface
  • Plugin documentation

Limnoria

My bot is Limnoria which is currently the most popular Supybot fork that is still under active development and it has merged in features of another popular fork, Gribble.

My role with Limnoria was Finnish translator and IRC support and I also made minor changes to make some default configuration variables more sane. Most of documentation since Supybot and before my leaving is also written by me.

• Blog: Leaving Limnoria
• Blog: My background on Limnoria

Usage

Addressing the bot

The following table opens where the bot will reply to in channel. In PM the bot replies to everything (without prefix).

Replies to	Examples	Changeable per-channel
prefix characters: % + !	+ping %ping +ping	Yes
nick in the beginning and end	bot: ping ping, bot	Yes (not nick), but why?
prefix strings: msb1 & msb2 (for legacy reasons) and __	msb1ping msb2ping __ping	Yes
MessageParser (in the middle of line): & ()	Does the bot work? ping for single-worded commands and what is Linux? (wiki Linux) for commands with multiple words.	no (too difficult, but possible)

For checking the channel specific prefixes, refer to the following commands. They can be used in channel (if you know the prefix) or PM.

<tr>
    <td>prefix strings</td>
    <td><code>channel reply.whenAddressedBy.strings</code>
</tr>

Prefix	Command
Prefix characters	channel reply.whenAddressedBy.chars
Nick (beginning & end)	channel reply.whenAddressedBy.nick and channel reply.whenAddressedBy.nick.atEnd

Quick start

Use list command to get list of plugins, list <plugin> to get list of commands in plugin, help <plugin> <command> to get usage instructions for <command> in <plugin>.

If the bot tells you (X more messages), use the more command to see more output.

There are also default plugins which means that when you use only <command> the command is automatically understood as <plugin> <command> for example tell is configured to be later tell which tells text to nick next time it’s seen. If command exists only in one plugin, it’s gets turned to <plugin> <command> automatically.

In case command exists in multiple plugins, the bot will tell you that the command exists in multiple plugins and asks you to specify the plugin before it.

Users

The bot doesn’t allow anyone to register and I will register channel ops manually on the channels the bot is on. Users are primarily identified by NickServ account, but on networks where there are no services it’s required to use hostmasks.

Requirements for getting account:

• being op on channel where the bot is on or similar good reason
• having NickServ account
  • or on networks where there are no services, identd and static host.
    • identd alone is not enough.

Identifying

All users have a password in the bot, but I have made them invalid (by adding ! in front of the hash in users.conf). If you have password set separately as said below, it will work.

• If you have a password, /msg <bot> user identify username password
  • Passwords can be asked from me if needed. After getting one, change it immediately with /msg <bot> user set password OLDPASSWORD NEWPASSWORD
• If you use NickServ account:
  • Use the auth command.
  • /cycle so extended-join sends your account name to the bot.
  • /kick <bot> so the bot will automatically rejoin and send whox requests to the channel receiving your NickServ account.
• Other methods / Official documentation

Channels

List of the channels where the bot is on can be seen with /whois. However this list doesn’t include secret/private channels (mode +s/+p).

The bot can also be requested to join other channels, but I reserve the right to not join it anywhere or to not register specific channel ops to the bot.

What does the bot do?

Currently the bot is primarily spamming my channels with new items in some RSS feeds. You can find list of the feeds added to the bot at the web documentation for RSS plugin, but listing the feeds automatically announced on the channel isn’t possible yet.

It’s also protecting channels from spam using the AttackProtector plugin.

The bot also has ops command for getting op attention, but it requires correct prefix to be used.

Issues you may encounter

For all known issues, see the issue tracker link below relevant subtopic as this section only lists those that you are likely to see or that others have asked about from me.

I am trying to run the latest released version of Limnoria.

External plugins are updated whenever I see need for it, but at least when I upgrade Limnoria.

Limnoria issues

• Issue tracker: https://github.com/ProgVal/Limnoria/issues

Includes Limnoria core and included plugins.

• Title is only told for the first link in a message
• Some commands using hostmasks behave weirdly
• Users cannot log out
  • no idea why they would want to do that though.
• There is no way to add capabilities to group of users
• Users cannot change their usernames
  • so ping me instead if you need it changed
• Meta descriptions for links aren’t told
  • these could be useful with news sites.
• DNS command doesn’t mention CNAMEs/ALIASes
• Internet whois is quite broken 1 2
• RSS: no announced feeds in web interface
• html/javascript redirects aren’t followed
  • you will especially see this if you encounter links to my “URL shortener”
• Google says: Error invalid resultSize
• Web title & titlesnarfer are broken

ProgVal/Supybot-plugins issues

• Issue tracker: https://github.com/ProgVal/Supybot-plugins/issues

Includes plugins from @ProgVal’s/pinkieval’s plugin repository.

• LinkRelay
  • Doesn’t sync topics between relayed channels
  • Status of user in the channel isn’t shown
  • What the bot says isn’t relayed.
    • This is currently the most visible issue on channels where LinkRelay is used.