*************************
 BitTorrent IRC Bot v2.2.2
*************************

This plugin for Azureus works as an IRC bot. You can remote control your Azureus from IRC. It can also send advertisement to channel and torrents that your Azureus currently seeding/downloading to other IRC users.

*************************
  What's New?
*************************

Version 2.2.2

Fixed up to only use plugin interfaces, not Azureus-private ones

Version 2.2.1
Not compiled against the right Azureus version (CVS one)

Version 2.2

Support Azureus 2.1.0.x
Support multi-channel
Irc servcer config update on the fly.
Send torrent with its name.
Some bug fixed.

*************************
  Installation & Usage
*************************


1. Pre-install requirement

You need following software to run this plugin.
1) Azureus version 2.1.0.0 or greater.
2) A full functional IRC client. Such as mIRC.
3) Some irc server you can connect and channel you can join.

Notice: #azureus-users@irc.freenode.net is not the right place to put your bot in.


2. Installation

Extract the zip file and make sure bdcc.jar is in the right place:

- Unix -> ~/Azureus/plugins/bdcc/
- Windows -> .../Documents and Settings/<username>/Application Data/Azureus/plugins/bdcc/
- OSX -> /Users/<username>/Library/Azureus/bdcc/


3. Configurations

After you successfully install the plugin, restart your Azureus and open Configuration view. You can see there's two more plugin configuration named "BitTorrent IRC Bot - IRC Settings" and "BitTorrent IRC Bot - Bot Settings". Configuration described as below:

1) BitTorrent IRC Bot - IRC Settings

This sector configure all of your bot's basic irc settings. Include Server and channel you want to connect/join.

2) BitTorrent IRC Bot - Bot Settings

This sector configure your bot behavior. If you enable remote admin, you can request a "DCC chat" with your bot and control it. For security reason, you can specify the hosts that allowed to perform the action, like "nick!login@host". Default value "*!*@*" is NOT recommended.

If you enable advertisement, when user type "!list" or "!bt" in the channel, your bot will send a notice to the user which contains a brief introduction of your bot.

You can also enable "Send torrent files to all user" to let other people in the channel to get the torrents you have. There's two more parameter about DCC send is port range. The port range is used to make sure your bot can work well with firewall. 0 means all port can be used to make a DCC send.

When "Send Torrent Event to Channel" is enabled, every time you add or remove a torrent, there will be a notice to the channel about it.


4. Control Panel

There's a control panel view which will show some information about your bot. You can open it from menu View->Plugins->BDCC Control Panel.

5. IRC Commands for admin

After you login to a admin DCC chat session, you can use the commands:

-- Info Commands --
  HELP             - Shows Help
  XDL              - Lists All torrents
  DCL              - Lists Current Downloading torrents
  SCL              - Lists Current Seeding torrents
  QUL              - Lists Current Queue
  INFO n           - Show Detail Information About Torrent n
  TRON n           - Start Tracing Information About Torrent n. If you leave the DCC chat there, bot will report every changes of the torrent. Include every announce result.
  TROFF n          - Stop Tracing Information About Torrent n
-- Torrents Commands --
  ADD <filename>   - Add New Torrent With <filename> and put it into quere.
  ADDURL <url>     - Add New Torrent from <url> and put it into quere.
  QUEUE n          - Queue torrent n
  START n          - Force Start torrent n
  STOP n           - Stop torrent n
  REMOVE n         - Remove torrent n
  SEND nick n      - Sends torrent n to nick
  HOST n           - Host torrent n to embedded tracker
-- Share Commands --
  SADD <filename>  - Share a file
  SADDDIR <dir>    - Share a directory
  SADDCON <dir>    - Share directory contents
  SADDCONR <dir>   - Share directory contents with recursive
  SLIST            - List all shares
  SREMOVE <name>   - Remove a share
-- Bot Commands --
  SAY <message>    - Say a message to channel
  QUIT             - Close DCC Chat
  SHUTDOWN [message] - Quit IRC with a quit message.

Some commands also works like "/msg <nick> admin <password> <command>". You can also use "chatme" command to let the bot perform a DCC chat to you. This will be useful when you are behind a firewall and can't launch the DCC chat session with your bot.
etc: /msg bdccbot admin mypassword chatme

6. IRC Commands for other user.

There's only 3 simple command for the user:

1) /msg <nick> BT LIST
User can use it to request a list of torrents you have.

2) /msg <nick> BT INFO #N
User can use it to request detail information about torrent N.

3) /msg <nick> BT GET #N
User can use it to request the torrent N from the bot.

7. Bugs & Advices

You can contract me at leonzhao{AT}163.com.
My reply is not that fast because I'm very busy this year. Sorry.
