JavaOp in detail.

[O)Matt_Burch]

I saw someone wanted the javaop to be posted everything.. I've done that at my old clan forum a very long time ago.  But the code is a little messed up here..

JavaOp2

Plugins

• Advertisements
  -I don't see any use for this, but it displays the ads that you would see if you were on a real client.  It requests a new ad every 15 seconds, and I've found that a new one is usually loaded every half hour or so.
  
• Aliases
  -Lets users specify custom aliases for commands.
  
• AntiFlood
  -This is an anti-flood algorithm based on one that I wrote, which was based loosely on Adron's.  I've never flooded off with this algorithm before, but I hear that it gets unbearably slow after awhile.  It works well for my uses, though, if anybody has a better one that they feel like porting to Java, be my guest and I'll include it in releases.
  
• Auto-Rejoin
  -This plugin will automatically rejoin the channel when kicked, or join a custom channel on ban
  
• Autoban Plugin
  -Bans users who enter the channel who B and S, or that have Z.  It also autobans users when their flags are changed to include B or Z.
  
• Away Message
  -Sets an away message that tells people how long you've been away from your bot.  This is reset by, by default, any outgoing text that doesn't begin with /, so if somebody uses .say or a similar command the idle turns off.
  
• Basic Commands
  A collection of basic commands that most bots have.
  
• Battle.net Login Plugin
  -This is iago's version of the Battle.net login.  It starts with sending SID_AUTHINFO when the connection is made, and ends with SID_ENTERCHAT and SID_JOINCHANNEL.  It supports any keyed product, from Starcraft to War3 Expansion.  For the code itself, the CDKey decoding for the legacy products was reversed and written by iago.  The CDKey decoding for Warcraft 3 is based on work done by Maddox and Telos, ported to Java by iago.  The CheckRevision and SHA1 code used for the legacy products is based on Yobgul's code, again ported to Java by iago.  Finally, the SRP (war3 login) code was reversed and written by Maddox, iago, and TheMinistered and ported to Java by iago.
  
• Channel Lock
  -This plugin allows you to lock a channel to make it private or to stop people from joining.
  
• Channel List Plugin
  -iago debated with himself whether to put this functionality in a plugin, or to make it part of the core.  He decided to make it a plugin, but I HIGHLY recommend not disabling this, because if you do the bot will have no idea if somebody joins or leaves the channel, the list of users in the channel will always be blank.  Don't disable this one.
  
• Commands
  -This plugin looks after checking for the trigger and raising commands.
  
• Connection Commands
  -Commands that allow the user to disconnect, reconnect, and quit the bot.
  
• Console Display Plugin
  -This displays messages to the console for events and errors.  If color is enabled, then it displays them in ANSI color codes, which work on Linux, but not on Windows XP, it seems.  I read somewhere about enabling ANSI.sys on Windows to get it working, and if anybody manages that, please let me know.
  
• Designate
  -This plugin has commands for designating or op'ing users.  It also has auto-designate for users with the proper flags.
  
• Email Registration Plugin
  -Allows users to set an email address for their account, and to request their password be reset
  
• Filter Plugin
  -Filters messages from users who have certain flags, or if a message matches a certain pattern
  
• Forwarding
  -Can forward all messages or whispered messages to the specified user.  This is done at run-time, if the plugin is reloaded the forwarding is disabled.
  
• Fun Stuff
  -This plugin provides useless functionality such as flipping a coin, picking a random number, etc.
  
• Global Connect
  -This plugin allows you to disconnect and connect bots other then the one currently connected.
  
• Greeting
  -A plugin for annoying things like greet and idles
  
• Help
  -It lets users use the .help command.  If no parameters are specified, it lists the commands that the bot currently understands.  If it is given one or more parameters, it'll give the user the usage and description of the command.
  
• IP Ban
  -When a user is .ipban'd, he is banned and squelched.  If a user who is squelched enters the channel, he will automatically be banned.  I wouldn't recommend using this plugin for a chat bot, because the attempts to ban people might get annoying.
  
