MirageBot ReadMe

Created by: Chriso@USWest

E-mail: lancergli@gmail.com

Website: www.bnetdev.net

Contents

1.0 Getting Started

So you’re new to MirageBot and want to start using it as soon as possible right? In this section I will describe the quickest way to configure a profile then get the bot connected!

1. Start MirageBot.exe

2. You will be presented with a form showing you a list of profiles available (which will be empty at this stage)

3. Click the “Create” button

4. You will be asked to enter a name for your first profile, enter something then click “OK”

5. You will then be presented with a form asking you to configure the profile

6. Fill out all the fields you require (for help with this see the Configuration section)

7. Click “Save”

8. The first form will be shown again only this time there will be a profile available, make sure it is checked then click “Continue…”

9. You should now be looking at the main window and your profile will be shown in the tab strip

10. Go to “Bot” and select “Connect”. Provided that you entered all the required information correctly you should now be chatting on Battle.Net! J

2.0 Configuration

An overview of the configuration of profiles so that they can be used within MirageBot!

2.1 Main Section

Variable	Description
Username*	The account you want to login to Battle.Net with, this will be automatically created if it does not exist!
Password*	The password associated with the account on Battle.Net
New Password	Leave this blank unless you want to change the password of your account
Server*	The Battle.Net server to connect to, for example: uswest.battle.net
Product*	The product (or game) you want to connect with
Cdkey*	The cdkey associated with the game you selected
Expansion Cdkey**	The expansion cdkey which is required when “Lord of Destruction” or “Frozen Throne” is selected
Channel	The initial channel to join (home). Will only be joined if the checkbox is checked
Verbyte**	The associated version byte for the selected product, click grab to attempt to determine it from the hashes
Realm	The realm you want to connect to when using a Diablo II product, set as “Disabled” to ignore realm login

2.2 BNLS Section

Variable	Description
Enabled	Y/N, determines whether to use “BNLS” or “local hashing”
Server**	The “BNLS” server to connect to for remote hashing

2.3 Proxy Section

Variable	Description
Enabled	Y/N, determines whether to connect to Battle.Net via a proxy to mask your IP address
Server**	The proxy IP address to connect to
Port**	The port of the proxy we are connecting to
SOCKS Ident	If the proxy requires login enter the username otherwise simply enter “anonymous” or leave blank
SOCKS Version**	The protocol to connect to the proxy with, SOCKS4/a and SOCKS5 are supported

2.4 Registration Section

Variable	Description
Mode	Select what registration option you want the bot to carry out, set “disabled” to ignore all registration requests
E-mail**	When you create an account you are given the option to bind an e-mail address to it in case you forget the password, enter your contact e-mail here in the event that you might lose the password
New E-mail**	Leave this blank unless you want to change the registered e-mail address

* - required in order to connect to Battle.Net

** - required by another setting in order to function properly

3.0 Greet Settings

Greetings allow you to welcome users to your channel or advertise something when a user enters or leaves the channel

3.1 Greeting (triggered when a user enters the channel)

Variable

Description

Enabled

Determines whether greeting of users is enabled

Message

The message to send when a user enters the channel

Variables

Available variables:

Variable	Description
%^	Insert the system uptime
%*	Insert the bot uptime
%c	Insert the current channel
%d	Insert the current date on this computer
%f	Insert the users flags
%m	Insert the current track playing in the selected media player
%p	Insert the users ping
%q	Insert a random quote
%s	Insert the users parsed stats
%t	Insert the current time on this computer
%u	Insert the users account
%v	Insert the version of MirageBot

3.2 Farewell (triggered when a user leaves the channel)

Variable

Description

Enabled

Determines whether farewell of users is enabled

Message

The message to send when a user leaves the channel

Variables

Available variables:

Variable	Description
%^	Insert the system uptime
%*	Insert the bot uptime
%c	Insert the current channel
%d	Insert the current date on this computer
%m	Insert the current track playing in the selected media player
%q	Insert a random quote
%t	Insert the current time on this computer
%u	Insert the users account
%v	Insert the version of MirageBot

4.0 Idle Settings

Idle allows you to advertise a message at a specified interval with dynamic variables or static text

Variable

Description

Enabled

Determines whether or not to send the idle message

Interval

The interval in which you want to send idle messages

Message

The message to send when the interval elapses

Variables

Available variables:

Variable	Description
%^	Insert the system uptime
%*	Insert the bot uptime
%d	Insert the current date on this computer
%m	Insert the current track playing in the selected media player
%q	Insert a random quote
%t	Insert the current time on this computer
%v	Insert the version of MirageBot

Filtering allows you to ignore specific messages or users which can be handy when bots are spamming messages or a user is annoying you. To filter users simply enter the users into the textbox and separate each user by a new line, wildcards can be used to block multiple users for example: WaR[*]LoaD. Message filtering works in the same way and will filter out messages containing one or more of the blocked messages on the userTalk, userEmote, and userWhisper events.

6.0 Font Settings

So you don’t like the default fonts hey? Then fuck you ;) nah but seriously you can change them here! Simply select the font from the list adjust the size and click “Save”. These settings are only applied to the main window, and allow you to modify fonts of the “chat window”, the “list view”, and the “send box”. These settings will be reloaded each time you open the bot, the default fonts are all “Courier New” with a size of “9” if you want to revert to the default at anytime.

7.0 Group Settings

Groups allow you to organise users according to their relationship with you or in the community. When creating a group you can select a colour to associate with the users so that they can stand out in the crowd! When the “Group Editor” is displayed you will be given only one option (if there are no groups) and that option is to “Add” a group which will prompt you to enter a name for the group. Once you have more than one group you are able to rename, delete, or edit the group; remember when you are finished to click “Apply” or “Save” otherwise all your hard work will be lost!

8.0 Icon Settings

There are two icon sets available, these two styles are “Classic” which is the basic display as seen by older game clients; and “WarCraft” which is the new style as seen in the WarCraft III game client.

Note: The “WarCraft” style is selected by default.

9.0 Optional Settings

· Nudges

o Allow you to alert another user on MirageBot by playing a sound on their computer and flashing the MirageBot window

o Can be disabled in the “Settings” menu

· Smilies

o Allow you to replace the most commonly used ASCII smilies with the picture representation

o Can be disabled in the “Settings” menu

· Tic-Tac-Toe

o Also known as “Naughts and Crosses”

o Allow you to play tic-tac-toe games with other users on MirageBot

o Can be disabled in the “Settings” menu

· Beep-on-Name

o Plays a sound when someone whispers you or says your name