This directory contains the supybot plugins that allow you to create a clone of
ubottu for your channels. This file contains some basic setup information that
will be useful when setting up an ubottu clone for the first time.

The recommended way to set up these plugins is to first create a directory for
the bot, then move this directory to there and rename it to "plugins".
Alternatively you can create an empty plugins directory and create links to
each separate plugin directory inside there. After that you should make sure
you have the packages listed in the requirements.txt for the relevant plugins
installed on the system.

Then in the bot directory containing the "plugins" sub-directory, run the
command "supybot-wizard". This wizard will guide you through the process of
setting up the bot for an IRC network. You should use the default answers when
unsure. When the wizard asks "Would you like to look at plugins individually?"
answer "y", there you will be presented with a list of plugins to choose.

If you enabled the Encyclopedia plugin, an initial database will be created in
the "data" directory and will be named "ubuntu.db". You can obtain the same
database that ubottu uses by overwriting the file with the one located at
<https://ubottu.com/ubuntu.db> or by running the "@sync" command on the bot
from IRC.

If you enabled the PackageInfo plugin, several .list files will be created in
"data/aptdir/", these will be used with the "apt-cache" and "apt-file" commands
to retrieve package information and find files within packages. When asked if
you want to run the "update_apt" script you should answer "y" to download the
package information, this will take a while depending on the speed of your
connection and proximity to the default servers. You should then edit the
script replacing the path in "DIR=/home/bot/aptdir" with the path to your
aptdir, which should be under "data/aptdir" in your bot directory. You can then
set up a cron job that will run the script daily, weekly or monthly. The script
should be run as the user the bot is run as.

Once you have selected the plugins you want to enable, you will be asked "Would
you like to set the prefix char(s) for your bot?", you should answer "y" and
set it to anything other than the prefix character for Encyclopedia and
PackageInfo. If you weren't asked, it defaults to '!' for those plugins. The
recommended character to use is '@'. Do not set the prefix chacter for commands
and for the plugins to the same value, you will run into trouble.