Throughout this
document the nickname ‘mbot’ is used to denote the mIRCStorm bot. Underlined
lines show commands/arguments.
If this is your
first time at setting up mIRCStorm or you are looking for help about getting
your Bot started it is suggested you read section 1. 2. and 3. fully.
1) The Structure Of Commands
i.
Channel Commands
ii.
Private Message Commands
2)
The Main Setup Of The Bot
i. Introduction
ii. Nick,
Channel And Server Tab
iii. Modes Tab
iv. Misc Tab
v. Bot Personality Tab
vi. Addons Tab
vii. The Botnet Tab
vii. Backup/Restore
Tab
3) The Online Help
System
i. Introduction
ii. Examples
4) User Levels
ii. Global And Channel
Explained
5) Commands, A
Detailed Look
i. Introduction
ii. Channel Voice
Access Commands
iii. Channel OP Access Commands
iv. Channel Master Access Commands
v.
Channel Owner Access Commands
vi.
Global OP Access Commands
vii.
Global Master Access Commands
viii.
Global Owner Access Commands
ix. Full Access Commands
6) Partyline And The
Botnet
i. Introduction
ii. What Is The
Partyline?
iii. Partyline/DCC
Chat Commands
vi. What Is A
Botnet And Why?
v. Linking A
Bot
7) Creating Your Own…
i. Personality
ii. Addon
8) What Happens If...
i. Where to go
A channel command is where a user types the command publicly into the channel so all including the bot can view/respond.
All core mIRCStorm commands follow the same structure. I say core commands as it may not include all 3rd party addons that have been made for the bot.
Channel commands only affect the channel you type the command in. Hence you cannot alter anything in another channel. To do this you must use private message commands.
A Basic channel command will look like
this: mbot <command> <args>
Where <command> is replaced by the command you want to perform and <args> is any other needed argument. For example mbot join #botshed.
Commands can become more complex when there are many augments, however the basic structure is the same. To pass more augments into a command simply leave a space, i.e. mbot <command> <arg1> <arg2> <arg3> <arg4> and so on…
A private message command is where a user types the command privately (i.e. using /msg).
Unlike channel commnds, private message commands can affect anything in any channel, assuming you have access rights to that channel that is.
A basic private message that a user will type (based on mIRC) will look like this: /msg mbot <commandl> <#channel> <args>. Note the <#channel> here, this is used so the bot knows which channel you want to affect. It is also used internally by the bot to check access levels. For example: /msg mbot join #mircstorm #botshed. Where #mircstorm is the channel the user is currently on and #botshed the channel to join. A good way to remember is to think a <#channel> must be present after every command.
Like with channel commands, you can place as many ‘args’ as needed.
2) The Main Setup Of The Bot
The ‘Main Setup’ dialog is the first screen that’s displayed on starting mIRCstorm for the first time. It can be accessed at any time by right clicking in any free space in the status screen of mIRC. Important information such as bots nickname and what server to connect to is gathered here.
This part of the main setup is the most important, you could after filling this out simply click ‘save and exit setup’ and the Bot would start up and connect fine.
Bots Nick: This is the IRC nickname the Bot will attempt to take. I say attempt because the nickname may already be taken. If the IRC server allows the nickname but the Bot gets messages from nickserv about the ownership of the nickname, the Bot will NOT do anything (See Misc Tab). In which case nickserv will most likely force a new nick on the Bot. The Bot will continually attempt to regain that nickname, however if it is nickserv controlled, without identifying nickserv will simply force a nickname change or disconnect the Bot from the network.
This shows an example where the Bot would not use its Backup Nickname but continually try to keep its main nick.
Backup Bots Nick: This is the backup nickname that the Bot will use if it cannot use its main. When the Bot is forced to use its backup, it will continually attempt to gain its main one back. mIRCStorm only uses its backup nickname if the IRC server itself (not the services) disallow the nickname.
Updates Button: This button opens the mIRCStorm Update dialog. This feature will contact the www.mircstorm.co.uk homepage via port 80. It basically downloads a text file that lists current versions. It then reads this text file and checks the versions against itself. If it finds that a newer version is available it will give the user two choice. 1: Auto Update and 2: Manual Update.
The auto update tells mIRCStorm to contact the website again and downloads a zip file. The Bot then unzips this file into the mIRCStorm directory. It then restarts the Bot.
The manual update simply opens the website so the user can download the new version and install themselves.
Bots Home Channel: This is the first channel the Bot will join on start-up. It is also the channel where important messages are sent. Messages such as ‘Warning: I have been deoped in #channel’.
Enter IRC Server(s): Listed in the box are servers that the Bot will connect to. To add a server simply type in the address and click ‘Add Server’. If the Bot cannot connect on the first server it will cycle through the others listed until it gets connected. NOTE: If the Bot cannot connect on any of the listed servers it will simply cycle through forever. If only one server is given, the Bot automatically copies it creating a second. It does this for scripting purposes only; it ensures the trouble free operation of the Bot.
Port To Connect On The Server: This is the port that’s used to connect to all the servers. The default is normally 6667
This tab is where you define the default channel modes for new channels. It is important to understand that these settings are only the default ones used for NEW channels. When a channel is created, the modes assigned on creation are taken from here. This means that no change here will affect any currently existing channel! To change existed channel users must use the ‘chanset’ command.
Default Channel Modes: Here are the default channel modes that mIRCStorm will instruct the IRC server to enforce. Note these are all different depending on the server you use. +nt is the standard default mIRCStorm use’s.
+n stands for no external messages. If +n is not set then it's possible for
someone to send messages to the channel even if they are not present inside the
channel.
When +t is set,
only the ops of the channel can change the topic.
Channel Flood Protection: When a user goes over the amount set here the bots flood protection will kick in and punish the offending user. For example 8 lines in 14 seconds means that if a user types more than 8 lines in 14 seconds the flood protection kicks in. This can be set to anything you like, for example 1 line in 90 seconds – meaning users can only say one thing every 90 seconds.
The modes below are enabled (+) if ticked. The ‘chaninfo’ command uses the sign +/- to show if a mode is enabled or not. Unless otherwise stated all commands are channel specific, meaning they can have different settings on different channels.
Peak: If this is ticked mIRCStorm will broadcast a message to the channel if a record number of users are currently in the channel. This is triggered by the ‘on join’ event and so only broadcasts once when a new record is hit.
Display Login: This mode is not channel specific, thus if enabled it is enabled for all channels. If it is enabled when a user logs in with mIRCStorm, the Bot broadcasts a message to the Home Channel informing current users of the login. This is useful for Bot lending channels to keep an eye on things.
Log: By enabling this mode the Bot keeps a text file log of all activity in the channel.
AutoOp: This mode, if enabled, will tell the Bot to automatically give OP’s (@) to known operators on join. MIRCStorm will only auto op channel users and not global users. If you are a global user and would like to use this feature, simply add yourself with high enough channel access. Either ‘chanop’, ‘chanmaster’ or ‘chanowner’.
The Bot looks at the joining users mask/host and compares this to the mask/host of the nickname on file. If the nickname and mask/host match the user is given op’s. Note this has security issues, for if a user were to steel a nickname and obtain the same mask/host as the real nickname then the Bot will give ops. For this reason, if you use this mode, you must ensure users have secure masks/hosts set with the bot.
AutoVoice: This is the same as the AutoOp mode above, but users gain channel voice (+v) on join. This mode will only affect those with ‘chanvoice’ access levels.
VoiceAll: With this set, mIRCStorm will voice (+v) every user who joins the channel, no matter if they have access on the Bot or not.
NoColour: This mode enforces the use of colour on the channel. If it is enabled then any user who users colour on the channel is punished.
Swearkick: This function allows the channel to have a list of ‘banned words’ The list can be edited via the ‘swearkick’ command. This mode acts as a switch turning the function on and off.
PunsihOps: If this mode is set then known users to mIRCStorm are punished in the same way unknown users are. For example if this mode is set and the NoColour mode is also enabled, then both known users and unknown users will be punished for using colour. If this mode is disabled then only unknown users are punished for using colour, allowing known users to use as much colour as they like.
This section comprises of other settings that did not belong in any other tab.
Personalised Shortcut For The Bot: Normally mIRCStorm will respond to its nickname or the first and last letter of either its nickname or backup nickname. For example if a Bots nickname was ‘fred’ then to perform the ‘say’ command I could do: fred say hello world or fd say hello world. This personalised shortcut allows you to add another shortcut. For example if I put ‘fre’ in here then I could also do fre say hello world
If Not Connected in…: Here you can set the time that mIRCStorm will wait before it decides a server is dead. The Bot will attempt to connect to the first server in its server list and wait the time (in minutes) set here until it decides the server is not answering.
Show Splash Screen At Startup?: Specifies if the slash screen is displayed at the start up.
Use Animation Loading Main Setup: Tick this is you want to see the effect when loading main setup.
Proxy Support: Some system may be behind a proxy server, if this is the case then features like the Botnet and Google search will not work correctly. Use the settings here to add proxy support to mIRCStorm functions. Note: this does not configure mIRC itself to use a proxy, if you need to do this click File > Options.
Require Op’s (@) On The Home Channel: With this ticked mIRCStorm will simply broadcast out to the channel if the Bot does not have Op’s in the Home Channel.
Require Op’s (@) On Every Other Channel: Same as above but for every other channel, not including the home channel.
Perform These Commands Before Joining The Channels: Here you can give commands for the Bot to perform before it joins the channel. Each command must be given on its own line. For example you could login to nickserv, say hello to a friend then set a user mode.
/msg nickserve identify my-password
/msg friend hello there, hope your well…
I’m back!
/mode mbot +I
Perform These Commands After Joining The Channels: This is the same as above, apart from the commands are done after joining the channels. For example you may want to login to a fellow bot, or request for op’s in some way, or simply say hello.
/msg fellowbot login password-here
/msg fellowbot op #thischannel mbot
/msg $chan hello there everyone!
This is one of the features that really makes mIRCStorm stand out! Here you can load pre-made personalities. These are easy to make yourself, see chapter 7.
Every sentence that mIRCStorm knows comes from this file. With this file you can change the replies the Bot gives to commands, such as ‘adduser’ etc etc. Every command can be changed! You can make you Bot appear extra polite or very rude or just plain odd.
This Tab controls what personality file is currently loaded. There is no need to restart or rehash the Bot on loading a file.
Files that can be loaded are presented in the list on the left. On clicking a file its information will appear in the editboxes.
To load a personality simply select the file you wish to load and click the ‘Load Personality’ button. This will display a popup dialog that runs through and checks every response message. It does this so the Bot can reply on the file, so it knows there will be no problems.
To edit a file, click the ‘Edit Personality’ file or simply open the file in a text editor program.
This tab controls the addons currently install on mIRCStorm. Addons that are not currently loaded are listed at the top left. Addons that are currently loaded are listed at the lower left. mIRCStorm scans the Addon folder within the Bot for files to add here. To load an Addon, select it then click ‘Load Addon’. To Unload an Addon, select it and click ‘Unload Addon’.
Depending on the Addon more instructions may be displayed after. Official Addons can be found on the mIRCStorm website at http://www.mIRCStorm.co.uk
This tab is for advanced users only. It specifics the IP and Port that mIRCStorm will listen on for incoming Botnet connections.
Unless you have mapped more than one IP to your computer this will in most cases simply be the IP of the computer the Bot is hosted on.
For users who dial up direct to the Internet (where your computer has a Internet IP) you can simply enter this IP here.
Users on broadband or users who are behind some other network/firewall this will be the IP of your local machine rather than the Internet IP.
You can find your IP by clicking Start > Run. For windows XP/2000 enter cmd for windows 95/98 enter command. In the window that opens type ipconfig. This will display your IP.
Users who have Intranet IP’s and not Internet IP’s must ensure the Port you specify if forwarded onto your Intranet IP.
For example, I have broadband at my home: My Internet IP will be something like 81.34.213.2 (not actually my IP). My router is assigned this IP by DHCP. My computer is then connected to my router. The router assigns my computer a IP of 192.168.1.2. This is the IP that shows under ‘ipconfig’ and the one I enter into mIRCStorm for Botnet use. To others on the Internet however this IP means nothing. Say we select port 4444. My router must be setup to forward all incoming traffic to port 4444 onto my computer at 192.168.1.2. this way I can give my IP address as 81.34.213.2 to others to link my Bot.
I could go on for an age about how IP address and Ports work however this is not the point of this documentation. For more detail on IP routing try google.
This tab adds an extremely usefully feature to your Bot. It allows you to Backup every setting of mIRCStorm, including all users channels!
You can run a backup manually by clicking the ‘Run A Backup Now’ button. This can take up to a minute to process depending on the size of your database and the speed of your computer. It creates a single file in the Backup folder within mIRCStorm names by date and time of creation. You can look at this file yourself if you wish by opening it in a text editor.
Backups can be set to run automatically my mIRCStorm every Hour, every Day or every Week. I recommend the daily backup. The more you backup the more backup files will build up.
To restore your Bot from a backup, select the backup file to restore from and click ‘Restore Selected Backup. This will require a restart of the Bot.
You can also delete backup files from here by first selecting the file to delete and selecting delete button.
mIRCStorm features a detailed Online help system that enables users to help themselves on every feature of the Bot.
This system is accessed via the help command:
/msg mbot help <#channel>
This will cause mIRCStorm to send back a list of every command that the user can use. If the Full Access user uses this for example, all commands are listed. If a user with channel op access uses this, only commands up to his/her access are listed.
This list is sent by a /notice from the Bot. The list will look something like this:
<mbot> Global Command: Access: Anyone_
<mbot> banlist ping seen whois userlist version peak
<mbot> access levels bantype time date uptime osuptime
<mbot>
<mbot> Channel Voice: All Commands Above Included
<mbot> voice devoice greet who note lastlogin
<mbot> lastcom google
etc etc..
The list is broken down into sections ordered by Access Level. The lowest level is ‘Anyone’. Users do not need any access with the Bot to use these commands.
The commands for anyone are, banlist, ping, seen, whois, userlist, version, peak, etc etc
The commands for users who have Channel Voice access (or higher) are: Voice, devoice, greet, who, note, etc etc
This goes on right up to Full Access, showing what commands can be used by what user level.
More detailed help on each command is obtained again with the help command.
/msg mbot help <#channel> command
More examples follow…
1. User <Bob> wants to find out what commands he can use on the bot <mbot> in the channel:
<Bob> mbot help
<mbot> Global Command: Access: Anyone_
<mbot> banlist ping seen whois userlist version peak
<mbot> access levels bantype time date uptime osuptime
This shows that Bob is not a known user, hense he can only use the ‘anyone’ commands.
2. Bob would like to know to what the whois command is and how to use it:
<Bob> mbot help whois
<mbot> The WHOIS.ACCESS command
<mbot>
<mbot> This Command Will Imform Me To Tell You About A Nick
<mbot> Usage: (.msg) mbot whois (#channel) <nickname>
Bob now now knows he can find information about other users in his channel by typing mbot whois <nick>
3) Bob of course can do all of this without everyone else seeing what he is doing. To do this he must use issue the commands by private message.
/msg mbot help #channel
<mbot> Global Command: Access: Anyone
<mbot> banlist ping seen whois userlist version peak
<mbot> access levels bantype time date uptime osuptime
Bob can then do the command in the same way:
/msg mbot whois #channel <nick>
4) User Levels
i.
Global And Channel Explained
This section will explain the different user levels available on mIRCStorm and how they vary.
The idea of different user levels is so that the Bot/channel owner can choose who is allowed to do what and where. It limits what can and cannot be done by users.
There are two types of access levels on mIRCStorm. A user can have one type, both, or none.
Users who have no access level are classed as ‘anyone’.
The two types are channel access level and global access level:
The channel access level goes from channel voice (chanvoice) to channel owner (chanowner). The channel owner has a higher access than a channel voice and can do more commands. Channel access lists are channel dependent. That is a user can be channel owner of one channel, but have no access in another.
The global access level list is kept separate from the channel level list, users with global access range from global op (op) to full access. Global users have an even higher access level and can do commands in any channel, not just the channel they are added on.
You may be asking yourself why are these levels so different then? Surely the global level is just a higher access version of the channel? This is both correct and not correct:
Yes the global users have more access than channel user, however global users cannot use all the commands that a channel user can. For example a global master cannot kick the channel owner from a channel even though the access level is higher. His protects the channel owner and enforces the idea that the channel owner ‘owns’ the channel.
Another example of this, and the one most questioned is the GREET command. The greet command is used so the Bot messages the channel on arrival of the user who used the command. For example, I could set my greet command to “hey its you!!”. Every time I enter the channel mIRCStorm will message the channel with the text “hey its you!!”. To use this command you must have channel access. Global access alone will not allow you to use this command.
I point out again that a user can have channel access, global access, channel and global access or no access. If you use the whois command on yourself, you can see that a separate line for channel access: and global access: exists.
Thus a channel owner can add and remove global users to the channel access list, without the risk of altering the global users access. We wouldn’t want a channel owner removing a global users access completely would we!
5) Commands, A Detailed Look
i.
Introduction
This section will look at each command the Bot has in detail, listing both what it does and how to use it. This section is basically a re-written version of the online help system, it contains the same information.
ii.
Channel Voice Access Commands
The VOICE command
Usage: (.msg) mbot voice (#channel) <nick>
Voice's (+v) A User In A Channel.
Related Topics: Devoice Op Deop
The DeVoice command
Usage: (.msg) mbot devoice (#channel) <nick>
Devoice's (-v) A User In A Channel.
Related Topics: Voice Op Deop
The GREET command
Usage: (.msg) mbot greet (#channel) <Your-Greet-Messgae>
To Clear Greet: Usage: (.msg) mbot greet (#channel) none
The Greet Line Is A Line That The Bot Will Say To The Channel When You Join The Channel
The WHO command
Usage: (.msg) mbot who (#channel)
Gives Details About Who Is On A Channel.
Related Topics: whois
The NOTE command
Usage: (.msg) mbot note (#channel) <nick> <Message>
Sends A Note To A User.
The LASTLOGIN command
Usage: (.msg) mbot lastlogin (#channel)
Shows Who And When The Last Login
Related Topics: Lastcom
The LASTCOM command
Usage: (/msg) mbot lastcom (#channel)
Shows What, Who And When The Last Command Was
Related Topics: Lastlogin
The GOOGLE command
Usage: (.msg) mbot google (#channel) <topic>
Contacts google.com and returns the first found URL for a given topic.
iii.
Channel Op Access Commands
The OP command
Usage: (.msg) mbot op (#channel) <nick>
Op's (+o) A User In A Channel.
Related Topics: Voice DeVoice Deop
The DeOp command
Usage: (.msg) mbot deop (#channel) <nick>
DeOp's (-o) A User In A Channel.
Related Topics: Voice DeVoice Op
The KICK command
Usage: (.msg) mbot kick (#channel) <nick>
Kick's A User From A Channel
Related Topics: Invite Ban
The Ban command
Usage: (.msg) mbot ban (#channel) <nick.user@host>
Kicks And Bans A User From A Channel
Related Topics: Unban
The UnBan command
Usage: (.msg) mbot unban (#channel) <user@host>
UnBans A Mask From A Channel
Related Topics: Ban Invite
The Topic command
Usage: (.msg) mbot topic (#channel) <topic>
Changes The Topic In A Channel.
Related Topics: TopicLock TopicUnLock
The Mode command
Usage: (.msg) mbot mode (#channel) <+.-><mode> E.G. .msg mbot mode #botshed +m
Changes The Mode In A Channel.
Related Topics: ModeLock
The Wallops command
Usage: (/msg) mbot Wallops.Wall (#channel) <message>
Sends A Message To All The Ops On A Channel.
iv.
Channel Master Access Commands
The Adduser command
Usage: (/msg) mbot adduser (#channel) <nick> <level>
Adds A User To The Bot
Levels Remuser Moduser
The REMUSER command
Usage: (/msg) mbot remuser (#channel) <nick> (global)
Removes A User From The Bot
Use The global To Remove A User From The Global Access List. E.G. /msg mbot remuser #mircstorm Evil_Dave
If global Is Not Put The Bot Will Try To Remuser On Channel Access
Related Topics: Adduser Moduser
The MODUSER command
Usage: (/msg) mbot moduser (#channel) <nick> <NewLevel>
Changes The Access Level For A User
NOTE: Caution Should Be Taken When Using This For A Global User, Check Using The Whois Command
Related Topics: Adduser Remuser Whois
The CYCLE command
Usage: (/msg) mbot cycle (#channel)
Makes The User Part And Rejoin A Channel
Related Topics: Join Part
The SAY command
Usage: (/msg) mbot say (#channel) <message>
Makes The Bot Talk In A Channel.
Related Topics: msg notice wallops
The ONJOIN command
Usage: (/msg) mbot onjoin (#channel) <Clear.Add.Edit #.Show> (Text
Sets The Onjoin For A Channel.
Related Topics: greet
The INVITE command
Usage: (/msg) mbot invite (#channel) <nick> <reason
Invites A User To A Channel.
The CHANINFO command
Usage: (/msg) mbot chaninfo (#channel)
Displays Numer Of Op And Users On A Channel.
Related Topics: userlist whois
The TOPICLOCK command
Usage: (/msg) mbot topiclock (#channel) <Topic
This Will Completely Lock The Topic Of A Channel.
Related Topics: topicunlock topic
The TOPICUNLOCK command
Usage: (/msg) mbot topicunlock (#channel) <nick>
Will UnLock The Topic In A Channel So That It Can Now Be Changed.
Related Topics: topiclock topic
v.
Channel Owner Access Commands
The MODELOCK command
Usage: (/msg) mbot modelock (#channel) <on.off>
Locks The Modes Of The Channel.
The MOP (Mass Op) command
Usage: (/msg) mbot mop (#channel)
Will Op Every User On A Channel.
Related Topics: mdeop mvoice mdevoice
The MDEOP (Mass DeOp) command
Usage: (/msg) mbot mdeop (#channel)
Will DeOp Every User On The Channel, Other Than The Bot.
Related Topics: mop mvoice mdevoice
The MVOICE (Mass Voice) command
Usage: (/msg) mbot mvoice (#channel)
Voice's Every User On The Channel
Related Topics: mdevoice mop mdeop
The MDEVOICE (Mass DeVoice) command
Usage: (/msg) mbot mdevoice (#channel)
DeVoice's Every User On The Channel
Related Topics: mvoice mop mdeop
The SWEARKICK command
Usage: (/msg) mbot swearkick (#channel) <words/addword/remword>
Kicks Users Who Swear In The Given Channel.
‘Words’ Displays Currently Added SwearWords.
The CHANSET command
Usage: (/msg) mbot chanset (channel) <Mode>
Allows Setting Of Channel Modes. (flood-chan) (Peak) etc
For A List Of Modes See mbot chaninfo
vi.
Global Op Access Commands
The LOCK command
Usage: (/msg) mbot lock (#channel)
Locks A Channel. Set's Mode +smi And Enables ModeLock
Related Topics: modelock
The UNLOCK command
Usage: (/msg) mbot unlock (#channel
Unlocks A Locked Channel
Related Topics: modelock
The DCCME command
Usage: (/msg) mbot dccme
Causes The Bot To DCC Chat With You To Access To The Party Line.
The CHANNELS command
Usage: (/msg) mbot channels
Shows The Channels I Should Be And Am On.
The BACKUP command
Usage: (/msg) mbot backup
Backs Up The Bots Key Files, Such As User Files
Related Topics: rehash save restart
The CHHANDLE
Usage: (/msg) mbot chhandle (#channel) <OldNick> <NewNick
Changes A Users Handle To A New Handle.
vii.
Global Master Access Commands
The REHASH command
Usage: (/msg) mbot
Rehash's The Bot. ReLoading All Scripts And Checks Bot For Errors.
Related Topics: backup save restart
The RESTART command
Usage: (/msg) mbot restart
Restart's The Bot. Closes The Bots And Restarts It
Related Topics: save restart rehash
The JOIN command
Usage: (/msg) mbot join (#channel)
Makes The Bot Join A Channel And Add It To The Channel Files
Related Topics: part
The PART command
Usage: (/msg) mbot part (#channel)
Parts The Bot From A Channel.
Related Topics: join
The MSG command
Usage: (/msg) mbot msg <nick.chan> <message>
Makes The Bot Message A User.Channel.
Related Topics: say notice wallops
The SAVE command
Usage: (/msg) mbot save
Saves The Bots Files. Suggested To Do A Rehash After.
Related Topics: rehash backup restart
The BANNER (Broadcast) command
Usage: (/msg) mbot banner <message>
Sends A Message To Every Channel.
The NOTICE command
Usage: (/msg) mbot notice <#channel.nick>
Makes The Bot .notice A Chan.User
Related Topics: msg say wallops banner
The MAKECMD command
Usage: (/msg) mbot makecmd (#channel) <CommandTrigger/List/Del> <WhatToPerformOnTrigger>
Allows You To Make Your Own Command. E.g. Users Type !news And The Bot Will Perform Command Against The Trigger '!news'
viii.
Global Owner Access Commands
The DIE command
Usage: (/msg) mbot die (#channel)
Cause's The Bot To Shut Down.
Related Topics: restart rehash
ix.
Full Access Commands
The RAW command
Usage: (/msg) mbot raw (#channel) <commands>
Performs a raw command. E.g. mbot raw nick Krond
Will Change Bots Nick To 'Krond'
The CHPASS command
Usage: /msg mbot chpass #channel <Nick-To-Change> <New-Password>
Changes A Users Password.
6) Partyline And The Botnet
i.
Introduction
This Section explains the Partyline and Botnet features of mIRCStorm. You must have an understanding of networks/the internet and TCP/IP for the bulk of this section.
i. What Is The
Partyline
The partyline, from a chatting point of view, is that it acts as an IRC server with a single channel. Users known to the Bot can enter the partyline and talk to other users in the partyline just like on a normal IRC channel. The advantage here is that should your IRC network spilt in half (or more) you can still talk to all everyone regardless of them being in the a IRC channel with you or not. If one or more Bots are linked in a Botnet (more on this later) then users also talk over all the linked Bots. Example: User A connected to partyline line on Bot1 could talk on the partyline to user B on Bot2 if Bot1 and Bot2 are linked in a Botnet.
From an administrative point of view, it is much more than simply a place to chat. Administrators (Full access users) may not want users on the partyline at all, simply to keep it a place of maintenance and control.
Not only can you access a whole array of commands from here but you can see everything going on. Every login, command, mode change in any channel mIRCStorm is in, gets displayed in the partyline. You can see what commands users use in what channel and to whom.
It’s also a good idea for full access users to always be in the partyline, just in case. A good example of this: If the network splits or if all the servers mIRCStorm knows about go down then Full Access users can simply type ‘.jump <server>’ this will make the Bot connect to whatever server you supply. All server messages are relayed to the partyline.
When a user is on the partyline anything that does not start with a dot (.) is considered to be a message to all, just like on a channel. A message with a (.) at the front is considered to be a command and thus is not sent to all partyline users.
ii.
Partyline/DCC chat Commands
Don’t forget the ‘.’ At the start to tell
mIRCStorm you want to issue a command.
The ME command
Usage: .me <message>
Makes broadcast a message to all in the partyline from yourself as if you had used the /me feature in mIRC
The QUIT command
Usage: .quit (message)
Disconnects you from the partyline.
REHASH command
Usage: .rehash
This rehash’s the bot, you will get more detailed reports of the rehash from here.
The RESTART command
Usage: .restart
Command tells mIRCStorm to restart
The DIE command
Usage: .die
Causes mIRCStorm To Shut Down.
The JUMP command
Usage: .jump <server> (port)
This will make mIRCStorm disconnect from the current IRC server and re-connect to another. If no Port is given, mIRCStorm will use the default one set in main setup
The ECHO command
Usage: .echo <on/off>
With echo on, text that you shout out to the Botnet also gets sent to yourself. I.e. you can see your own text like in a channel. With echo off, you only see other users text. This is a global feature and will affect all users.
The MOTD command
Usage: .motd
Repeats the Message Of The Day again to you.
The WHOIS command
Usage: .whois <nick>
Attempts to give details about a nickname
For BOTNET commands please see ‘Linking a Bot’
Note that the partyline and Botnet are still regarded as in Beta, thus there are few working commands and things may not happen as expected.
iii.
What is a Botnet and why?
A mIRCStorm botnet is defined as a collection of one or more mIRCStorm bots linked together over TCP/IP.
There are a number of advantages of creating such a Botnet. The only current useful command is the XLOGIN.
The XLOGIN command
Usage: /msg <bot> xlogin <password>
The command does the same as a normal login; however it also will log you in on all connected botnet bots. For example if you have 4 mIRCStorm bots, you can connect them together in a botnet and login to them all with one xlogin command.
As the Botnet functions increase it will become more and more useful. For example you will be able to control other Bots on other networks through the partyline etc etc.
iv.
Linking a Bot
To link a Bot you must have a basic understanding of TCP/IP and Port resources. It is suggested you read ‘Botnet Tab’ in section 2 fully before attempting to link two or more bots.
First of all you select a ‘Hub’ Bot, this is normally the Bot with the most stable internet connection as if this Bot goes down then all the Bots linked to it also become disconnected from each other.
Now, connect to the partyline on the Hub and the Bot you want to connect up, the ‘leaf’ Bot. Ensure your Hub is correctly listening on an accessible port from the leaf.
On the leaf’s partyline use the .+bot command:
Usage: .+bot <bot> <ip:port>
For example if the Hub Bot is Named ‘mHub’ and the leaf is named ‘mLeaf’. I would type this on mLeaf:
.+bot mHub <ip:port>
The <ip:port> should be written like this: 192.168.1.1:4444. for example:
.+bot mHub 192.168.1.1:4444
Now on mLeaf type:
.link mBot
You will now see the bots link. You can test the link by typing a message on the partyline on one of them; you should be able to see the message on the other bot.
7) Creating your own….
i.
Personality
Creating your own personality is very easy. The easiest way is to start with the default one and edit this.
Open the Default.txt file in notepad or a similar text editor. Click Save As and select a new filename for your personality. You must save the text file inside the personality folder within mIRCStorm.
A typical section in the file looks like this:
[mIRCStorm]
Author=Evil_Dave
[mIRCStorm] is the section header.
Author is the item and ‘Evil_Dave’ is its
value.
This information is used in the main setup of mIRCStorm when browsing the personalities. To change simply edit the text evil_dave to your nickname.
If you now load up mIRCStorm, enter main setup and select the personality tab. You will see your new personality file listed on the left. If you select your new file, you will notice the Author now shows your name.
Now, going back to the personality file, edit every line to give the Bot your personality. For example:
loginOk=_LOGIN_ Authentication successful...
This is the message that mIRCStorm reply’s with on a successful login. So simply change it to:
loginOk=Your message here
The _’s tell mIRC that the text within is bold.
Some items have variables in them, for example:
MSGHomeOnloginOk=_LOGIN_ $nick (_ $+ %bot.temp.userhost.2 $+ _)
These will be different for every item, I have tryied to name then in ways so you can work out what it is. In this case for example the variable will be the users host. If you want to have text right next to the variable then you must use the $+ functions.
Valid lines:
Item=That’s correct %variable
Item=this is a good %variable you know
Item=whats that $nick you want %variable $+ ‘s
Not Valid lines:
Item=whats that you want %variable‘s
Item=yes $nick that’s you (%variable)
Don’t forget to post about your new personality on the mIRCStorm Forums, ifs its good then it will be added on the site for others to download.
ii.
Addon
Creating your own Addon, is just like creating a normal Addon script for mIRC, with a few extras. To be fully compatible with mIRCStorm you must do the following:
1) At the very top of your Addon create the lines:
[AddonInfo]
Author=YourName
AuthorWebsite=http://www.website.com
Description=Description blah blah
UsageInstrutions=UsageInstrutions blah blah
This information is used in the Addon Tab of Main Setup.
2) Creating correct inputs for your Addon, example a Trivia Game Addon may require users to type !StartGame etc.
Rather than using ‘!’ you can create your Addon in such a way that it uses the mIRCStorm triggers. Example, <bot> StartGame.
Your Addon must inform mIRCStorm of these triggers; otherwise the Bot will say ‘Unknown Command’ back to the user. This you do with the following code in your addon:
var %bot.cyclenum 1
while ( %bot.cyclenum <= 30) {
if ($readini Database\mIRCStorm.ini Addons UsingCommand [ $+ [
%bot.cyclenum ] ] == $null) {
writeini
Database\mIRCStorm.ini Addons UsingCommand [ $+ [ %bot.cyclenum ] ]
<Input-Command-1>
}
inc %bot.cyclenum 1
}
var %bot.cyclenum 1
while ( %bot.cyclenum <= 30) {
if ($readini Database\mIRCStorm.ini Addons UsingCommand [ $+ [
%bot.cyclenum ] ] == $null) {
writeini
Database\mIRCStorm.ini Addons UsingCommand [ $+ [ %bot.cyclenum ] ] <Input-Command-2>
}
inc %bot.cyclenum 1
}
etc etc...
The example above will add 2 input commands into mIRCStorm, replacing <Input-Command-1> and <Input-Command-2> with your commands. The code cycles through looking for Null entry’s in ‘Database\mIRCStorm.ini Addons UsingCommand<Number>’ when it finds a Null one it simply creates one with your input. mIRCStorm on every command checks these settings in case a input is being used. If the Bot detects an input in use it will do nothing. Your Addons therefore must cope with all inputs from this input. It is suggested that you add these inputs in the load section of your Addon
Note, for your Addon to be accepted onto the mIRCStorm website your Addon must also remove these inputs on unload.
8) What Happens If…
iii.
Where to go
If something has gone wrong, not how you expected, need help with a command, wants some scripting help to do with mircstorm, or anything about the bot you can get more help on our busy forums:
Once on the site, click the link for the Forums.