AnnouncEd - An IRC Game Announcer Bot

It is written in Java, so you will need to make sure that you have the Java JRE 1.4.2 or higher available from http://www.java.com. Being written in Java, it means that you can easily run the bot on a windows or a linux machine, or any machine with an operating system that has a JVM available for it. There are some clear instructions for Installing Java courtesy of jibble.org

Description

AnnouncEd allows relaying game request messages to a number of different channels. It uses a main bot as a "hub" and then a number of relay bots that can be requested to join channels. The war request is then made by one person in the main channel and that request is then sent to each relay bot, where the message is displayed. It's a great way to reach other people without having to run around different channels asking and waiting for an answer. Now, you can have one central location where someone from your clan can go and where people interested in the war that was posted can join and carry on with the game arrangements.

Features:

• Relay war requests
• Users can request a bot to join a channel
• When requested, it will leave a channel that has less than 5 people (configurable)
• Built in auth levels (master and trusted)
• Trusted users can tell get relay bots to join and part channels
• Trusted users can tell the bot to ignore/unignore by hostmask
• Admin shout - admins can send messages through all of the relays
• Admins can change the output configs and reload them while the bot is running
• Admins can kill the bot
• Network service authing (eg: Q on QuakeNet) and host masking

Configuration

AnnouncEd configuration is done with 2 files. The main config file is AnnouncEdConfig.xml and this contains all of the IRC connection configuration, bot behaviour, outputs, and relay bots. The second configuration file is AnnouncEdChannels.xml and this is a list of the channels that the relay bots are in (and will join when restarted).

Commands

Command: !help
Description: Ask for some quick help info about the commands. You are only shown commands that your auth level allow.
Auth Level: none
Where to give command: channel
Outputs to: notice
Example(s):

• !help

Command: !relay
Description: Sends a war request to each relay bot
Auth Level: none
Where to give command: channel
Outputs to: channel each relay bot is in
Example(s):

• !relay CS :: 5vs5 :: de_dust :: yes :: 30.10 18:00
• !relay BF :: 10vs10 :: bocage :: no :: now

Command: !request
Description: Asks for a relay bot to join a channel
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

• !request #findawar
• !request #my.cool.clan

Command: auth
Description: To auth, you need the adminPassword or trustedPassword set in the config file, and to use the name of the bot as it is when it is on IRC. This will mean that you are authed with the bot for as long as you are both in the same channel. If either you or the bot quits the channel, you will have to auth again.
Auth Level: none
Where to give command: private message
Outputs to: notice
Example(s):

• /msg BotName auth adminPassword
• /msg BotName auth trustedPassword

Command: join
Description: Tells the bot to send a relay bot to a channel
Auth Level: trusted
Where to give command: private message
Outputs to: notice
Example(s):

• join #findawar
• join #my.cool.clan password

Command: part
Description: Tells the bot to tell a relay bot to leave a channel
Auth Level: trusted
Where to give command: private message
Outputs to: notice
Example(s):

• part #findawar

Command: !ignore
Description: Tells the bot to ignore a user
Auth Level: trusted
Where to give command: channel
Outputs to: notice
Example(s):

• !ignore 127.0.0.1
• !ignore user.quakenet.org

Command: !unignore
Description: Tells the bot to stop ignoring a user
Auth Level: trusted
Where to give command: channel
Outputs to: notice
Example(s):

• !unignore 127.0.0.1
• !unignore user.quakenet.org

Command: shout
Description: Sends a message through all relay bots
Auth Level: admin
Where to give command: private message
Outputs to: channel each relay bot is in
Example(s):

• shout going down for an update, back in 5
• shout This bot is sponsored by #my.cool.clan

Command: reload
Description: Reloads the output section of the config file
Auth Level: admin
Where to give command: private message
Outputs to: notice
Example(s):

• reload

Command: die
Description:Kill / Quit / Stop the bot and all relay bots
Auth Level: admin
Where to give command: private message
Outputs to: bot quits
Example(s):

• die

Last Updated Thursday, July 22 2004 @ 11:37 PM CDT; 5,163 Hits