Osiris the bot

[Hovi]

Hello, I am posting to present you our bot - Osiris. Nothing much to say, I included documentation (I know its sucky)
and screenshot so you can check what features it has without downloading. For any questions, just post here or contact me
this is beta version, more feedback = better. If you want to become betatester, let me know.
Enjoy!

Osiris beta documentation

This is the documentation of our advanced PvPGN bot, which was specifically designed for
Warcraft 3 PvPGN servers.
It is only a beta version (216), which means it can (and surely will be ) bugged. Please
report all bugs that you find at [email]kaja.hovi@seznam.cz[/email] (either email or msn), or
just simply send me private message through forum.
Please send error message, operating system and what might cause the bug.

Authors:
This program is made by Hovi, Firebird of clan N0TD and Anomandaris of clan BoS.

Features:

The bot has many many features and more are coming soon.
Each feature has its own "handler" that implements the feature. Handlers
are divided into core handlers and other handlers.

Core handlers:

Core handlers are part of bot core and some of them are necessary for bot to run.
They are:
AccessHandler - Handler that takes care of access to bot (groups and modifying)
them. For example in ss guard, there is safelisted group, ssmod group, which can
modify safelisted group, etc.

ChannelHandler - Handler that keeps information about current channel and people
inside.

ChatHandler - Handler that can be used for chat without graphics user interface.

LoggingHandler - Handler that takes care of chatlogs.

LoginHandler - Handler used for login.

Other handlers:

PlaysoundHandler - Handler for playing sound after command "~playsound file.wav",
same way as in topazchat, however this handler works correctly only in Windows
(in linux it works too, but uses old oss driver, which makes it almost useless).

RepeatHandler - Handler to send timed messages: you can set the interval, how many
times to repeat - if not indefinitely, or at what time.

ResponseHandler - Handler for sending responses to triggers. Similar feature is
in topazchat, but this one is more advanced.

There are also other Handlers, but they either aren't finished, or aren't needed
for this beta version. Just to mention, there is handler for moderating channel,
handler for safelisted/banlisted channel, handler for loading codes from games
(like Notd2, NotDAM, NotD:SO), handler for managing clan, for watching games,...
You might know some of them from ss "Guard" or clan N0TD "N0TD" bots.

All bot settings are stored in xml files with many options which makes them
easy to edit and gives many various configuration options.

Important thing is, that there is a possibility to create your own handler for
anything you want - all you need is the AbstractHandler.java source file and knowledge
of Java. If you need any help, feel free to contact us.

Getting started:

1, First you need to have a system with the Java Runtime enviroment 1.6 (downloadable
from [url]www.java.sun.com[/url]).

2, Download bot, extract zip file to a directory.

3, Edit bot.xml in settings directory.
Fill in login information.
(you might need to change server adress to "eurobattle.net" or "track.eurobattle.net", if bot doesn't want to connect)

4, Bot has by default set some default repeated messages ("test message", etc). If you want to turn them off,
delete "repeatmessagesettingssample.xml".

5, Turn it on simply by clicking start.bat (in windows), or by command
"java -jar OsirisXXX.jar -gui bot.xml".
In linux you can use command "bash start.bat" ofc

Configuring basic handlers:

I think example is always the best and easiest way to understand, check out
settings directory, especially bot.xml, repeatmessagesettingssample.xml and
Responses.xml.

Sounds.
I included basic sound files (from topaz), but we recommend you to use additional
pack made by greek and demkit of N0TD.
[url]http://www.eurobattle.net/showthread.php?t=52290[/url]


The boring stuff:

Platform:
Program is made in java and is supposed to be platform independent, that means
it should be runable on any platform that runs Java 1.6.

Versions:
There are several versions of bot, depending of what features are used. Most
used version will probably be the gui chat version, which is similar to TopazChat.

There is also a text version that doesn't require a graphical environment to run.

The last version to mention is the server one, that should be runnable remotely on any
Java 1.6 supporting machine.


Edit:
new version is now available at:
[url]http://www.eurobattle.net/showthread.php?t=78459[/url]