deejayd
===========

Actual version : 0.10.0
----------------------

Description:
------------
deejayd is an media player written in python and based on twisted.
So, it is a network daemon which can be controlled with a client application
like MPD. The protocol used to control deejayd is an XML protocol.
Documentation of this protocol can be found in source archive (doc directory)

Clients:
--------
  * djc :
    -----
      djc is a command line client available in this package
  * djmote :
    --------
      djmote is a graphical deejayd client optimized for use on Maemo devices
      such as the Nokia N770 or Nokia N800.
      For now, it does not work with deejayd >= 0.8.0
  * deejayd-webui :
    --------
      It is a web based client written in XUL. It is replace ajaxdj and
      it is included in deejayd. It can be configured in webui section of
      deejayd configuration file. The first time you try to use this ui,
      you need to download and install a firefox extension. This is needed
      to allow extended feature (like drag and drop) without change
      firefox configuration.
      url to use this interface : http://host:webuiport/
  * mobile-webui :
    --------
      It is a web based client optimized for mobile device
      url to use this interface : http://host:webuiport/m/

Requirements:
-------------
    * python >= 2.4
    * twisted >= 2.0 (http://twistedmatrix.com/trac)
    * simplejson (http://code.google.com/p/simplejson/),
      it is include in python >= 2.6.0
    * pysqlite >= 2.2 (http://www.initd.org/tracker/pysqlite/wiki/pysqlite)
       for sqlite database support
    * mysql-python >= 1.2.1 (http://sourceforge.net/projects/mysql-python)
       for mysql database support
    * mutagen >= 1.6
        (http://www.sacredchao.net/quodlibet/wiki/Development/Mutagen)
    * kaa-metadata >= 0.7.3 (http://doc.freevo.org/2.0/Kaa)
    * lxml >= 2.0 (http://codespeak.net/lxml/)
    * twisted-web >= 0.6.0 if you want to use deejayd-webui
    * if you want to use gstreamer backend (audio only)
        * pygobject >= 2.12 (http://www.pygtk.org/)
        * gstreamer >= 0.10 (http://gstreamer.freedesktop.org)
        * gstreamer plugins :
            * Required :
              * gst-python >= 0.10
            * Optionnal :
              * alsa, oss, esd ...
              * mad to play mp3
              * ogg to play ogg
              * for webradio, gst-plugins-gnomevfs >= 0.10
    * if you want to use xine backend
        * xine-lib >= 1.1.0
        * libX11, libXext
        * ctypes >= 1.0.0 (It is include in python 2.5)
    * pyinotify >= 0.6.0 for inotify support (http://pyinotify.sourceforge.net/)

If you want to build deejayd (distutils distribution), you also need
the gettext package installed because of the usage of the msgfmt binary.

Installation:
-------------
Download deejayd and extract it:
  $tar xzvf deejayd-0.10.0.tar.gz

Then, install it with:
  $cd deejayd-0.10.0
  $python setup.py build
  $python setup.py install

Usage:
------
  To launch deejayd just do
    $deejayd
  See "deejayd --help" for more informations

  To launch djc (command line client), just do
    $djc COMMANDS ARGS
  See "djc --help" to see available commands

Documentation and more informations:
------------------------------------
see http://mroy31.dyndns.org/~roy/projects/deejayd
