Eggdrop Tcl Archive

Extended Description File

.     _   _          _            __         
   __| | (_)   ___  (_)  _ __    / _|   ___  
  / _` | | |  / __| | | | '_ \  | |_   / _ \ 
 | (_| | | | | (__  | | | | | | |  _| | (_) |
  \____| |_|  \___| |_| |_| |_| |_|    \___/ 
              learn engine for eggdrops 1.6.x


developer(s)
============

* Main tcls:
Marco (fourier) Ferra <mferra@users.sourceforge.net>

* PHP search interface: (php/ directory)
Carlos (r3pek) Silva <r3pek@r3pek.homelinux.org>

* Code enhances:
ardoRic <ardoric@aliensheep.net>

http://dicinfo.sourceforge.net

List:  https://lists.sourceforge.net/lists/listinfo/dicinfo-devel
Mail:  <dicinfo-devel@lists.sourceforge.net>


intro
=====

dicinfo is a set of tcl scripts to use on eggdrop 1.6.x.  It provides an
infobot to use on IRC (help) channels.  It acts like a requestable database
and it's a robust and versatile system.

Issue !dic on a channel for the commands list.


features
========

* database is saved on a text file
* different or shared database files for each channel
* timestamps conform to rfc3339 (internet date/time)
* able to send the database file through DCC
* support for multiple definitions per key
* simple database search capabilities
* simple usage and contribution statistics
* online search through a set of php scripts


conceptual goals
================

* be stable and fast
* extensible and maintainable


installation
============

To use dicinfo all the .tcl files should be in the same directory and dic.tcl
should be loaded in eggdrop.conf using "source path/to/dic.tcl".

On dic.tcl and dic-cmd.tcl you can specify what should be the flags permitted
to modify/access the definitions.  These are:

lflag(get) - flag to obtain information
lflag(cmd) - flag to the other mortals (not quite but...)

lfile(cmm) - common database file for channels
lfile(cms) - use (1) or not (0) the common database

lfile(max) - # of chars that each definition can be (def. 192)
lfile(def) - # of definitions that a key can have (def. 10)

By default all users can obtain information and only +f flagged users can
add/erase the keys.  (see the internals of dic-cmd.tcl).  Use the !dic trigger
to learn more about the arguments and their options.  Documentation is not
extensive but all the usage is there.


dic.dat format
==============

yyyy-mm-ddThh:nn:ssZ nick unikey long-spaced-description

The timestamp (the 1st field) on dic.dat conforms to RFC3339.
(see http://www.ietf.org/rfc/rfc3339.txt)


bug reports
===========

Patches or bug reports should be mailed to <mferra@users.sourceforge.net>.
Some feedback about the usage and experience with dicinfo is also appreciated.

Enjoy dicinfo

"The spice must flow."  (Baron Harkonnen, Dune)