# $Id: README 2005/01/14 12:40:04 mferra Exp $

1. README file for ICEL
=======================

ICEL stands for Interactive Commands for E-Learning and is a stable and
optimized set of .tcl scripts to be used as a learning engine on eggdrop
based bots.  It has been coded to be used on IRC help channels and uses
a MySQL database to store the information.


2. Features
===========

*  Stable and optimized
*  Can store multiple definitions per unit
*  Fast access and the bot never floods himself off
*  Some limits user editable (see icel.tcl)
*  Redirection to channels or users
*  Search capabilities
*  Charset independent


3. Setup (general purpose)
==========================

*  cd ~
*  fetch ftp://ftp.eggheads.org/pub/eggdrop/source/1.6/eggdrop1.6.17.tar.bz2
*  tar -jxf eggdrop1.6.17.tar.bz2
*  tar -jxf mysql.mod.0.6.tar.bz2 -C eggdrop1.6.17/src/mod/
*  cd eggdrop1.6.17

*  ./configure
*  make config
*  make
*  make install DEST=~/bot

*  extract the contents (ie. the .tcl files) to ~/bot/icel
*  edit ~/bot/eggdrop.conf and add: loadmodule mysql
*  edit ~/bot/icel/icel.tcl to setup ICEL


4. Usage (use the force read the source)
========================================

*     Get:  !! <key> [id/nick/./*] [nick/./*]

      key:  the key
       id:  uniq ID
     nick:  destination nick
        .:  channel
        *:  meta information

*     Add:  !a <key> <phrase>

      key:  the key
   phrase:  text associated

*  Delete:  !d <key> [id]
*  Search:  !s <text>
*   Stats:  !i [nick]
*    Help:  !h


5. Feedback
===========

Marco Ferra <mferra_DELETE_@sdf.lonestar.org>

EOF
