view release on metacpan or  search on metacpan

bin/infobot  view on Meta::CPAN

For example the config file 

    channels = #somechannel #someotherchannnel
    server   = irc.example.com
    nick     = mybot    

    [Foo]
    somevar = a value

Will join a couple of channels under the given nick. The plugin
C<Bot::BasicBot::Pluggable::Module::Foo> will have the 
variable C<somevar> set C<a value>. Individual plugins will
describe their config values however the config values 
available for the main bot are - 

=head2 server

The server we're going to connect to.  Defaults to
"irc.perl.org".

=head2 port

The port we're going to use.  Defaults to "6667"

=head2 nick 

The nick we're going to use.  Defaults to five random letters
and numbers followed by the word "bot"

=head2 alt_nicks

Alternate nicks that this bot will be known by.  These are not nicks
that the bot will try if it's main nick is taken, but rather other
nicks that the bot will recognise if it is addressed in a public
channel as the nick.  This is useful for bots that are replacements
for other bots...e.g, your bot can answer to the name "infobot: "
even though it isn't really.

=head2 username

The username we'll claim to have at our ip/domain.  By default this will be the same
as our nick.

=head2 name

The name that the bot will identify itself as.  Defaults to
"$nick bot" where $nick is the nick that the bot uses.


=head2 channels 

The channels we're going to connect to.

=head2 quit_message

The channels we're going to connect to.

=head2 ignore_list

The list of irc nicks to ignore B<public> messages from (normally
other bots).  Useful for stopping bot cascades.

=head2 flood

Set to '1' to disable the built-in flood protection of POE::Compoent::IRC

=head2 store

The name of the backend C<Store> module to use. Defaults to C<Storable>
and C<Bot::BasicBot::Pluggable> ships with that and a C<DBI> backend.

=head1 STORES

When the infobot starts up it will look in the current directory for various
C<.storable> files. The are used as variable stores for the various plugins.

Stores are passed anything in the C<Store> namespace. Perhaps the most
important value is C<name> which describes which backend to use - the default
is C<Storable> but C<Bot::BasicBot::Pluggable> also ships with a DBI backend.

See the various backend for what variables you need to pass. Here are 
some examples

=head2 Storable

    [ Store ]
    type = Storable

=head2 Deep

    [ Store ]
    type = Deep
    file = brane.deep

=head2 DBI

    [ Store ]
    type     = DBI
    dsn      = dbi:SQLite:brane.db
    user     = myusername
    password = mypassword
    table    = brane

the table should be created automatically

=head1 AUTHOR

Simon Wistow <simon@thegestalt.org>

based on the original code by Kevin Lenzo et al.

=head1 COPYRIGHT

Copyright 2005, Simon Wistow 

Distributed under the same terms as Perl itself.

=head1 SEE ALSO

L<Bot::BasicBot::Pluggable>, L<Config::Tiny>