(large commit, see bazaar log)
[Bantracker] * Less spaces in README.txt * Remove mention of table 'users' in README.txt * Add more detail on how to create the bans database in README.txt * Add note about supybot-wizard creating the initial database in README.txt * Don't hard-code default values in config.py:configure() * Tweak config.py * Clean up bans.cgi a bit [Bugtracker] * Comment-out obsolete "bug reporting" variables in config.py * Update README.txt and remove "bug reporting" stuff, also remove extraneous license info * Comment-out obsolete "bug reporting" code * Don't import imaplib [Encyclopedia] * Don't hard-code default values in config.py:configure() * Check for 'owner' capability before checking if the hostmask is ignored in plugin.py:checkIgnored() * Clean up README.txt [PackageInfo] * Don't hard-code default values in config.py:configure() * Update default distributions in config.py:configure() * Update defaultRelease in config.py * Update README.txt * Add a few docstrings to commoncgi.py * Update COPYING * Update README.txt
This commit is contained in:
35
README.txt
35
README.txt
@ -6,8 +6,9 @@ setting up an ubottu clone for the first time.
|
||||
These plugins are designed to work with Python 2.5 and Python 2.6, they are
|
||||
untested and unsupported on Python 3.0. 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". After that you should make sure you have the
|
||||
following installed on the system:
|
||||
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 following installed on the system:
|
||||
|
||||
Name Debian/Ubuntu package Website
|
||||
Python-apt python-apt N/A Debian (and derivatives) only
|
||||
@ -19,6 +20,8 @@ SOAPpy python-soappy http://soapy.sourceforge.net/
|
||||
Launchpadlib python-launchpadlib https://launchpad.net/launchpadlib
|
||||
apt-file apt-file N/A Debian (and derivatives) only
|
||||
|
||||
Launchpadlib will become a required module for Bugtracker (and possibly others)
|
||||
|
||||
Once these packages are installed, and in the bot directory containing the
|
||||
"plugins" sub-directory, run this command: "supybot-wizard".
|
||||
This wizard will guide you through the process of setting up the bot for an IRC
|
||||
@ -32,11 +35,11 @@ Bantracker Helps to track bans/kicks/quiets/removes in channels
|
||||
Bugtracker Show information on bugs for various bug trackers.
|
||||
Encyclopedia A factoid encyclopaedia.
|
||||
IRCLogin Allows password-less login from users identified to services.
|
||||
Lart A database of "larts".
|
||||
Mess Random mess, pulls random things from the internet.
|
||||
Lart A database of "larts". (Unmaintained)
|
||||
Mess Random mess, pulls random things from the internet. (Unmaintained)
|
||||
PackageInfo Lookup information on Debian packages and file search.
|
||||
(works on Debian and derivatives only)
|
||||
Webcal Updates a channel topic based on events in an iCal.
|
||||
(works on Debian and derivatives only, unless you take special measures)
|
||||
Webcal Updates a channel topic based on events in an iCal. (Unmaintained)
|
||||
|
||||
Note: Mess and Lart are largely unmaintained but are working, Webcal is
|
||||
unmaintained and mostly broken except for extremely simple iCal feeds.
|
||||
@ -44,12 +47,16 @@ unmaintained and mostly broken except for extremely simple iCal feeds.
|
||||
If you chose to enable Bantracker or Encyclopedia, initial databases will be
|
||||
created in the "data" directory. These are named "bans.db" for the Bantracker
|
||||
plugin and "ubuntu.db" for the Encyclopedia plugin. You can obtain the same
|
||||
database that ubottu uses by overwriting the "bans/ubuntu.db" file with the one
|
||||
database that ubottu uses by overwriting the "ubuntu.db" file with the one
|
||||
located at http://ubottu.com/ubuntu.db or by running the "@sync" command with
|
||||
the bot in 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
|
||||
the bot in IRC.
|
||||
The Bantracker database from ubottu is not available to the
|
||||
public, as it will contain logs of channels which are not publically logged.
|
||||
|
||||
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.
|
||||
The same is true for the "update_apt_file" script, which will only be ran if
|
||||
@ -62,5 +69,7 @@ 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
|
||||
PacakgeInfo. If you weren't asked, it defaults to '!'. The recommended
|
||||
character is '@'.
|
||||
PacakgeInfo. 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.
|
||||
|
||||
|
Reference in New Issue
Block a user