
WHAT IS IT?
----------

ETETE (Eden's TCL Extensions To Eggdrop) is a set of libraries of 
TCL commands for use with eggdrop bots.  Some commands add new 
functionality to the bot, others emulate eggdrop DCC CHAT commands 
using /msg.

Some of the TCL commands added are quite simple, while some are more
complex.  This library is *not* meant as a tutorial on how to write TCL
commands for eggdrop bots -- for that, choose some of the smaller scripts
about.

At the moment, there are three libraries provided:

  misc.tcl	- provides miscellaneous commands for most users.  
  defence.tcl	- provides defence commands for the bot, accessible using /msg.
		  Includes commands for kicking, banning, etc.
		  It is intended to augment the bots built-in defences, not
		  override them.  
  master.tcl	- provides commands for masters to manipulate user records, etc.
		  It is basically a /msg interface to what's available in
		  the existing DCC CHAT interface to eggdrop.

To find out what commands are available, look at the help files provided.
The miscellaneous commands are in help/help (together with the standard
eggdrop /msg commands), the defence commands are in help/defence, and
master commands are in help/master.


HOW DO I INSTALL IT?
-------------------

The easiest way is to edit the Makefile provided, to change the directories
as appropriate, and then type "make".

However, if you'd prefer to do it manually, read on ...

Two directories are provided:

  scripts/	- the TCL scripts
  help/		- associated help files

To install the ETETE libraries:

  1.  Copy the TCL scripts into your favourite place for putting bot scripts.

  2.  Edit the egg.config file for your bot to include the following lines:

	source scripts/misc.tcl
	source scripts/defence.tcl
	source scripts/master.tcl

      (where "scripts/" is assumed to be your TCL scripts directory -- you
      should change it as appropriate).

  3.  Copy the help files into your bot's help directory.
      Note that a couple of the scripts will overwrite the default help
      files.  You may wish to edit these by hand if you don't feel
      comfortable with overwriting the default.  These include the files:
      help, invite.

And that should be it.  

One more thing you need to do is set a default channel topic in your bot's
config file.  Add a line to the config file like:

set topic "This is the default channel topic!"

Now make your bot re-read it's config files, either
by typing the command ".rehash" in DCC CHAT mode, or "/msg BOT REHASH <pass>".
The new commands are now installed and active.



BORING STUFF
------------

The TCL code in these libraries remains copyright to me, Wayne Brookes,
but I grant anyone permission to use it, provided this notice remains in
place.  You may modify the code, but not distribute modified versions of
it with my name on it.  Eggdrop remains copyright of it's author.  Many of
the help files provided herein are based heavily on help files provided
with eggdrop.  All help text written by the author of eggdrop remains
copyright to him.  Oh, and I should add that none of this TCL code comes
with any warranty of any kind -- use it at your own expense, and don't
blame me if something goes wrong!



COMMENTS, SUGGESTIONS, PROBLEMS??
-------------------------------

If you have any comments, suggestions for other TCL commands you'd like to
see, or if you find any problems with the TCL, you can either e-mail me 
at <brookes@cs.uq.oz.au>, or leave an eggdrop note to Eden@Priscilla.



Wayne Brookes
brookes@cs.uq.oz.au
a.k.a. Eden@Priscilla
February 1995.

