Difference between revisions of "Cobalt"

Latest revision as of 03:56, 25 May 2012

cobalt
Author(s):	avenj
Programming language:	Perl
Platform:	Unix
Status:	Active/Development
License:	GNU General Public License v2
Homepage:	http://www.cobaltirc.org/dev/bots

Bot::Cobalt is a pluggable IRC bot framework, tying a multi-server IRC interface into a plugin pipeline, configuration manager, database and serialization interfaces, and other useful tools.

The core Bot::Cobalt plugin set includes most of the functionality of Jason Hamilton's abandoned DarkBot along with a vast number of improvements.

It's written from the ground up using POE::Component::IRC and POE::Component::Syndicator.

The original cobalt (1.x) is deprecated and no longer documented here. Conversion tools for cobalt1 data sets are bundled with Bot::Cobalt

Documentation

Documentation lives in "POD" embedded within the Bot::Cobalt distribution itself.

See http://www.cobaltirc.org/docs/wiki/doku.php?id=bots:cobalt:docs:filelist for an up-to-date Wiki documentation index or https://metacpan.org/release/Bot-Cobalt for the metaCPAN project page.

Features

Bot::Cobalt::Plugin::Info3

The Info3 plugin largely emulates DarkBot's 'info2' text triggers; triggers can be written using simple glob syntax. Responses can include variables or randomized responses (via Cobalt::Plugin::RDB).

With Info3 enabled, your bot can be used as an IRC help bot, a humanoid chatter-bot, a method of storing interesting bits of information, etc.

Bot::Cobalt::Plugin::RDB

RDBs provide databases of 'random stuff' that can be triggered on a timer or via Cobalt::Plugin::Info3 topic triggers.

The main RDB acts much like DarkBot's randstuff functionality.

Other Plugins

Alarmclock.pm - Timed highlights/reminders
Auth.pm - Flexible Auth system
Games.pm - Interface a collection of silly games (!roll, !magic8, !rr, !rps ...)
PluginMgr.pm - Plugin management via IRC
Rehash.pm - Rehash configuration files via IRC
Seen.pm - 'Seen' bot plugin

Bot::Cobalt::Plugin::Extras::

The core plugin set also includes a handful of useful modules in the Extras:: namespace, including:

Karma.pm - Karma-bot
Money.pm - Convert currencies
Relay.pm - Multiplex chatter between IRC channels
Shorten.pm - Shorten URLs on IRC via Metamark
TempConv.pm - Convert temperatures between C, F, K

Obtaining Bot::Cobalt

Via CPAN:

 $ cpan Bot::Cobalt

Also see the metaCPAN page at https://metacpan.org/release/Bot-Cobalt

Development discussion takes place on #eris (Blackcobalt)

@@ Line 1: / Line 1: @@
 {{Software|name=cobalt
 |author=[[User:Avenj|avenj]]
-|homepage=http://eris.oppresses.us/dev/bots
+|homepage=http://www.cobaltirc.org/dev/bots
 |programming_language=Perl
 |platform=Unix
@@ Line 8: / Line 8: @@
 }}
+'''Bot::Cobalt''' is a pluggable IRC bot framework, tying a multi-server IRC interface into a plugin pipeline, configuration manager, database and serialization interfaces, and other useful tools.
-'''Cobalt''' is a talkative IRC bot intended as a modern-day replacement for Jason Hamilton's abandoned [[Darkbot]].
+The core '''Bot::Cobalt''' plugin set includes most of the functionality of Jason Hamilton's abandoned [[DarkBot]] along with a vast number of improvements.
-'''Cobalt''' can respond to channel chatter with any string you like. By defining 'topics' using a simple wildcard syntax, '''cobalt''' can be made to be whatever you like; an IRC help bot, a human-like chatter bot, a quote-bot, or could perhaps just serve up bits of information you'd like to be able to easily reference on IRC. Topic responses can be randomized (via RDB) and may include a lengthy list of variables.
+It's written from the ground up using [http://search.cpan.org/perldoc?POE::Component::IRC POE::Component::IRC] and [http://search.cpan.org/perldoc?POE::Component::Syndicator POE::Component::Syndicator].
-It's written from the ground up using XML::Simple and POE::Component::IRC and borrows no code at all from Darkbot.
+The original '''cobalt''' (1.x) is deprecated and no longer documented here. Conversion tools for '''cobalt1''' data sets are bundled with '''Bot::Cobalt'''
+==Documentation==
+Documentation lives in "POD" embedded within the '''Bot::Cobalt''' distribution itself.
+See http://www.cobaltirc.org/docs/wiki/doku.php?id=bots:cobalt:docs:filelist for an up-to-date Wiki documentation index or https://metacpan.org/release/Bot-Cobalt for the metaCPAN project page.
 ==Features==
-* Can speak in response to chat or randomly; responses can be very flexible (or even randomized)
-* Online user management
-* Darkbot data file compatibility (info2.db, randomstuff.ini, RDBs)
-* SSL support via POE::Component::SSLify
-* Simple XML-based configuration
-==Obtaining cobalt==
+===Bot::Cobalt::Plugin::Info3===
-* http://eris.oppresses.us/dev/bots/cobalt/
+The ''Info3'' plugin largely emulates [[DarkBot]]'s 'info2' text triggers; triggers can be written using simple glob syntax. Responses can include variables or randomized responses (via ''Cobalt::Plugin::RDB'').
+With ''Info3'' enabled, your bot can be used as an IRC help bot, a humanoid chatter-bot, a method of storing interesting bits of information, etc.
+===Bot::Cobalt::Plugin::RDB===
+''RDBs'' provide databases of 'random stuff' that can be triggered on a timer or via ''Cobalt::Plugin::Info3'' topic triggers.
+The '''main''' RDB acts much like [[DarkBot]]'s ''randstuff'' functionality.
+===Other Plugins===
+* Alarmclock.pm  - Timed highlights/reminders
+* Auth.pm        - Flexible Auth system
+* Games.pm       - Interface a collection of silly games (!roll, !magic8, !rr, !rps ...)
+* PluginMgr.pm   - Plugin management via IRC
+* Rehash.pm      - Rehash configuration files via IRC
+* Seen.pm        - 'Seen' bot plugin
+===Bot::Cobalt::Plugin::Extras::===
+The core plugin set also includes a handful of useful modules in the Extras:: namespace, including:
+* Karma.pm     - Karma-bot
+* Money.pm     - Convert currencies
+* Relay.pm     - Multiplex chatter between IRC channels
+* Shorten.pm   - Shorten URLs on IRC via Metamark
+* TempConv.pm  - Convert temperatures between C, F, K
+==Obtaining Bot::Cobalt==
+Via CPAN:
+  $ cpan Bot::Cobalt
-As of this writing '''cobalt''' is in rapid development and primarily available via the development repository tool '''git'''
+Also see the metaCPAN page at https://metacpan.org/release/Bot-Cobalt
-Snapshots of known-working git tags are made available via the above link.
+Development discussion takes place on '''#eris''' ([[Blackcobalt]])
 [[Category:Software]][[Category:Bots]][[Category:Perl]]