 ___________________________________
|
| Spam detection sBot (socket-bot)
|___________________________________
|
| Author: RagingDemon
| E-mail: gren_gr@yahoo.com
| Copyright: 2004 @ May, 27
|___________________________________



 ___________________________________
|
| sBot' s purpose
|___________________________________

  This bot is used to detect private spam messages. If it detects a spam message it will automatically punish the user through you. This means that it' s a good idea (if not necessary) to be an operator in the channel so you can kick/ban the spammer. It also supports a rejoin time. This means that every X seconds you define, the bot will part and rejoin the channels so that it detects on-join spam messages.


 ___________________________________
|
| How to load this addon
|___________________________________

  To load this addon open your mIRC and type:

      //load -rs $+(",<dir>\sBot.mrc,")

  For example if you have extracted sBot.zip file in
c:\my_documents, open your mIRC and type:

      //load -rs $+(",c:\my_documents\sBot.mrc,")

 ___________________________________
|
| Opening dialog - Configuring sBot
|___________________________________

  To open sBot' s main dialog type /sbot in any command prompt or select "Open" from the "Spam detection sBot" menu that pops up when right-clicking in your Status window or a channel' s window.
  When dialog opens you see some fields in which you need to enter certain information.

   * Nickname: sBot' s primary nickname
   * Alternative: sBot' s alternative nickname (if primary nickname is already in use)

   * Full name: sBot' s full name
   * User identd: sBot' s user identity

   * Server: server to connect
   * Port: port of server (normaly 6667,6668,6669 or 7000)

   * Part msg: message to use while parting channels for spam check
   * Rejoin every: time in which sBot will part and then join a channel in order to catch on
                   join-spam messages
   * Channels: channels in which sBot will automatically join once connected connect

 ___________________________________
|
| The "Options" menu
|___________________________________

  In the main dialog you can see the "Options" menu which contains useful options that make sBot more customizable. This menu contains the following options:

   * Don' t punish spammer if: when sBot detects a spam message don' t kick/ban spammer if he is
                               an operator, half-operator, voiced user in a channel or a user in
                               your notify list
   * Kick spammer: Select from which channels to kick the spammer
   * Protect sBot from bans: when someone places a ban that matches sBot' s address you will
                             automatically unplace the ban and inform the user not to place a ban
                             again
   * Rejoin channels on kick: when sBot gets kicked it' ll try to rejoin the channel
   * Warn ops on spams if I' m deoped: when sBot detects a spam message you' ll try to punich the
                                       spammer, but if you don' t have op status in the channel
                                       you' ll send a notice to channel' s ops in order to warn
                                       them of the possible spam detected
   * Inform ops that sBot joined channel: when sBot joins a channel it is possible that some
                                          users see it as a clone of you. Having this option
                                          enabled you' ll warn other ops in the channel that it
                                          is a spam detection bot in order to avoid having it
                                          kicked
   * Auto-op me when I join a channel if sBot is already oped: When you join a channel if sBot is
                                                               already oped in it, it will op you
                                                               and deop itself
   * Auto-connect when I connect: sBot will automatically connect once you connect to a server
   * Silence users that send messages to sBot for 10 secs: sBot uses the /silence command
                                                           whenever a user messages it in order
                                                           to avoid getting flooded. /silence is
                                                           removed after 10 seconds
   * Log private conversation: logs all sBot' s private messages into a file

   * Debug window: opens a window showing all incoming/outcoming messages
   * Auto-identification procedure: opens a dialog in order to enter information to
                                    automatically identify sBot' s nickaname

   * View sBot' s commands: shows the commands that can be used in a private query with sBot
   * View sBot' s log file: opens the private conversation log file

 ___________________________________
|
| Auto-identification procedure
|___________________________________

  From the main dialog' s "Options" menu select "Auto-identification procedure". A new dialog will open. You can see three fields in it.

   * Service: Here you must specify the name of the nickname-handle service (in most networks is
              just NickServ or something like nickserv!services@irc.gr)
   * Password: sBot' s nickname password
   * Command: the command to send to network services in order to identify your nick. Don' t
              use a the / prefix

 ___________________________________
|
| Note
|___________________________________

   You can also have sBot join a channel by inviting it to it. To do this use the invite command (/invite <sBot' s nick> #channel), for example /invite sBot #no_spammers