Mikaela
/
Limnoria
mirror of https://github.com/Mikaela/Limnoria.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated, mostly (if not completely) finished.

This commit is contained in:
Jeremy Fincher 2004-02-08 03:56:10 +00:00
parent e1f3393015
commit 244a0b9826
1 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/GETTING_STARTED
View File

@ -70,11 +70,19 @@ other plugins. If you didn't use supybot-wizard, though, you might
do well to try it before playing around with loading plugins
yourself: each plugin has its own configure function that the wizard
uses to setup the appropriate registry entries if the plugin requires
any. ### TODO: Make a command to list loadable plugins?
any.
Now, if you do want to play around with loading plugins, you're going
to need to have the owner capability.
# TODO: wizard or supybot-adduser.
to need to have the owner capability. If you ran the wizard, then
chances are you already added an owner user for yourself. If not,
however, you can add one via the handy-dandy supybot-adduser script.
You'll want to run it while the bot it's running (otherwise it could
overwrite supybot-adduser's changes to your user database before you
get a chance to reload them). Just follow the prompts, and when it
asks if you want to give the user any capabilities, say yes and then
give yourself the "owner" capability (without the quotes), restart the
bot and you'll be ready to load some plugins!
Now, in order for the bot to recognize you as your owner user, you'll
have to identify with the bot. Open up a query window in your irc
client (/query should do it; if not, just know that you can't
@ -111,14 +119,22 @@ So the command above adds the hostmask I'm currently using to my
user's list of recognized hostmasks. I'm only required to give
mypassword if I'm not already identified with the bot.
# TODO: Explain the more command. Possibly find a config variable
# with a long help.
# TODO: Explain the Config plugin.
Another command you might find yourself needing somewhat often is the
"more" command. The IRC protocol limits messages to 512 bytes, 60 or
so of which must be devoted to some bookkeeping. Sometimes, however,
Supybot wants to send a message that's longer than that. What it
does, then, is break it into "chunks" and send the first one,
following it with "(X more messages)" where X is how many more chunks
there are. To get to these chunks, use the more command. One way to
try is to look at the help for the configuration variable
"supybot.defaultCapabilities". Last I checked, it'll overflow into a
second chunk. The command you'll need to do this is "config help
supybot.defaultCapabilities".
Enjoy using Supybot!
### TODO: Local installs.
### TODO: Explain how to run tests?
# Common problems
# import error in http (relies on python-xml)
# import error in database-based plugins.
###
# Addenda
###
Local installs: See this forum post: http://tinyurl.com/2tb37