• Ladder
  -This plugin can pull information from the ladder page.  Overall, pretty useless, but not a bad toy to play with.
  
• Logging Plugin
  -Logs all chat, events, and errors to a file.
  
• Mail Plugin
  -This plugin is for sending/receiving botmail
  
• Moderation Plugin
  -This includes the various basic moderation commands, such as kick and ban.  The flags required to use the various bans/kicks are configurable, so you can set up who can ban who in your clan.
  
• Ping Plugin
  -Returns a ping message (if set to) when SID_PING is received.  Also sends back the UDP Ping probe at the appropriate time.  Either of these can be disabled to get either "unplugged" icon, or -1ms ping. This also handles displaying of the SID_EXTRAWORK packet.
  
• Profile
  -This plugin allows the user to change/view their profile on Battle.net.  SwingGUI can show the profile graphically, but this is textbased.
  
• Remote Control
  -This allows users to control their bot from another computer or from the same computer in such a way that the gui can be detached/re-attached.  It uses a TCP connection and an ObjectOutputStream, which means it would be fairly difficult to write a client in anything other than Java.
  
• SBCP
  -Allows you to connect with SBCP
  
• Shell
  -Provides functions for running commands on the local system from Battle.net.  This can be used for things like changing songs on an mp3 player.  I recommend using aliases to save your brain.
  
• Show Invisible Users
  -Sends a /unsquelch at itself when it detects it is entering an invisible channel; also, it's possible to set the plugin to periodically do it in normal channels, to search for invisible users; however, this doesn't really work anymore (although you never know)!
  
• Simple Event Processor
  -A very simple event parser which just translates the incoming events (EID_JOIN, for instance) into the appropriate events that can be understood by the display plugins.  The reason this is separate is so that a filter can be put in the middle that will hide floodbots and such.  If you're using a different event processor, DON'T use this one too.  Otherwise, you'll end up seeing events happening twice.
  
• Sweepban
  -Adds the .sweepban command which lets a user with access ban everybody in a channel
  
• Swing Gui plugin
  -Dislays a fully function Swing gui for the bots.
  
• USer Information
  -This plugin stores and displays long-term type information about users such as when they were last seen and how often they are seen.
  
• User Management
  -This has the commands for adding, finding, and removing users from the user database.
  
• Version Plugin
  -Returns the bot version.
  
• War3 Clan Plugin
  -So far, just displays some clan-related information
  
• Whisper on Leave Plugin
  -This plugin allows you to send whispers to users when they leave the channel. You must restart JavaOp after enabling this plugin.
  

If there is anything in those plugin description saying I, Me, or myself. it wasn't actually me, but the person who made the plugin.

Flags[/b]

The concept of flags is pretty simple. Every user has zero or more flags, each of which are represented by a single alphabetic character. Each flag represents something different. Although the role of the flags are entirely up to the plugins, some conventions include:

• A -- user Administration
• B -- Autobanned
• C -- Connection related
• D -- Designate
• E -- auto dEsignate
• F -- Friend
• L -- Low level commands
• M -- Master
• N -- uNrestricted access
• O -- channel Ops
• P -- Permenant
• Q -- Quit
• S -- Safe
• T -- Talk
• U -- Universal (or User-level)
• Z -- Zapped

Some flags give the user access to bot commands (A gives .setuser, O gives .ban, etc.), some flags mark the user as somebody special (S is safelisted, and B is autobanned), and some flags have a special effect (E users are automatically generated when the user enters the channel). What a flag does is really up to the plugins that use it.

Friends/Autoban/Safe/Zapped

There are four flags that control, to some extent, the user's presence in the channel. Ordered from the least powerful to the most powerful:

• Friend -- This indicates that the user is a welcomed guest in the channel. They won't be affected by certain automatic bans.
  
• Autoban -- If a user has the B flag, they will be banned as soon as they enter the channel provided they don't have the S flag.
  
