8 blootbot v1.0.0 (20000729)
9 -------------------------
12 This bot is based upon infobot-0.44.2 by kevin lenzo
13 <lenzo@cs.cmu.edu>. The basis of infobot is still there but _many_ wild
14 features have been added. Along the way, a couple of typos were spotted
15 in the original infobot source and fixed in this version. Without infobot,
16 there would be no blootbot so all thanks to kevin for bringing infobot in
20 * Additional information stored with factoids. (factinfo)
21 * Wide range of statistics for Bot, Factoids, IRC, Debian.
22 (status, factstats, ircstats, chanstats, cmdstats)
23 * Advanced topic management. (the first cool feature)
24 * Improved factoid search, allowing search by key or value.
25 * Freshmeat support (freshmeat.net)
26 * Debian Contents and Packages, search and info.
27 * ChanServ/NickServ (OPN) support.
28 * WWW-Search (eg: google for BLAH)
29 * Slashdot, Kernel and Freshmeat auto-update announcements.
30 * Units conversion (provided by external module, Units-Module)
33 - Modularity. Ability to disable IRC or Factoid support.
34 - Funky pseudo Module autoloader support
35 - Eleet Forker() function
38 * log file is not opened and closed for each line of data
39 => unblocked logging is used.
40 * seen data is not flushed for each public message on IRC
41 => caching and flushing over an interval is used.
44 As of 0.99pre1, blootbot supports mysql database in the hope to
45 increase performance and to avoid borked over dbm's which occurred when
46 the bot crashed (??). The mysql code is far larger (or perhaps twice
47 as many functions) than expected even though a few functions were needed
48 for DBM due to lack of table deficiencies.
50 As of 1.0.0pre1, blootbot takes advantage of Net::IRC. The
51 change over was fairly comfortable (95% clean). Just minor problems here
52 and there, mostly debugging and getting it right.
54 As of 1.0.0RC2, the old style DBM (Berkeley) has been ported
55 back. It should work in all but 3 specific (countdown, factstats unreq)
56 cases. preliminary pgsql support has been added but someone with pgperl
57 knowledge needs to fix it up or at least unify the module with mysql.
60 - Read the included INSTALL file
63 Be warned that this bot consumes quite a lot of memory upon start
64 up and during usage. Right now, 7.4megs is used for old'ish perl, 8.3megs
65 with perl 5.005. fork() is used but don't be alarmed at the memory usage
66 as fork(), as I was told, uses COW (copy on write).
68 WARNING: enabling wingate support may involve complaints of some
69 sort, probably because the telnet connection isn't closed properly.
70 However, these people do not realize the potential of open wingates.
72 Please beta test it and report bugs as I have not had the time to
73 test all modifications properly (and extensively). Suggestions are
76 gp@OPN is currently working on a C version of infobot or
77 blootbot, not based on the above source base. Core factoid code and
78 mysql support works - but that is it.
81 All modifications are that of the blootbot author unless otherwise
82 specified, like none. See 'ChangeLog' for details. A list of future
83 features listed in 'TODO'.
85 See 'USAGE' for complete list of commands with description
86 (FIXME) and examples (FIXME). Yes, it is incomplete. It is better for
87 you to find the cookies than for me to hand-feed them to you ;)
89 See 'EXAMPLES' for various usage of factoids and "hidden"
90 variables. If you're hardcore, check out 'CommandStubs.pl' and
91 'UserExtras.pl' for cool features.
93 topic [help] - Topic help.
94 topic add <topic> - Append <topic> to the current topic.
95 topic del <#> - Purge topic ID <#> from current topic.
96 topic list - List broken down summary of current topic.
97 topic mod s/old/new/ - Modify the topic using regex.
98 - Now supports , and # as delimiters.
99 topic mv <1> <type> <2> - <type>:
100 before - Move <1> before <2>
101 after - Move <1> after <2>
102 swap - Swap <1> and <2>
103 topic shuffle - Jumble the subtopics.
105 topic history - Show previous channel topics.
106 topic restore <#> - Restore channel topic to <#> on history
109 ==> Individual commands: NEW
110 (lobotomy|bequiet) -- [o] silence the bot.
111 (unlobotomy|benoisy) -- [o] unsilence the bot.
113 set <param> <value> -- ...
118 To administrate/control the bot remotely, this can only be done
119 through DCC CHAT. /chat <BOT NICK>. All commands must be prepended by
120 '.' otherwise it is sent to the bot chat net
123 - user statistics shown by 'seen'. bug in this?
124 - User Information Services.
125 - new wingate caching/file-read code.
126 - disabling IRC/factoid support code.
127 - PG supports need to be worked and thoroughly tested.
131 jCommons, is, netgod, mu and Mercury for attempting to break my
132 modifications, aswell as giving suggestions and ideas in the early
133 development stages. Bashing of modifications courtesy of larne, irq, lilo
136 mu@OPN for the SAR (=~ s///) and Topic history patch.
138 someone emailed me a patch to fix up telnet but I accidently
139 deleted the message together with the patch after replying to the guy. I
140 hope to get that same guy to re-send me the patch...
142 MbM@OPN sent a patch to clean up behaviour of factoids
143 (adding, removing, modifying). Thanks.
147 Contributions of a patch, or anything, can be sent to
148 <dms@users.sourceforge.net>
150 Some Documentation is on the website. Please see it for details or
151 visit: http://sourceforge.net/docman/?group_id=8794