README

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