Myriad Readme
for Version 3.0.0
Thank you for choosing Myriad. Myriad is an advanced Battle.net bot designed to be both powerful and fast. This document will attempt to cover everything you need to know to use Myriad, including installation and configuration. For now, all that is documented are the commands. We hope the rest is straightforward enough for anyone with some bot experience to use. If you have a question that this document does not answer, you should consult the forums.
Again, thank you for using Myriad!
Commands
A listing of Myriad's commands, roughly organized into categories, follows. If you find documentation of a command that is incomplete or incorrect, or any missing commands, please contact Scope.
Skip to Category:
Moderation
Database
Miscellaneous
Winamp
Clan Management
Moderation Commands
.kick {user} [message]
Kicks the specified user out of the channel, if you have more access than him or her.
Required access: 50
NOTE: This command supports wildcards.
.ban {user} [message]
Bans the specified user from the channel, if you have more access than him or her.
Required access: 60
NOTE: This command supports wildcards.
.unban {user}
Unbans the specified user.
Required access: 60
.designate {user}
Designates the specified user.
Required access: 80
.resign
“Resigns” from ops (gives it up).
Required access: 90
.giveops {user}
Designated the specified user and resigns.
Required access: 90
.ipbans [on|off]
Turns IP-bans on or off, or checks whether IP-bans are on.
Required access: 80 to turn on/off; 20 to check status
.ipban {user}
Bans all users in the channel that are on the same IP as the specified user.
Required access: 65
Aliases: .ip
.unipban {user}
Unbans and lifts the IP-ban on the specified user.
Required access: 65
.sweepban {channel}
Bans all users in the specified channel.
Required access: 75
.plugbans [on|off]
Turns plugbans on or off, or checks whether plugbans are on.
Required access: 80 to turn on/off; 20 to check status
.clientbans [on|off|(client) [on|off]]
Operates client-bans – automatic bans of specific clients.
Required access: 80 to turn on/off; 20 to check status.
Usage:
.clientbans: – Checks whether client-bans are enabled or disabled.
.clientbans on|off – Turns client-bans on or off.
.clientbans (client) – Checks whether the specified client will be banned.
.clientbans (client) on|off – Turns client-bans on or off for the specified client.
.idlebans
Turns idlebans on or off, checks its status, or sets the delay.
Required access: 80 to modify; 20 to check status
Usage: .idlebans can be followed by any of the following. Order doesn't matter.
on – Turns idlebans on.
off – Turns idlebans off.
(a number) – Sets idleban delay.
min, minutes, minute – Specified delay is in minutes.
sec, seconds, second – Specified delay is in seconds.
.phrasebans [on|off]
Turns phrasebans on or off, or checks its status.
Required access: 80 to turn on/off, 20 to check status
.tagadd {pattern}
Adds a “tagban”, which bans all users matching the specified pattern.
Required access: 75
Aliases: .tagban, .tb., .ta
NOTE This command makes use of wildcards for pattern matching.
.tagdel {pattern}
Removes the specified tagban.
Required access: 75
Aliases: .untagban, .tagunban, .td
.flood {index}
This is the bot's flood banning system.
Required access: (Master)
Usage: .flood can be followed by any of the following. Order doesn't matter.
0|off – Turns flood protection off.
1|low – Turns flood protection on low.
2|medium – Turns flood protection on medium
3|high – Turns flood protection on high (ignores safelist)
4|suicidal – Turns flood protection on suicidal (bans everything, no queue)
Aliases: .fp, .floodprotection, .floodmode
.lockdown
Turns lockdown on/off, checks its status, or sets a message.
Required access: 20 to check status; 80 to modify.
Usage: .lockdown can be followed by any of the following. Order doesn't matter.
on|off – Turns lockdown on/off.
message|msg|m – Sets the ban message for lockdown.
Aliases: .ld
Database Commands
.whois {user}
Retrieves the access of the specified user.
Required access: 20
Aliases: .find, .a
.whoami
Retrieves your access.
Required access: 20
Aliases: .whoami, .a, .mya
.add {username} [access] [flags]
Adds the specified user to the database with the given access and/or flags.
Required access: (No hard requirement, though you can only add users to lower access than you.)
Alias: .set
NOTE: Access and flags can be given in any order.
.rem {username}
Removes the specified user from the database.
Required access: (No hard requirement, but you can only remove lesser users.)
Miscellaneous Commands
.cq
Clears the queue of messages waiting to be sent.
Required access: 70
.scq
Clears the queue of messages waiting to be sent, without displaying a confirmation.
Required access: 70
.reconnect
Reconnects the bot to Battle.Net. Any changes made in the configuration file will be applied.
Required access: (Master)
Alias: .rc
.quit
Quits the bot.
Required access: (Master)
Alias: .exit, .kill
.rejoin
Rejoins the channel.
Required access: 90
.ver
Shows the bot's version.
Aliases: .about, .version
Required access: 20
.say {text}
The bot will repeat whatever message you have sent.
Required access: 40
NOTE: In order to use this command to send Battle.Net commands, you must be a bot master.
.idle [mode | delay [unit]]
Says the active idle message, or edits the message.
Required access: 60
Usage:
.idle — Displays the active idle message.
.idle on|off — Turns anti-idling on or off.
.idle mode — Switches idle to the specified mode.
mode can be any of the following:
• uptime — Idles bot and system uptime.
• custom, message — Uses a custom message. May be followed by a new message.
• version — Idles the bot's version.
• mp3 — Idles the song currently playing in Winamp.
• quote, quotes — Idles a random quote.
.idle delay [unit]
The mode can be followed by the delay, which may be followed by “minutes” or “seconds”. The delay defaults to minutes.
.greet [on|off|msg [message]|message [message]|whisperon|whisperoff|whisper {on|off}]
Displays the active greet message, turns greeting on or off, or edits the message.
Required access: 60
Alias: greetings
Usage:
.greet — Says whether greet messages are on or off.
.greet on|off — Turns greet messages on or off.
.greet msg|message — Displays the active greet message.
.greet msg|message message — Changes the greet message to the specified new message.
.greet whisperon|whisperoff|whisper on|whisper off — Controls whether greet messages will be whispered or not.
.uptime
Says how long the system and bot have been running.
Required access: 20
.dns {domain or IP}
Attempts to resolve the specified domain to an IP, or an IP to domain.
Required access: 20
.os
Displays information about the active version of Windows.
Required access: 20
.ping [user]
Gets the ping of the specified user. If you leave the user blank, gets your ping.
Required access: 20
.pingme
Gets your ping.
Required access: 20
Alias: .myping
.sp
Gets the ping of the bot.
Required access: 20
Alias: .selfping
.flip
Flips a virtual coin.
Required access: 20
.var {field} [value]
Displays the value of {field}, or sets it to a new value.
Required access: (Master)
Aliases: .setvar, .getvar
Available Fields: username (or un), password (or pw), server, hashed, home, cdkey (or key), expcdkey (or expkey, exkey, excdkey, lodkey, tftkey, lodcdkey, tftcdkey), client (or product or game), trigger
.reloaddatabase
Reloads the bot's user database for access.
Required access: 70
Aliases: .reloaddb, .dbload, .rd
.generatestar
Generates a random StarCraft CD-Key. Note rarely any key will work.
Required access: 70
Aliases: .generatesexp, .star, .sexp
.network
Tells you if the bot is using BNLS or Local hashes to connect.
Required access: 50
Aliases: .nw
.clear
Clears the chat window and event log window.
Required access: (Master)
Winamp Commands
.mp3
Shows the song currently playing in Winamp
Required access: 20
.loadwinamp
Starts winamp.
Required access: (Master)
Alias: .mp3 load
.findwinamp
Finds winamp.
Required access: (Master)
.play
Starts playback in Winamp.
Required access: (Master)
.stop
Stops current song in Winamp.
Required access: (Master)
.pause
Pauses the song currently playing in winamp.
Required access: (Master)
.next
Goes to the next song in Winamp.
Required access: (Master)
Alias: .skip
.prev
Goes to the previous song in Winamp.
Required access: (Master)
Aliases: .back, .last
Clan Management
.messageoftheday [message]
Views and/or changes the Clan's Message of The Day.
Required access: 30 to view, 90 to change
Aliases: .motd
.chieftain
Displays the clans current chieftain
Required access: 30
.shamans
Displays the clans current shaman(s).
Required access: 30
.ddp {user}
Must be a chieftain to do. DDP will designate SC ops without having to demote all your shamans. Its design (demote-designate-promote) will demote all current shamans, designate and resign the SC ops you want, and then re-promote all your current shamans.
Required access: (Master)
.invite {username}
Must be a grunt or higher to use. Invites the specified user to the clan.
Required access: 50
.promote {username}
Promotes the specified user to the next highest rank.
Required access: (Master)
.demote {username}
Demotes the specified user to the next lowest rank.
Required access: (Master)
.exile {username}
Removes the specified user from the clan.
Required access: (Master)
Aliases: .discharge, .expel, .oust
.rank {username}
Displays the current rank of the bot or specified user.
Required access: 40
.meeting [on|off|floor [user]|open|close]
Automatic discussion moderation of clan meetings.
Required access: 20 to check status, master to operate.
Aliases: .meet, .m