• Safe -- This is for users who are in the clan or are friends with the bot creator. Most commands won't work on them, they can only be banned by a leader with the .banz command. The only negative flag that affects them is...
  
• Zapped -- A user with Z will be banned when they enter the channel, no matter what other flags they have.
  
  

Ban/Kick Commands

There are 3 levels of ban/kick commands. It can be customized who can use which, but by default to use the "z" level, you require N or M flags, and to use the normal or "f" level, you need O or N. Here are the default moderation commands:

• banf/kickf -- Bans or kicks all users specified that don't have F or S flag.
  
• ban/kick -- Bans or kicks all users specified that don't have S.
  
• banz/kickz -- Bans or kicks all users.
  

User Management Flags
A can change BFLS
G can change BFJLST
N can change ABCDEFGHIJKLNOPQRSTVWXYZ
P can be modified by MN

Commands[/b]

• accept
  -accept <clan name> - N - Accepts an invitation to a clan
  
• addalias
  -addalias <alias> <command> [parameters] - N - Adds an alias to the specified command.
  -Parameters may contain: %u for user, %v for bot version, and %n for bot name.
  
• addquote
  -addquote <quote> - L - Adds a quote to the quote database
  
• ban
  -ban <user> [message] - ON - Bans the requested user from the channel, as long as they don't have the S flag.
  
• banf
  -banf <user> [message] - ON - Bans the requested user from the channel, as long as they don't have F or S flags.
  
• banz
  -banz <user> [message] - N - Bans the requested user from the channel, regardless of which flags they have.
  
• botlist
  -botlist  - U - Returns a list of all running bots.
  
• broodladder
  -broodladder [starting number] [sort method] - AN - Displays the Brood War ladder.  'Starting number' is the first number displayed; 'Sort method' is either 'rating', 'wins', or 'games'
  
