Readme for botnetop.mod
by Teemu Hjelt <temex@iki.fi>


Table of Contents
==================

 1. Introduction
 2. Installation
 3. Tcl commands
 4. Tcl variables
 5. TODO list
 6. Feedback
 7. Latest version
 8. Credits
 9. License


1. Introduction
================

botnetop.mod is based on botnetop.tcl written by slennox and was 
written in C from scratch by Teemu Hjelt. botnetop.mod allows linked
bots to request and give ops to each other. It can also invite linked
bots to invite-only channels, share keys with them, raise channels' 
limits and unban them.


2. Installation
================

botnetop.mod requires Eggdrop 1.5.0 or better and the irc, server 
and channel modules need to be loaded. You also need the source code
of Eggdrop to compile this module.

1. Go to the directory where you have extracted the Eggdrop tarball.
2. Go to src/mod/ directory and copy the botnetop.mod tarball there.
3. Type "tar zxvf botnetop.mod-x.x.x.tar.gz"
4. Configure and compile your bot like you would normally do it.
   (./configure -> make config -> make -> make install)

All botnetop.mod settings can be found from the botnetop.conf file.
You can either copy it to your eggdrop directory, edit it to fit 
your needs and then add line "source botnetop.conf" to your eggdrop
config file or you can just copy the contents of the file and paste it 
to your eggdrop config file. If you want to use the default settings
all you need to do is to add line "loadmodule botnetop" to your eggdrop
config file. The last thing is to (re)start or rehash your bot and hope 
for the best :)


3. Tcl commands
================

There are currently two Tcl commands provided by botnetop.mod:

bop_reqop <channel>
  Makes the bot request ops for <channel> from
  bots who are currently opped.

bop_letmein <needthis> <channel>
  Makes the bot request <needthis> for <channel> from all
  linked bots. <needthis> can be needinvite, needlimit
  needkey or needunban.


4. Tcl variables
=================

There are currently nine Tcl variables provided by botnetop.mod:

bop_delay
  Maximum number of seconds to delay before asking a non-opped bot 
  if it needs ops. Set to 0 to disable.

bop_maxreq
  Maximum number of bots to request ops from at a time. Set to 0 
  to disable.

bop_modeop [0/1]
  Make the bot send an op request when it sees a bot become opped on a 
  channel? This will make your bot get ops sooner when another bot is 
  given ops.

bop_linkop [0/1]
  Make the bot send an op request when a bot links? This will make your bot 
  get ops sooner if linking is delayed, and provides a better chance of the 
  bots opping one another if there are linking problems.

bop_icheck [0/1]
  Check bot's userhost before inviting it to a channel?

bop_osync [0/1]
  Make the bot give ops to a bot even if it looks like it's already opped
  on the channel?

bop_addhost [0/1]
  Make the bot to try add new hostmasks for bots?

bop_setneed [0/1]
  Set need settings when the bot joins a channel? This is kind of useless
  now because botnetop.mod uses need bindings.

bop_log [0/1/2]
  Set this to 2 to enable all logging, 1 to disable logging of ops/op
  requests and 0 to disable all logging.


5. TODO list
=============

* Compatibility with GetOps. (?)
* Less botnet traffic.


6. Feedback
============

Send all suggestions, questions, comments, bug reports and patches
to temex@iki.fi. If you send a patch, please use diff -bur format.


7. Latest version
==================

The main site for botnetop.mod is:
http://www.iki.fi/temex/eggdrop/

You can obtain the latest version from the site above 
or via CVS by typing the following lines to your shell:
1. cvs -d :pserver:anonymous@cvs.eggheads.org:/usr/local/eggheads login
   (when CVS asks for a password just press enter)
2. cvs -d :pserver:anonymous@cvs.eggheads.org:/usr/local/eggheads checkout botnetop.mod

The CVS web is available at:
http://www.eggheads.org/cgi-bin/cvsweb/botnetop.mod/?cvsroot=Eggheads


8. Credits
===========

The author wants to thank the following people (in alphabetical order):

* daimonic for beta testing.
* Fabian for helping whenever I needed help.
* G`Quann for helping in C problems.
* guruz for beta testing and telling bad jokes.
* guppy for solving few problems and setting up the CVS.
* Johoho for beta testing.
* NML_375 for helping with pointers.
* slennox for coding botnetop.tcl
* SuperS for ideas and suggestions.
* Wull for helping with structures.


9. License
===========

botnetop.mod was written by Teemu Hjelt and is released to the public under
the terms of GNU General Public License. For the complete license, please 
see the file called COPYING.


Copyright (C) 2000  Teemu Hjelt <temex@iki.fi>
