Minime is an op-bot.  He distinguishes himself from other op-bots by handling multiple channels (including keyed channels) fairly elegantly and by using MySQL as his backend.  This latter feature is of dubious utility.

When you start Minime for the first time, he will just sit on the server without joining a channel.  To make him join a channel send him the command "join #channel_name [key]" via private message.  This will also create an "ownerlist" for the channel and add your nick to it.

Minime essentially handles three kinds of list.  For each channel in his database, there is an "ownerlist", a "trustedlist" and an "ignorelist".  This last contains the nicks that he will always ignore (useful for other bots, etc).

If your nick is on the ownerlist for a channel, you have the right to tell Minime to join and leave that channel, and to add and remove people from the channel lists.  If your nick is on the trustedlist for that channel, Minime will op you when you join it (assuming that he is already on that channel, and has ops).  Note that being a channel owner does not automatically get you ops.

To add a new channel to Minime's database, simply tell him to join it (as described above), or add a nick to the non-existent channel's ownerlist.  Both of these actions will result in your being added to a new ownerlist for the channel, assuming that it really was a new channel you were asking him to join!

To remove a channel and its associated lists from Minime's database, remove every nick from the ownerlist.

All Minime's commands can be performed on- or off-channel; in the latter case you must always specify what channel you're talking about!

Minime's commands are as follows: (square brackets indicate optional parameters)

"join #channel [key]" - joins #channel, optionally with the given key
"leave #channel" - leaves #channel
"ownerlist [for #channel] add nick1 [nick2 nick3 etc]" - adds the given nick(s) to the current or specified channel's ownerlist
"trustedlist [for #channel] add nick1 [nick2 nick3 etc]" - guess
"ignorelist [for #channel] remove nick1 [nick2 nick3 etc]" - guess again
"trustedlist [for #channel] list" - lists all the nicks on the trustedlist for the current or specified channel

When you restart Minime, he retains all his prior knowledge and should hopefully rejoin all the channels he was on before.

For online help, try asking Minime for "help".

Minime only works on servers/channels where the users are relatively trustworthy: there's nothing built in to stop someone from changing nick to someone on a channel's ownerlist and completely messing up the lists.

The maximum number of entries in a list is undefined.

Minime is released under the GPL version 2 - see COPYING for details.

Minime includes a copy of the Pircbot Java IRC API, also licensed under the GPL, and available separately from http://www.jibble.org/pircbot.php

Minime includes a copy of the MM Mysql JDBC drivers, licensed under the LGPL and available separately from http://mmmysql.sourceforge.net/old-index.html.
See http://www.gnu.org/copyleft/lesser.html for details of the LGPL.

Steve Jolly, May 2004