• clearqueue
  -clearqueue  - AN - Clears the current queue of outgoing messages, and resets timers.
  -Alias = cq
  
  • close
    -close  - C - Disconnects and cleans up the current instance
    
  • decline
    -decline <clan name> - N - Rejects an invitation to a clan
    
  • define
    -define  - L - Tries to get the dictionary definition of the word
    
  • deleteaccesslevel
    -deleteaccesslevel [access level] - A - Deletes an access level. All users in this access level will remain.
    
  • deluser
    -level will remain.
    
  • designate
    -designate [user] - D - Designates the requested user.  If no user is speciied, it designates the person that used the command.
    -Alias = des
    
  • disconnect
    -disconnect  - C - Disconnects the bot from Battle.net.  Not usually a good idea.
    
  • filter
    -filter <pattern> - N - Filters messages containing the specified pattern (you may use * and ?)
    
    • filters
      -filters  - N - Lists the filters
      
    • filterword
      -filterword <word or phrase> - N - Filters the specified word or phrase
      
    • find
      - find <userlist> - AGN - Finds the flags for the requested user
      
    • findattr
      -findattr <flag> - AGN - Lists all users with the specified flag
      
    • firstseen
      -firstseen <username> - ALN - Shows the first time the specified user was seen
      
    • forwardall
      -forwardall [user] - N - Forwards all information from the channel to the specifed user.  If none is specified, forwards to the user who used the command.
      
    • forwardoff
      -forwardoff  - N - Removes message forwarding.
      
    • forwardwhispers
      -forwardwhispers [user] - N - Forwards whispers in the channel to the specified user.  If none is specified, forwards to the user who used the command.
      
    • game
      -game  - AGLN - Shows the game that the bot is connected as
      
    • gconnect
      -gconnect [bot name] - U - Connects a bot based on its name.
      
    • getalias
      -getalias <alias> - LAN - Shows the command that this alias points to
      
    • getflagsfor
      -getflagsfor <command> - AN - Retrieves the customized flags required to user a command on this bot.
      
    • getmail
      -[number list] - L - Retrieves the specified message or all messages
      
    • greet
      -greet [on|off] - AN - Turns greeting on or off, or shows the current status
      
    • help
      -help [command(s)] - ANL - Gives help on the specified command(s). If no commands are specified, it lists all commands that you can use.
      
    • helpall
      -helpall [command(s)] - ANL - Gives help on the specified command(s). If no commands are specified, it lists all commands.
      
    • home
      -home  - J - Tells the bot to go to its home channel
      
    • host
      -host <hostname> - L - Resolves the given hostname to its ip(s)
      -e.g.
      -host USWest.Battle.Net
      -<From: O)Matt_Burch@Lordaeron[/b]> USWest.Battle.net: 63.241.83.107, 63.241.83.108, 63.241.83.109, 63.241.83.11, 63.241.83.110, <more>
      <From: O)Matt_Burch@Lordaeron[/b]> 63.241.83.111, 63.241.83.112, 63.241.83.12, 63.241.83.13, 63.241.83.7, 63.241.83.8, <more>
      <From: O)Matt_Burch@Lordaeron[/b]> 63.241.83.9
      
    • idle
      -idle [count|time|off] - AN - Sets the idle to specified type, or shows current type
      
    • idlecount
      -idlecount [count] - AN - Sets the count or time between idles, depending on the idle type
      
    • invites
      -invites  - AN - Lists the pending invites
      
    • ipban
      -ipban <username> - ON - Squelches the specified user, which causes an ipban on them
      
    • join
      -join <channel> - J - Joins the specified channel
      
    • kick
      -kick <user> [message] - ON - Kicks the requested user from the channel, as long as they don't have the S flag.
      
      • kickf
        -kickf <user> [message] - ON - Kicks the requested user from the channel, as long as they don't have F or S flags.
        
      • kickz
        -kickz <user> [message] - N - Kicks the requested user from the channel, regardless of which flags they have.
        
      • lastseen
        -lastseen <username> - ALN - Shows the last time the specified user was seen
        
      • lastwhisper
        -lastwhisper  - N - Shows the last user to give a command
        
      • leavemessage
        -leavemessage [message] - AN - Displays the current message sent to users who leave or sets it.
        
        • listaccesslevels
          -listaccesslevels  - A - Gives a list of all access levels.
          
        • listaliases
          -listaliases <command> - LAN - Lists all aliases to the specified command
          
        • lock
          -ock [kick/ban] - O - Locks the channel so that any user that joins will be kicked.
          
        • loud
          -oud <command/params> - ANL - Runs a command, sending its output to the channel, regardless of what the 'loud' setting is
          
        • mail
          -mail <user> <message> - ALN - Sends a message to the specified user
          
        • op
          -op [user] - D - Designates the requested user, then rejoins the channel.  If no user is specified, it designates the user that used the command.
          
        • pickrandom
          -pickrandom <option list> - L - Picks a random option from the list.  Options are separated by commas
          
        • ping
          -ping <user> - AN - Pings the specified user
          
        • profile
          -profile <user> [keys] - L - This will get and display the requested profile keys (comma-separated list).  If no keys are specified, it uses the local setting 'default keys'
          
        • quiet
          -quiet <command/params> - ANL - Runs a command, whispering back the result, regardless of what the 'loud' setting is
          
        • quit
          -quit  - U - Closes the bot, along with all instances.
          
        • quote
          -quote [num] - L - Displays the specified quote (or a random one if none is specified)
          
        • random
          -random [min] [max] - L - Picks a random number between min and max.  If only one parameter is given, it picks between 1 and <max>.  If no parameters are given, it picks between 1 and 10.
          
        • reconnect
          -reconnect  - C - Reconnects to Battle.net
          
        • rejoin
          -rejoin  - J - Rejoins the current channel
          
        • removealias
          -removealias <alias(es)> - N - Removes an alias
          
        • removealiases
          -removealiases <command> - N - Removes all aliases pointing to the command.  Remember that default aliases will re-load when the bot starts.
          
          • removemail
            -removemail [number list] - L - Removes the specified message
            
          • removequote
            =removequote <??> - A - Removes a quote from the quote database
            
          • reply
            -reply <message> - U - Whispers a message back to the last person who sent a message
            
          • rewhisper
            -rewhisper <message> - U - Whispers a message to the last person a message was whispered to
            
          • run
            -run <command> <parameters> - U - Runs the specified local command and displays the output.  I don't recommend using this for anything that returns more than a couple lines
            
          • runquiet
            -runquiet <command> <parameters> - U - Runs the specified local command without returning any output.  I recommend using this with aliases
            
          • runstop
            -runstop <command num> - U - Stops the specified local command from running
            
          • say
            -say <text> - T - Says the specified text out loud
            
          • seen
            -seen <username> - ALN - Shows whether the bot has seen the specified user
            
          • setaccesslevel
            -setaccesslevel [access level, flags] - A - Adds a new access level with flags.
            
          • setflagsfor
            -setflagsfor <command> [flags] - N - Sets the flags required to use a command on this bot to the specified flags.  If [flags] isn't included, it is reset to defaults.
            
            • setgreet
              -setgreet [message] - AN - Sets the greet message. 
              -%c = channel
              -%v = bot version
              -%n = username
              -%p = ping
              
            • setidle
              -setidle [message] - AN - Sets the idle message. 
              -%c = channel
              -%v = bot version
              
            • setprofile
              -setprofile <key> <value> - N - This will set the requested key to the requested value.
              -Keys are typically
              -profile\sex, profile\location, and profile\description. 
              -If you don't understand this, you can use the SwingGui to set profile data.
              -Be careful -- the wrong key can get you ipbanned.
              
            • settrigger
              -settrigger [new trigger] - N - Sets the trigger to the specified value.
              -The trigger can be 0 or more characters, although a 0-character trigger gets very annoying
              
            • setuser
              -setuser <userlist> <flags> - AGN - Adds or removes flags from a user.  The flag list is a set of +/- and flags, like +ABC-D+E-F
              
            • silent
              -silent <command/params> - ANL - Runs a command, sending output only to the console, regardless of what the 'loud' setting is
              
            • starladder
              -starladder [starting number] [sort method] - AN - Displays the Starcraft ladder.  'Starting number' is the first number displayed; 'Sort method' is either 'rating', 'wins', or 'games'
              
            • sweepban
              -sweepban <channel> - ON - Bans everybody in the selected channel.  Two channels may not be sweepbanned at the same time.
              
            • sweepbanip
              -sweepbanip <channel> - ON - Bans everybody in the selected channel based on their ip.  Twochannels cannot be sweepbanned at the same time
              
            • testqueue
              -testqueue <size> - M - Sends 250 messages of the specified size
              
            • time
              -time  - L - Displays the current time/date
              
            • unban
              -unban <users> - ON - Unbans the requested user.
              
            • unfilter
              -unfilter <pattern> - N - Removes the pattern (you may use * and ?)
              
            • unfilterword
              -unfilterword <word or phrase> - N - Removed the filtered word or phrase
              
            • unipban
              -unipban <username> - ON - Unsquelches the specified user, which causes an ipban to be removed
              
            • unlock
              -unlock  - O - Removes the effect of lock
              
            • uptime
              -uptime  - ALN - Gives the time the bot's been online for
              
            • usage
              -usage [command(s)] - ANL - Gives the usage for the specified command(s).
              
            • useaccesslevel
              -useaccesslevel [user, access level] - A - Sets a user to a access level.
              
            • version
              -version <null> - ANL - Displays the current bot version.
              
            • w3profile
              -w3profile <user> - L - This will request the profile information for a War3 account
              
            • war2ladder
              -war2ladder [starting number] [sort method] - AN - Displays the Warcraft 2 ladder.  'Starting number' is the first number displayed; 'Sort method' is either 'rating', 'wins', or 'games'
              
            • whatcanichange
              -whatcanichange  - AGNL - Tells you which flags you're allowed to modify
              
            • where
              -where  - ALN - Tells the user where the bot is
              
            • whoami
              -whoami  - AGNL - Shows you all the flags you have
              
              N
              accept
              addalias
              ban
              banf
              banz
              broodwarladder
              clearqueue
              decline
              filter
              filters
              filterword
              find
              findattr
              firstseen
              forwardall
              forwardoff
              forwardwhispers
              game
              getalias
              getflagsfor
              greet
              help
              helpall
              Idle
              idlecount
              invites
              ipban
              kick
              kickf
              kickz
              lastseen
              lastwhisper
              leavemessage
              listaliases
              loud
              mail
              ping
              quiet
              removealias
              removealiases
              Seen
              Setflagsfor
              SetGreet
              setidle
              setprofile
              settrigger
              setuser
              silent
              starladder
              sweepban
              sweepbanip
              unban
              unfilter
              unfilterword
              unipban
              uptime
              usage
              version
              war2ladder
              whatcanichange
              where
              whoami
              
              L
              addquote
              define
              firstseen
              game
              getalias
              getmail
              help
              helpall
              Host
              lastseen
              listaliases
              loud
              mail
              pickrandom
              profile
              quiet
              quote
              random
              removemail
              Seen
              silent
              Time
              uptime
              usage
              version
              w3profile
              whatcanichange
              where
              whoami
              
              O
              ban
              banf
              ipban
              kick
              kickf
              lock
              sweepban
              sweepbanip
              unban
              unipban
              unlock
              
              U
              botlist
              
              A
              broodwarladder
              clearqueue
              deleteaccesslevel
              find
              findattr
              firstseen
              game
              greet
              getalias
              getflagsfor
              help
              helpall
              Idle
              Idlecount
              Invites
              lastseen
              leavemessage
              listaccesslevels
              listaliases
              loud
              mail
              ping
              quiet
              removequote
              seen
              setaccesslevel
              setgreet
              setidle
              setuser
              silent
              starladder
              uptime
              usage
              useaccesslevel
              version
              war2ladder
              whatcanichange
              where
              whoami
              
              C
              close
              disconnect
              reconnect
              
              
              D
              Designate
              op
              
              G
              find
              findattr
              game
              setuser
              whatcanichange
              whoami
              
              U
              gconnect
              quit
              reply
              rewhisper
              run
              runquiet
              runstop
              
              J
              home
              join
              rejoin
              
              T
              say
              
              M
              testqueue

