Jabber Perl Bot

Usermanual

Kahless

Copyright © 2001 Kahless

Abstract

Get latest version of documentation for the Jabber Perl Bot at http://jpb.sourceforge.net (easier: http://jpb.sf.net)

Table of Contents

1. Installing
Requirements
Configuring
$server
$username (have to be changed)
$pass (have to be changed)
$owner (have to be changed)
$debug
$save
$filename
$savefile
$ipctimeout
$Data::Dumper::Indent
$IPCcom
$IRCbot
$stdIRCnick (should be edited)
$localaddr
Modules
2. Using
pls (Owner functions)
rosteradd <jid>
subscribe <jid>
add <jid>
rosterremove <jid>
unsubscribe <jid>
remove <jid>
save
load
exit
setflags <jid> <flags>
IRCconnect <server> [<Nick>]
IRCquit
IRCjoin <channel>
IRCpart <channel>
sendmessage.pl

Table of Contents

Requirements
Configuring
$server
$username (have to be changed)
$pass (have to be changed)
$owner (have to be changed)
$debug
$save
$filename
$savefile
$ipctimeout
$Data::Dumper::Indent
$IPCcom
$IRCbot
$stdIRCnick (should be edited)
$localaddr
Modules

This is just a small guide on how to install Jabber Perl Bot.

This documentation does NOT describe how to download and extract the archieve, I think you can do it yourself ;)

Well.. I hope thats all ;)

First of all you should rename the baseconfig.pl to config.pl

Then edit the config.pl and change the variables. If the description in the config.pl is not enough for you, here is something longer:

The server to which the bot should try to connect.

The Username which the bot should use to login (If the login is not successfull, the bot SHOULD try to register the nick)

The Password which the bot should use to login.

The JID (Jabber Identification) of the owner (of you).

Activates Debug mode (0 = deactivated / 1 = activated) - You may want to activate the debug mode because the bot has no other output yet.

This is for the status indicator function of the bot. If you activate saving (1 = activated) the bot will save the status of every JID in the roster into a file in the format: jid<#>status<#>message<#>last change<#>

If you have activated saving the status, the bot will write the status of all users into this file.

This file is to save and load data for the modules you loaded.

This is for IPC (Inter Process Communication). E.g.: If $ipctimeout is 30 the bot will wait 30 seconds until he writes 'ready' into the shared memory. (means that the programm, which wants to communicate with the bot has 30 seconds to read the answer of the bot.)

This variable just controls the style of the output of the Debug messages (for hashes). If you have no idea about perl, you may not change this flag and if you want to know more look at the Data::Dumper documentation: http://search.cpan.org/doc/GSAR/Data-Dumper-2.101/Dumper.pm#Configuration_Variables_or_Methods.

With this variable you can activate (1) or deactivate (0) the Inter Process Communication.

With this variable you can activate (1) or deactivate (0) the IRC bot.

What nick the bot should use on the IRC

The Hostname of your PC. It is used by Net::IRC and I do not really know how it works, but if you have no hostname (like me) you can set this to 1 and the Net::IRC ignore it. If you set this to 0 the Net::IRC will read the system configuration

You may not edit this as user. Just if you want to add a module you have to add a sbind or bindm but this command should be in the documentation of every module.

Table of Contents

pls (Owner functions)
rosteradd <jid>
subscribe <jid>
add <jid>
rosterremove <jid>
unsubscribe <jid>
remove <jid>
save
load
exit
setflags <jid> <flags>
IRCconnect <server> [<Nick>]
IRCquit
IRCjoin <channel>
IRCpart <channel>
sendmessage.pl

After configuring the bot you can just run it with: ./bot.pl

Owner functions are sent as a chat message via the jabber server. They allways start with pls and then the command. (Your JID have to be $owner)

Adds <jid> to the roster.

This sends a subscribe request to jid (Just use it if someone has not allowed the bot to see his online status.)

This basically calls rosteradd and subscribe. So you should allways call add not rosteradd

Like rosteradd you shouldn't use it.

Sends a unsubscribe to <jid>. (You shouldn't use it without rosterremove)

Basically just calls rosterremove and unsubscribe. Normally You should allways use this command to remove a jid.

Opens $savefile and calls every save() method of every module.

Opens $savefile and calls every load() method of every module.

Calls the save method and exits then.

Sets the flags of <jid> to <flags>

Connects to <server>. If there is no nick the bot will connect as $stdIRCnick. (The bot can connect to multiple servers.)

Disconnects from the active server. (May there is more documentation at the IRC module)

Joins <channel> on the active IRC server

Parts from <channel> on the active IRC server

Usage: ./sendmessage.pl <jid> <message>

This sends the message <message> to <jid>. Not really usefull, it is just a test for the Inter Process Communication.