StealthBot commands.xml

<commands version="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <command name="help" enabled="1">
    <aliases/>
    <documentation>
      <description>Provides additional information on a command such as the format, parameters, and a description of its function.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="command" type="word">
        <documentation>
          <description>The command you wish to retrieve information about.</description>
          <specialnotes/>
        </documentation>
      </argument>
      <argument name="scriptowner" optional="1">
        <documentation>
          <description>The script that this command is registered to.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="helprank" enabled="1">
    <aliases>
      <alias>helpr</alias>
      <alias>access</alias>
      <alias>list</alias>
      <alias>commands</alias>
    </aliases>
    <documentation>
      <description>Lists the commands available to users with the specified rank.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="rank" type="numeric">
        <documentation>
          <description>The maximum rank you wish to find commands for.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="about" owner="Clan Moderation" enabled="1">
    <aliases>
      <alias>version</alias>
      <alias>ver</alias>
    </aliases>
    <documentation>
      <description>States the bot's version information.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="trigger" enabled="1">
    <aliases/>
    <documentation>
      <description>States the current string used for command identification.</description>
      <specialnotes>This command can be executed with the trigger '?', EXA: ?trigger</specialnotes>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="settrigger" enabled="1">
    <aliases/>
    <documentation>
      <description>Sets the bot's command identifier to the specified string.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="trigger" type="word">
        <documentation>
          <description>The command indentifier to set to.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="cq" enabled="1">
    <aliases/>
    <documentation>
      <description>Clears the outgoing chat message queue.</description>
      <specialnotes/>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="time" enabled="1">
    <aliases/>
    <documentation>
      <description>States the current system time.</description>
      <specialnotes/>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="uptime" enabled="1">
    <aliases/>
    <documentation>
      <description>States the current system and application operational times.</description>
      <specialnotes/>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="autobot" owner="SC Remastered Bot API Helper" enabled="1">
    <aliases/>
    <documentation>
      <description>Automated SC Remastered Bot API Helper.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access/>
  </command>
  <command name="connect" enabled="1">
    <aliases/>
    <documentation>
      <description>Makes the bot attempt to connect to Battle.net</description>
      <specialnotes/>
    </documentation>
    <access/>
  </command>
  <command name="reconnect" enabled="1">
    <aliases>
      <alias>rc</alias>
    </aliases>
    <documentation>
      <description>Forces the bot to attempt to reconnect to the selected Battle.net server.</description>
      <specialnotes/>
    </documentation>
    <access/>
  </command>
  <command name="disconnect" enabled="1">
    <aliases/>
    <documentation>
      <description>Disconnects the bot from Battle.net.</description>
      <specialnotes/>
    </documentation>
    <access/>
  </command>
  <command name="rejoin" enabled="1">
    <aliases>
      <alias>rj</alias>
    </aliases>
    <documentation>
      <description>Makes the bot rejoin the current channel.</description>
      <specialnotes>This will cause the bot to gracefully join another channel and return. Uses the bot's chat queue, may be slow.</specialnotes>
    </documentation>
    <access/>
  </command>
  <command name="resign" token="operator" enabled="1">
    <aliases/>
    <documentation>
      <description>Forces the bot to resign from its status as a channel moderator.</description>
      <specialnotes/>
    </documentation>
    <access/>
  </command>
  <command name="des" token="operator" enabled="1">
    <aliases>
      <alias>designate</alias>
      <alias>designated</alias>
    </aliases>
    <documentation>
      <description>Designates a user to become an operator when the bot leaves the channel.</description>
      <specialnotes>The bot must have operator status in the channel.</specialnotes>
    </documentation>
    <arguments>
      <argument name="username" optional="1" type="word">
        <documentation>
          <description>The username to designate.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="kick" enabled="1">
    <aliases/>
    <documentation>
      <description>Temporarily removes a user from the channel.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>The user to remove from the channel.</description>
          <specialnotes>The username may include wildcards.</specialnotes>
        </documentation>
        <restrictions>
          <shared-error/>
          <restriction name="SAFELIST_BYPASS" nonfatal="0">
            <documentation>
              <description/>
              <specialnotes/>
            </documentation>
            <match message="(,|&quot;)" case-sensitive="0"/>
            <error>You may not use " or , to override the safelist.</error>
            <access>
              <rank>1</rank>
            </access>
          </restriction>
        </restrictions>
      </argument>
      <argument name="Message" optional="1">
        <documentation>
          <description>The reason why this user was removed from the channel.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="ban" enabled="1">
    <aliases/>
    <documentation>
      <description>Removes a user from the channel for the duration of the bot's role as a channel moderator.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>The name of the user to be banned.</description>
          <specialnotes>The username may include wildcards.</specialnotes>
        </documentation>
        <restrictions>
          <shared-error/>
          <restriction name="SAFELIST_BYPASS" nonfatal="0">
            <documentation>
              <description/>
              <specialnotes/>
            </documentation>
            <match message="(,|&quot;)" case-sensitive="0"/>
            <error>You may not use " or , to override the safelist.</error>
            <access>
              <rank>1</rank>
            </access>
          </restriction>
        </restrictions>
      </argument>
      <argument name="message" optional="1">
        <documentation>
          <description>The reason why this user was removed from the channel.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="unban" token="operator" enabled="1">
    <aliases/>
    <documentation>
      <description>Unbans a user from the channel.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="username" optional="1" type="word">
        <documentation>
          <description>The name of the user to be unbanned.</description>
          <specialnotes>The username may include wildcards. If no user is specified, the most recently banned user will be assumed.</specialnotes>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="banned" enabled="1">
    <aliases/>
    <documentation>
      <description>States all users that the bot has banned during the duration of its role as channel moderator.</description>
      <specialnotes/>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="bancount">
    <aliases/>
    <documentation>
      <description>
        States the current number of users that have been banned from the channel.
      </description>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="clearbanlist">
    <aliases>
      <alias>cbl</alias>
    </aliases>
    <documentation>
      <description>
        Clears the internal banlist. Used for ban evasion and unbanning wildcards.
      </description>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="quit" enabled="1">
    <aliases/>
    <documentation>
      <description>Terminates the bot's execution.</description>
      <specialnotes/>
    </documentation>
    <access/>
  </command>
  <command name="enable">
    <aliases/>
    <documentation>
      <description>
        Enables the specified script.
      </description>
    </documentation>
    <arguments>
      <argument name="script" type="string">
        <documentation>
          <description>
            The name of the script you want to enable.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="disable">
    <aliases/>
    <documentation>
      <description>
        Disables the specified script.
      </description>
    </documentation>
    <arguments>
      <argument name="script" type="string">
        <documentation>
          <description>
            The name of the script you want to disable.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="clear" enabled="1">
    <aliases>
      <alias>cls</alias>
    </aliases>
    <documentation>
      <description>Clears all of the text in the bot's chat window.</description>
      <specialnotes/>
    </documentation>
    <access/>
  </command>
  <command name="vote">
    <aliases/>
    <documentation>
      <description>
        Initiates a tally of "yes" and "no" responses.
      </description>
    </documentation>
    <arguments>
      <argument name="duration" type="numeric">
        <documentation>
          <description>
            The duration of the voting session, in seconds.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="cancel">
    <aliases/>
    <documentation>
      <description>
        Stops all votes that are currently in progress.
      </description>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="tally">
    <aliases/>
    <documentation>
      <description>
        States the results for the most recent or currently active vote.
      </description>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="addquote">
    <aliases/>
    <documentation>
      <description>
        Adds a quote to the quote database.
      </description>
    </documentation>
    <arguments>
      <argument name="quote" type="string">
        <documentation>
          <description>
            The quote to add.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="quote">
    <aliases/>
    <documentation>
      <description>
        Returns a random quote from the quote database.
      </description>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="setname" enabled="1">
    <aliases/>
    <documentation>
      <description>Sets a new username for the bot to use.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>The username to use next time you login.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="setpass" enabled="1">
    <aliases/>
    <documentation>
      <description>Sets a new password for the bot to use.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="password">
        <documentation>
          <description>The password to use next time you login.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="setserver" enabled="1">
    <aliases/>
    <documentation>
      <description>Sets a new Battle.net server for the bot to connect to.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="server" type="word">
        <documentation>
          <description>The server to use next time you login.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="inbox" enabled="1">
    <aliases>
      <alias>getmail</alias>
      <alias>readmail</alias>
      <alias>mailread</alias>
    </aliases>
    <documentation>
      <description>Retrieves stored mail for the requesting user.</description>
      <specialnotes>The 'inbox' version can be used with the bot's trigger or, '!'. EXA: !inbox</specialnotes>
    </documentation>
    <access>
      <rank>0</rank>
    </access>
  </command>
  <command name="bmail" enabled="1">
    <aliases>
      <alias>mail</alias>
    </aliases>
    <documentation>
      <description>Stores a message for the specified user.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="recipient" type="word">
        <documentation>
          <description>The recipient of the message.</description>
          <specialnotes/>
        </documentation>
      </argument>
      <argument name="message">
        <documentation>
          <description>The message to be sent.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="checkmail" enabled="1">
    <aliases/>
    <documentation>
      <description>Returns the number of pending messages the user has.</description>
      <specialnotes/>
    </documentation>
    <access>
      <rank>0</rank>
    </access>
  </command>
  <command name="roll" enabled="1">
    <aliases/>
    <documentation>
      <description>Returns a random number between 0 and the specified value. (Defaults to 100)</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="value" optional="1" type="numeric">
        <documentation>
          <description>The maximum value to roll.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="dice" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Rolls the dice x times.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="number_of_dice" type="number">
        <documentation>
          <description>Number of dice to roll.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="flip" enabled="1">
    <aliases/>
    <documentation>
      <description>Initiates a coin toss and states the results.</description>
      <specialnotes/>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="owner">
    <aliases>
      <alias>master</alias>
    </aliases>
    <documentation>
      <description>
        States the owner of the bot.
      </description>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="whois" owner="Clan Moderation" enabled="1">
    <aliases>
      <alias>find</alias>
    </aliases>
    <documentation>
      <description>Returns the specified user's rank and bot access.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>The username you would like to search.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="whoami" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Returns the requesting user's rank and bot access.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="safeadd" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Adds a safelist entry for a specifed user.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>The username you would like to safeadd.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="safedel" owner="Clan Moderation">
    <aliases/>
    <documentation>
      <description>Removes a safelist entry for a specifed user.</description>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>The username you would like to safedel.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="add" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Add a clan member by rank.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>The username you would like to add.</description>
          <specialnotes/>
        </documentation>
      </argument>
      <argument name="rank" type="word">
        <documentation>
          <description>The rank to give to the user.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="rem" owner="Clan Moderation" enabled="1">
    <aliases>
      <alias>del</alias>
      <alias>remove</alias>
      <alias>delete</alias>
    </aliases>
    <documentation>
      <description>Remove users and clan members.</description>
      <specialnotes/>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>The username you would like to remove.</description>
          <specialnotes/>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="members" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>List all clan members by rank.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="info" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Lists the number of clan members and clan info.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="ranks" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>List all clan ranks.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="promote" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Promote a clan member by one rank.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="demote" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Demote a clan member by one rank.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="open" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Open a clan rank recruting position.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="close" owner="Clan Moderation" enabled="1">
    <aliases/>
    <documentation>
      <description>Close a clan rank recruting position.</description>
      <specialnotes/>
    </documentation>
    <arguments/>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="greet">
    <aliases/>
    <documentation>
      <description>
        Enables, disables, or changes the settings of a welcome message.
      </description>
    </documentation>
    <arguments>
      <argument name="subcommand" type="word" optional="1">
        <documentation>
          <description>
            The subcommand to use, must be: 'on', 'off', 'whisper', 'status', or 'set'
          </description>
        </documentation>
      </argument>
      <argument name="value" type="string" optional="1">
        <documentation>
          <description>
            The whisper subcommand to use: 'on' or 'off'
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank></rank>
    </access>
  </command>
  <command name="idle">
    <aliases/>
    <documentation>
      <description>
        Enables or disables the use of idle messages.
      </description>
    </documentation>
    <arguments>
      <argument name="Enable" type="word" optional="1">
        <documentation>
          <description>
            'on', 'off', or 'toggle' to enable or disable the idle.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank></rank>
    </access>
  </command>
  <command name="setidle">
    <aliases/>
    <documentation>
      <description>
        Sets a message to be sent to the channel at regular intervals.
      </description>
    </documentation>
    <arguments>
      <argument name="message" type="string">
        <documentation>
          <description>
            The message to be used.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank></rank>
    </access>
  </command>
  <command name="idletime">
    <aliases>
      <alias>idlewait</alias>
    </aliases>
    <documentation>
      <description>
        Sets the time between idle messages, in minutes.
      </description>
    </documentation>
    <arguments>
      <argument name="delay" type="numeric">
        <documentation>
          <description>
            The number of minuets between each idle message.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank></rank>
    </access>
  </command>
  <command name="lastseen">
    <aliases>
      <alias>allseen</alias>
    </aliases>
    <documentation>
      <description>
        States the last fifteen users that the bot has seen.
      </description>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="lastwhisper">
    <aliases>
      <alias>lw</alias>
    </aliases>
    <documentation>
      <description>
        States the name of the user whom last privately messaged the bot.
      </description>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="locktext">
    <aliases>
      <alias>lockchat</alias>
    </aliases>
    <documentation>
      <description>
        Disables the display of incoming chat messages.
      </description>
    </documentation>
    <access>
      <rank></rank>
    </access>
  </command>
  <command name="safecheck">
    <aliases/>
    <documentation>
      <description>
        States the safelist status of a specified user or tag.
      </description>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>
            The username or group to check.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="scripts">
    <aliases/>
    <documentation>
      <description>
        Lists the bot's currently loaded scripts.
      </description>
      <specialnotes>
        Names encased in parenthesis means the script is disabled.
      </specialnotes>
    </documentation>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="say">
    <aliases/>
    <documentation>
      <description>
        Echoes the specified phrase
      </description>
    </documentation>
    <arguments>
      <argument name="message" type="string">
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="shout">
    <aliases/>
    <documentation>
      <description>
        Echoes the specified phrase using all capital letters.
      </description>
    </documentation>
    <arguments>
      <argument name="message" type="string">
        <documentation>
          <description>
            SHOUT A MESSAGE.
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
  <command name="watch">
    <aliases/>
    <documentation>
      <description>
        Makes the specified user's name appear red inbot.
      </description>
      <specialnotes>
        The username specified may include wildcards.
      </specialnotes>
    </documentation>
    <arguments>
      <argument name="username" type="word">
        <documentation>
          <description>
            The name of the person you wish to watch.
          </description>
          <specialnotes>
            May contain wildcards
          </specialnotes>
        </documentation>
      </argument>
    </arguments>
    <access/>
  </command>
  <command name="watchoff">
    <aliases/>
    <documentation>
      <description>
        Stops watching for a user (they will no longer shop up as red).
      </description>
    </documentation>
    <access/>
  </command>
  <command name="whispercmds">
    <aliases>
      <alias>wc</alias>
    </aliases>
    <documentation>
      <description>
        Toggles or displays the use of private messaging as a means for delivering command responses.
      </description>
    </documentation>
    <arguments>
      <argument name="subcommand" type="word" optional="1">
        <documentation>
          <description>
            The subcommand to use: 'status', 'on', or 'off'
          </description>
        </documentation>
      </argument>
    </arguments>
    <access>
      <rank></rank>
    </access>
  </command>
  <command name="expand">
    <aliases>
      <alias>url</alias>
    </aliases>
    <arguments>
      <argument name="message" type="string">
    <documentation>
      <description>
        Echoes the specified phrase, placing a space after each character.
      </description>
    </documentation>
      </argument>
    </arguments>
    <access>
      <rank>1</rank>
    </access>
  </command>
</commands>