[Ajan]

Great job! I guess some ppl might find this very handy but it'd be far easier to put it on bot's site imho.

BTW isn't the indentation a little messed up?

[Hdx]

What I ment was I wanted all the MODIFICATIONS, or addons that you guys wanted made to be listed, not all the current features.
And this would e best listed in a text document, AE the readmes for the plugins.
~Hdx

[trust]

Didn't I write an automoderation plugin? Where is that?!

[iago]

Didn't I write an automoderation plugin? Where is that?!

That was for JavaOp1, loser!

[Warrior]

How hard would it be to port it?

[iago]

You'd be better off writing it from scratch, since it's not all that complex.

[trust]

Didn't I write an automoderation plugin? Where is that?!

That was for JavaOp1, loser!

oh. Maybe I'll write a new one.

[Newby]

Intense list. Haha.

[trust]

do you have any of my plugins still iago?

[iago]

Probably, I don't normally delete stuff.

[O)Matt_Burch]

I was just bored one day, and just copied the info in the plugin spot, then did help and usage for all the current commands.  copied it.  then found the flags thing somewhere..

Is my anti flood numbers in the new bot?

[Chavo]

You should find the plugins I wrote some time ago and uploaded somewhere around here.  They have some pretty unique features.

[Joe]

I haven't upgraded anything except for iago's old code.

EDIT -
Well, anything he tossed on the CVS. I think a few of Ryan's projects made it there.

[Ergot]

Why is this not stickied yet?