XCHAT-XMMS (C) Craig Kelley <ink@inconnu.isu.edu>  -- November 2002

DESCRIPTION:

  This program is a script plugin for XChat (http://www.xchat.org)
  that will allow one to control XMMS from within XChat and to have it
  send out messages to XChat, the channel or to another IRC user.

INSTALLATION:

  This program requires the Xmms perl module.  The easiest way to
  install this module is via CPAN by using the following command
  (usually as the root user):

     perl -MCPAN -e 'install Bundle::Xmms'

  If it is the first time that CPAN has run, it will ask you a bunch
  of questions about how it should be setup before it runs.  You will
  also need to have the XMMS development libraries installed (eg,
  under Redhat, you'll need to have the xmms-devel package installed).

  You can test that the Xmms perl module is installed by doing this:

    perl -MXmms -e "exit (0)"

  OPTIONAL ADDITIONS:

  If you want better-looking song information, xchat-xmms can read OGG
  and MP3 meta tag information with the proper tools.  To read MP3
  tags, you need to install the MP3::Info perl module, which can be
  installed via CPAN like this:

    perl -MCPAN -e 'install MP3::Info'

  And to read .ogg (ogg/vorbis) files, you will just need the
  vorbis-tools available from http://www.xiph.org/ogg/vorbis/
  Make sure the program 'vorbiscomment' is in your path, or edit
  xchat-xmms.pl so that $VORBIS_PATH is set correctly.

  Another optional module is the Time::HiRes module, which will make
  XChat-XMMS more responsive while it works.

TO USE:

  In XChat use the menus:

    Scripts & Plugins -> Load -> Perl Script

  A file dialog box will pop up; navigate to where xchat_xmms.pl is
  located (you can place this file anywhere you like; personally, I
  like to put it in my home directory in a plugin folder I have for
  XChat) After loading, you should see this in the XChat window:

   :: Loading X-Chat XMMS Script VERSION

  After that, you can get online help by issuing this XChat command:

   /xmms help

     and

   /xmms help examples

TO DO (BUGS):

  Please send any patches you have to me.

  I need people who speak other languages to help internationalize
  this program (I speak spanish, but haven't done that quite yet)

LICENSE:

  This is licensed under the Artistic license, just as Perl is.  Please see the
  file called "Artistic" that you should have recieved with this program.
