.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "POE::Component::IRC::Cookbook::BasicBot 3pm"
.TH POE::Component::IRC::Cookbook::BasicBot 3pm "2021-09-30" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Component::IRC::Cookbook::BasicBot \- A basic IRC bot
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This a very basic bot that connects to \s-1IRC,\s0 joins a few channels, and announces
its arrival.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
We start off quite simply:
.PP
.Vb 1
\& #!/usr/bin/env perl
\&
\& use strict;
\& use warnings;
.Ve
.PP
Then we \f(CW\*(C`use\*(C'\fR the stuff we're going to...well, use. \f(CW\*(C`::State\*(C'\fR is a subclass
which keeps track of state information related to channels and nicknames. It is
needed by the \f(CW\*(C`AutoJoin\*(C'\fR plugin which takes care of keeping us on our channels.
.PP
.Vb 3
\& use POE;
\& use POE::Component::IRC::State;
\& use POE::Component::IRC::Plugin::AutoJoin;
.Ve
.PP
Next up is our \s-1POE\s0 session. We create it and list our event handlers. We then
start the \s-1POE\s0 kernel.
.PP
.Vb 5
\& POE::Session\->create(
\&     package_states => [
\&         main => [ qw(_start irc_join) ]
\&     ]
\& );
\&
\& $poe_kernel\->run();
.Ve
.PP
Now all we have to do is write the handlers for \f(CW\*(C`_start\*(C'\fR and \f(CW\*(C`irc_join\*(C'\fR.
In \f(CW\*(C`_start\*(C'\fR, we create our \s-1IRC\s0 component, add an \f(CW\*(C`AutoJoin\*(C'\fR plugin, register
for the \f(CW\*(C`irc_join\*(C'\fR event, and connect to the \s-1IRC\s0 server.
.PP
.Vb 5
\& sub _start {
\&     my $irc = POE::Component::IRC::State\->spawn(
\&         Nick   => \*(Aqbasic_bot\*(Aq,
\&         Server => \*(Aqirc.freenode.net\*(Aq,
\&     );
\&
\&     $irc\->plugin_add(\*(AqAutoJoin\*(Aq, POE::Component::IRC::Plugin::AutoJoin\->new(
\&        Channels => [ \*(Aq#test_channel1\*(Aq, \*(Aq#test_channel2\*(Aq ]
\&     ));
\&
\&     $irc\->yield(register => \*(Aqjoin\*(Aq);
\&     $irc\->yield(\*(Aqconnect\*(Aq);
\& }
.Ve
.PP
Now comes our \f(CW\*(C`irc_join\*(C'\fR event handler. We send a message to the channel
once we've joined it.
.PP
.Vb 4
\& sub irc_join {
\&     my $nick = (split /!/, $_[ARG0])[0];
\&     my $channel = $_[ARG1];
\&     my $irc = $_[SENDER]\->get_heap();
\&
\&     # only send the message if we were the one joining
\&     if ($nick eq $irc\->nick_name()) {
\&         $irc\->yield(privmsg => $channel, \*(AqHi everybody!\*(Aq);
\&     }
\& }
.Ve
.PP
That's it!
.SH "AUTHOR"
.IX Header "AUTHOR"
Hinrik Örn Sigurðsson, hinrik.sig@gmail.com