GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-10-01 17:16:39 +02:00
Code Issues Projects Releases Wiki Activity

README more readable

Browse Source
This commit is contained in:
Pragmatic Software 2010-05-25 05:36:13 +00:00
parent 3f6cb28a36
commit aead7b17da
1 changed files with 29 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README
View File

@ -1,9 +1,7 @@
More information coming soon. Work in progress.
* List of Perl module dependencies, for installation.
* Description of each PBot module, for customisation.
--------------------------
See also: http://www.iso-9899.info/wiki/Candide
--------------------------
The first thing you'll want to do is edit pbot.pl and change the default
settings:
@ -13,33 +11,39 @@ 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 Net::IRC from CPAN. If you do not have root access, see
http://perl.jonallen.info/writing/articles/install-perl-modules-without-root
More information coming soon. Work in progress.
After installing Net::IRC, you'll need to edit Net::IRC's Connection.pm module to prevent it
from disconnecting IRC when a module completes after forking:
/lib/perl5/site-perl/Net/IRC/Connection.pm around line 405 has a sub DESTROY where I inserted a return; in the first line,
otherwise it would disconnect from IRC after a module exits:
/lib/perl5/site-perl/Net/IRC/Connection.pm around line 405 has a sub DESTROY:
05:53:16 < pragma_> 404 # Standard destructor method for the GC routines. (HAHAHAH! DIE! DIE! DIE!)
05:53:17 < pragma_> 405 sub DESTROY {
05:53:17 < pragma_> 406 my $self = shift;
05:53:17 < pragma_> 407 return; # <--- added to prevent disconnecting after forking exits
05:53:17 < pragma_> 408 $self->handler("destroy", "nobody will ever use this");
05:53:17 < pragma_> 409 $self->quit();
05:53:17 < pragma_> 410 # anything else?
05:53:17 < pragma_> 411 }
Todo:
Add SSL and port options.
404 # Standard destructor method for the GC routines. (HAHAHAH! DIE! DIE! DIE!)
405 sub DESTROY {
406 my $self = shift;
407 return; # <--- added to prevent disconnecting after forking exits
408 $self->handler("destroy", "nobody will ever use this");
409 $self->quit();
410 # anything else?
411 }
--------------------------
Some quick-and-dirty info on using stdin (pbot shell after running pbot.sh):
04:33:09 < pragma_> you can type in the bot's stdin to talk in channels as the bot
04:33:39 < candide> hi
04:33:50 < pragma_> that was typing 'msg #pbot2 hi'
04:33:50 < pragma_> that was typing 'msg #pbot2 hi' from the bot's stdin
04:34:15 < pragma_> you can send bot commands to channel by using ~channel command
04:34:56 < pragma_> no, it was ~channel command
04:35:11 < pragma_> like ~channel kick <args>
04:35:18 < pragma_> because kick has to be used in a channel
04:35:29 < pragma_> I'll have to document that
04:36:09 < pragma_> that's from stdin only though
04:36:20 < pragma_> and you can still background it with ^Z
04:36:20 < pragma_> and you can still background the bot with ^Z
--------------------------
Coming soon to README:
* List of Perl module dependencies, for installation.
* Description of each PBot module, for customisation.
--------------------------
Todo:
* Add SSL and port options to pbot.pl.