
Info:
-----
  zDSBot3 has been semi-discontinued for another project known
  as prolix. See http://prolix.sourceforge.net/ for information.

  zDSBot3 was originally written in linux. There are ports for
  windows, and freebsd as well (and bsdi now). As a general
  rule, the unix variants are generally more up-to-date, so if
  you want the latest and greatest you won't get it in windows.
  sorry >;-)

Notes:
------
  Tagbans are *NOT* saved. You will need to manually edit the
  tagbans.txt file.

Special Thanks:
---------------
  Thanks to OwNsY4 for SCJap packet logs, and ]23'|'$@]V[ for
  more updated hashes.
  Thanks to NmAcM for SC/BW packet logs and the data for the hashes.
  Thanks to [UPL]Patton for a cdkey to test with.
  Hinde - cuz he's cool. >;-)
  Ross Combs for the bnetd project. >;-)

Special Commands:
-----------------
  See the COMMANDS file for info on the general commands.

  cmd
  ---
    Example:
      .cmd add welcome /me welcomes %1 to the channel.
    Usage:
      .welcome bob

    Example:
      .cmd add getlost /join the void
    Usage:
      .getlost

    Example:
      .cmd add serve /me pulls fills up a nice full %2 for %1. Have at!
    Usage:
      .serve bob beer

  settrigger
  ----------
    Examples: .settrigger .
              .settrigger !
              .settrigger thiswouldsucktotype

    Cation:   If you change your trigger, you
              will need to use the new trigger to
              change it back. >;-)

  mode
  ----
    Examples: .mode lockdown
              .mode normal

Config File Options:
--------------------
  vars {
    set reconnect_delay      3
      # Amount of time to delay between trying to reconnect
      # to bnet. Set this to 0 if you want, but you
      # are bound to get ip banned.
    set rejoin_pause         2
      # Everyone kept wanting me to tweak this. Fine - you
      # can tweak it! :)  This is 3+what you have it set to.
      # To have 0 seconds, do set rejoin_pause -3. This will
      # Most likely get you banned. 3+2 (default 5 seconds)
      # should be fine.
    set kick_on_yell         0
      # Set to 1 to /kick people when they YELL IN THE CHANNEL.
    set show_joins           1
      # Set to 0 to not should people leaving or joining the channel.
    set show_idles           0
      # Set to 1 to NOT filter some of the more irritating idles.
      # Some of the early NULLbots and other had REALLY irritating
      # idles. This filtered them off so you could actually
      # see the channel. >;-)
    set show_bots            0
      # For commandline only. If you have multple bots, setting this
      # to 1 will allow you to see which of the bots saw what.
    set debug_verbose        0
      # I have no idea, I dun think it's used anymore.
    set debug_idle           0
      # For debugging, you can set it to 1 if you are bored.
    set cmd_profile          0
      # Was used back when zDS had profile support. I've been
      # lazy and have not put it back in.
    set bot_trigger          .
      # Just like .settrigger
    set bot_master           Eurijk!
      # You will want to set this to whatever user you want to have
    set beep_onpriv          0
      # Sends an audible beep when some1 sends you a private message.
    set beep_onjoin          0
      # Beeps when some1 joins the channel.
    set auto_welcome         0
      # Set to 1 to have the bot private message some1 "welcome to the
      # channel type !help for help." Or something like that. To change the
      # welcome message you will have-to hexedit the bot at the moment.
    set war2_exe Binaries/war2/Warcraft II BNE.exe
    set war2_snp Binaries/war2/battle.snp
    set war2_dll Binaries/war2/storm.dll
    set star_exe Binaries/star/starcraft.exe
    set star_snp Binaries/star/battle.snp
    set star_dll Binaries/star/storm.dll
    set d2dv_exe Binaries/d2xp/Game.exe
    set d2dv_d2c Binaries/d2xp/d2client.dll
    set d2dv_bnc Binaries/d2xp/bnclient.dll
    set d2xp_exe Binaries/d2xp/Game.exe
    set d2xp_d2c Binaries/d2xp/D2Client.dll
    set d2xp_bnc Binaries/d2xp/Bnclient.dll
      # Set these to whereever you have the files.
      # If you don't have WAR2 and are just using SC2 then you
      # can set the client you are not using to a zero length file.
  }

  bot [botname] {
    # You can have a lot of different bots. Just add more
    # bot sections. You will need to define a server, password, and
    # all that for each bot.

    passwd [password]
    cdkey  [cdkey]
    spawn  yes
      # You can set this for yes or no. In order to load 8 bots on
      # a single cdkey on a single ip you will need 1 set to no, and
      # 7 bots set to yes.
    server useast.battle.net
      # If you set this to the IP rather then the name it will not have-to
      # look up the DNS each time it connects and will work a bit faster.
    
    client [type]
      # war2, star, and jstr are supported.

    bind [ip]
      # Used if you have several IP's on the box you are running.
    commandset [group]
      # Use the default one unless you are rather advanced. You can have
      # multiple commandsets allowing different bots to run multiple
      # different commands, and have different mass messaging queue's.
      # This is a fairly advanced concept. Generally I recommend not
      # playing with this. >;-)
      
    lag_spoof 0
      # Set to 1 to try and get no lag bars (0 to 9ms). This may take
      # a lot of tries on a bad(as in modem/isdn/slow dsl) connection.
      # If your connection is consistant - ie: things take the same
      # amount of time each time, then it should be fairly easy to get
      # no lag.
      
    display 1
      # In theory 0 turns off the display, 1 is for text, and 2 is for gui.
      # I doubt this is the case. You can set it to 1 in general. Feel
      # free to try 0 to speed things up. Dunno if it works all that
      # well though. <shrugs>
      
    register Bob
      # Who the CD-Key is "registered" too. You can set this to about
      # anyting.
    
    homechannel clan [ds]
      # Set this to wherever.
      
    bind 10.0.0.1
      # This is most likely broken. This allowed(since I haven't put it back
      # in the source recently) you to run multiple bots on different ip's from
      # the same box.

    quotes quotes.txt
      # Each bot can have it's own quotes. This actually should-have been
      # linked to commandset. Oops - oh well. >;-)

    quote_delay 60
      # Number of seconds to wait before displaying the next quote.
      # 0 is off.
  }
  
  command default {
    # You can have many different command sets. This is an advanced
    # topic and I recommend just one for most people.
    
    tagbans [filename]
      # Example: tagbans tagbans.txt

    showfile [command] [filename]
      # Example: showfile help help.txt
      #          showfile about about.txt
      # etc...
      
    showfilepublic [command] [filename]
      # Like above, but instead of whispering the file, it displays it
      # publicly.

    cmd smile /me smiles at %0
      # This is my semi-lame way of allowing you to save dynamic commands.
      # At some point I'll actually make them save. >;-)
    key crappy /me kicks %0 for saying crappy
  }
