Eggdrop Tcl Archive

Extended Description File

============================= QUOTE TCL V3.52 BY STIGMATA =====
=== SCRIPT INFORMATION
=== INSTALLATION INSTRUCTIONS
=== CONTACT THE AUTHOR
============================= QUOTE TCL V3.52 BY STIGMATA =====

----
SCRIPT INFORMATION
----

    A few years ago, I wanted to run a quote script on my Eggdrop.
I tried many different scripts, but I was unhappy with all of them.
They lacked features, had bugs, and were generally nuissances.
So, I decided to embark on a mission. My mission was to create a
quote script suitable to my own needs, and possibly others who have
encountered the same problem.

I took the best script I could find at the time, Koloth's Quote
Script and chopped it up and rewrote things for speed, effeciency,
and security. Noble by thine cause, it was a daunting task
(at least for me). After getting the basics working well and
removing the security problems, I left the script alone for a
long time. Every now and then I would slap on a new feature, squash
a bug or two but nothing really substantial. Also during that time
period between my initial public release and 3.xx's, I received
numerous requests for a searching feature.

This, my friends was my hardest task to accomplish. I created many
working search procedures, but they were slow and handled the
results horribly. Just recently (past few days), it dawned on me:
I could use grep to search and have it produce workable results.
This was a wonderful development in Quote TCL's history, because
it beat the Hell out of any search procedures I wrote in TCL.
It was extremely fast, simple, and could be used to generate a file
with the results. The results file comes complete with line numbers
and the quotes themselves. This may sound like it creates a bunch
of text files on your shell and will eat up your quota quickly, but
I cleverly came up with a solution: remove the file after DCC
sending it to the user.

So, the script has nearly everything anyone could want. It's got
adding, deleting, searching, selecting, random selection, display
of the last quote added, quote totals, script request,
file request, help file sending,  flood protection and all of
those commands available in channels/messages/DCC chat (save file
request binds). Certain commands are not available in DCC chat
because of obvious reasons of course. In channel and private
message commands are all protected by the awesome flood protection
power of the BSeen script, so you need not worry about pesky
flooders. Future features for the quote script may be things such
as auto backup of the quote storage file, allowing only public or
message commands, easy customization of how the script displays
your quotes, automatic e-mailing of the quote file to the
administrator, and allowing the public commands in only specified
channels. Don't expect these anytime soon, however. I am very lazy
and it takes a lot for me to get into writing code.
Enjoy the script you have now, I put a lot of effort into it. :)

----
INSTALLATION INSTRUCTIONS
----

To install, simply follow these instructions below:

(1) Extract the tarball (quote_tcl-x.xx.tar.gz) to your home
directory. (Yay! You're one step closer to finishing the
installation if you're reading this!)

(2) Change directory to quote_tcl-x.xx and use your favorite UNIX
editor to tailor quote_tcl-x.xx.tcl to your needs.
Descriptions for the settings are inside the script already; no
need to fret. Complete the process by saving your
changes and exiting.

(3) Once you're done editing the TCL file, copy the script AND the
tarball to your bots scripts/ directory. It is REQUIRED that the
tar.gz be in your scripts directory, or else !getscript will fail! 

(4) After copying those two files, place quote.txt and
quote_help.txt in your bot's root directory (the place where you
start your eggdrop from).
If this is not done, the script is useless.

(5) Finally, again fire up your favorite editor and open up your
Eggdrop's configuration file. At the bottom in the scripts section,
add "source scripts/quote_tcl-x.xx.tcl" (omit the quotes) to
the list. Save your changes and exit.

(6) When all above is done, complete the process by DCC chatting
or telnet'ing your bot and rehasing it. The script
should load and work like a dream! Enjoy it!

----
CONTACTING THE AUTHOR
----

Have any questions, bug reports, comments, or flames you'd like me
to hear? Feel free to contact me in any way you wish, I'd love to
hear your opinion on my script, good or bad, feature request or
bug report.
I am on EFNet in #zsnesboard as (normally) [stig] or [st1gg0r].
Message me your thoughts and if I'm around, I'll get back to you.
If you prefer to contact me via email, stigmata@hvc.rr.com is my
email address. Please, have some maturity and respect
and do not spam me. Au revoir!

----
Date of creation: Sunday April 26th, 2002
Author: stigmata
Email: stigmata@hvc.rr.com
IRC: EFNet, [st1gg0r] OR [stig]
----