Go to file
Pragmatic Software 7aa724569e factfind now works; find aliases factfind for all channels 2010-06-29 04:33:27 +00:00
PBot factfind now works; find aliases factfind for all channels 2010-06-29 04:33:27 +00:00
build Move $VERSION out of PBot.pm and to its own VERSION.pm module 2010-06-05 04:34:14 +00:00
config Changed format of HashObject save-file to be more like DualIndexHashObject; removed need for index_key 2010-06-23 06:51:39 +00:00
data factfind now works; find aliases factfind for all channels 2010-06-29 04:33:27 +00:00
modules Updating modules 2010-06-27 02:52:38 +00:00
README Quieting now does +b instead of +q, so it is compatible with all ircds. Updating README 2010-06-04 04:38:42 +00:00
pbot.pl unban_timeouts is now a HashObject -- consequently, unban timeouts now save to and load from data file 2010-06-18 10:46:23 +00:00
pbot.sh Extra comments in pbot.pl; Added pbot.sh launcher; Restructured config, data and log files into respective directories 2010-05-25 03:03:23 +00:00

README

More information coming soon.  Work in progress.
--------------------------
See also: http://www.iso-9899.info/wiki/Candide
--------------------------
PBot requires Perl 5.10, especially for !cc 
--------------------------
PBot is intended for the Freenode IRC network.  As such, it has not been
tested on other networks.  Some IRC features, such as NickServ auto-join, may need adjusting.
--------------------------
The first thing you'll want to do is edit pbot.pl and change the default
settings: 

  * If you did not extract/checkout PBot into ~/pbot (where ~/pbot/PBot 
contains the PBot.pm module), you'll want to change $pbothome in pbot.pl 
to point to the directory that contains the PBot, config, data, etc directories.

  * Change the IRC settings in pbot.pl so that the bot-nick and identify password are
associated with a registered NickServ account, if you want channel auto-join to succeed.
--------------------------
Then you'll need to get several modules from CPAN.  If you do not have root access, see
http://perl.jonallen.info/writing/articles/install-perl-modules-without-root

Net::IRC
AppConfig::Std
Data::Dumper
Getopt::Std
HTML::Entities
HTML::FormatText
HTML::Parse
IPC::Open2
LWP::Simple
LWP::UserAgent
LWP::UserAgent::WithCache
Net::Dict
SOAP::Lite
Text::Autoformat
Text::Balanced
URI::Escape
WWW::Wikipedia
XML::RSS
--------------------------
Some quick-and-dirty info on using stdin (pbot shell after running pbot.sh):

< pragma_> you can type in the bot's stdin to talk in channels as the bot
< candide> hi
< pragma_> that was typing 'msg #pbot2 hi' from the bot's stdin
< pragma_> you can send bot commands to channel by using ~channel command
< pragma_> like ~channel kick <args>
< pragma_> because kick has to be used in a channel
< pragma_> and you can still background the bot with ^Z
--------------------------
Coming soon to README:

* Description of each PBot module, for customisation.
--------------------------
Todo:

* Add SSL and port options to pbot.pl.