contents	The Java Battle.net Bot Starting the Bot Command-line Options Message System Access levels Groups Users Contact
the java battle.net bot	We're up to version 1.1.2 now. This revision mainly fixes the annoying auto-unban bug, but it also includes a couple of other nice fixes. Not much to mention though. Also, the documentation has improved a bit, and I've written a new services list. Hope you like it. The Java Battle.net Bot is now proud to be hosted by the nice folks of the Unholy Battlegrounds! This means the URL to the JavaBot page is now http://www.battlegrounds.com/javabot and I can be reached at hefa@battlegrounds.com. Thanks a lot!
starting the bot	Unfortunately, running Java applications isn't as easy it should be. It depends on your Java Runtime Environment (JRE). I've written some instructions here, but they might be inadequate. In that case, read some manuals and feel free to mail me. Windows 1. Download the JavaSoft JRE, if you haven't got one, from: http://www.javasoft.com/products/jdk/1.2/jre/download-windows.html (Click the "continue" button in the middle of the page) 2. Install it Double click on the install file... 3. Run the bot Double click the bot.jar file! Mac 1. Download the Macintosh Java Runtime if you haven't got one: from the United Stated from the European Union 2. Install it. Somehow. 3. Get the Sit archive from www.macstarcraft.com/files which includes a Mac native launcher application. If that archive isn't updated to the latest version, use the bot.jar file from the Zip archive instead. (Thanks to Snowcone of macstarcraft.com and to whoever wrote the launcher for this!) Alternatively you can make your own launcher with the JBindery tool of MJR somehow, if you've got it. Others 1. Get a suitable JRE. For instance Blackdown's JDK port for Linux: from ftp.funet.fi 2. Install it. 3. If it's JDK 1.2 compatible, type: java -jar bot.jar Otherwise: jre -cp bot.jar Bot (caps Bot correctly)
command-line options	If you intend to use the bot in a graphical environment (as I centainly recommend), you can just skip this part. Really, skip it! -console awt Graphical, fun to use interface with chat and one hell of an about window. This is the default console :) -console text Textish console, not too fancy, no chat capability. -console none Only display messages, good for running it as a background process. -timeout <time in seconds> Sets socket timeout, useful on the extremely rare occations when battle.net lags (Blizzard please hire me! :-). Default is 120 seconds. -nolog Turns off logging. -loglevel <level> Sets minimum level of messages that will be written to log file. See part about messages below. Default is 1. -msglevel <level> Sets minimum level of messages that will be sent to console. See part about messages below. Default is 2.
message system	Messages are short text strings generared on various places in the program. Every message also has a priority from 0, lowest, to 3, highest. These priorities are: 3: Errors, Exceptions, bad stuff 2: Running related things, normal messages 1: Messages related to user-generated events 0: Debug, socket input and output Don't log level 0 unless you want to exceed your quota... As noted above, the default console message level is 2, and 1 for logging. Those values have proved to be suitable (unless when debugging), that's why they're called the Default Values... :-)
access levels	Access levels determine what a user is allowed to do. A user has a level, through its group, and a command requires one. You can change the level of any command in the Access Levels menu item in the Bot submenu of the Settings menu (you'll find it :-). A group's access level is changed by choosing Edit Group in the Users menu, under the correct group. A user has the access level of the group it is a member of. You can have almost as many access levels as you like. The limit is that it has to be within the range of about -2.1 to +2.1 billion.
groups	There is absolutely no limit on the amount of groups you can create. There are 6 default groups with different access levels shipped with the bot as default. It might be a very good idea to create a group for say each clan in your channel. This way they can for instance memo within the clan by using the "memo group" service, and you can easily change the whole group's access level if you want. So, a group must have a name and an access level. What more? Well, you might want to put your enemies in a certain group. That group should have Auto Kick and Auto Ignore turned on. It might also be suitable to put all unknow people who enter the channel in a certain guest group. That group should probably have Auto Remove on. A group also has default values for Notify Me, Notify Others, Channel Monitoring, and the ability to override the user's choice on these settings. All this can easily be edited in the Group Editor, which can be found by clicking Edit Group in the Users menu.
users	Users are of course what this is all about! One of the main features of the javabot is its notify function, which I will try to explain. As no other battle.net bot can (/me proud), the javabot continuously searches for its users on battle.net, detecting logons and logoffs. This is called the notify function. Every user has the ability to either receive notifies of other users' logons/logoffs, or trigger a notify by itself when it logs on or off. These options are called Notify Me, and Notify Others. There is also a function called Channel Monitoring, which lets users know when people enter/leave the channel. This is only sent to users who have the Channel Monitoring option turned on. Note: groups may override every one of these settings! Edition of users is best done with the User Editor, which can be invoked by clicking on the user's name, under the appropriate group, in the users menu.
contact	If you want to contact me, please write to hefa@battlegrounds.com. If you like writing manuals, doubleplease contact me if you want to take over that part of making the best bot on battle.net! :-)
	Henrik Falck, hefa@battlegrounds.com First written: 1999-03-28 Last updated: 1999-06-20 Applies to bot version: 1.1.2