root/lang/python/otolog4linux/trunk/README

otolog4linux version 0.04

= Contents =

    * Introduction
    * Supported Music Player
    * Settings
    * Minimum Requirements
    * Installation
    * Plugin Development

=== Introduction ===

Otolog is music logging service. The music information
 which you are playing in iTunes was distributed from otolog server.
This application get the information from the un*x multimedia player,
 and post the information to otolog server.

=== Supported Music Player ===

* rhythmbox
* amarok
* xmms (mp3 only)
* kscd
* beep-media-player (same sa xmms)
* iTunes (win32 only)
* Music Player Daemon (mpc)

=== Minimum Requirements ===

1. Python 2.4
2. PyGTK
3. GTK 2.6

following are optional...
4. eyeD3
5. win32com
6. bonobo
7. pyXMMS

=== Installation ===

# python setup.py install

if you want to use rpm,

# python setup.py bdist_rpm
# rpm -Uvh dist/otolog4linux*.rpm

or, if you want to use installer for windows,

# python setup.py bdist_wininst --install-script otolog4linux_install.py

and copy dist/*.exe to windows.

=== Plugin Development ===

plugins naming rule:
  player_XXX.py : module for getting player information 
  jacket_XXX.py : module for getting jacket information

player plugin module:
  def play()    : ...
  def stop()    : ...
  def prev()    : ...
  def next()    : ...
  def pause()   : ...
  def get_info(settings):
    settings    : user settings dictionary
    this function should return information dictionary

jacket plugin module:
  def get_info(settings, player_info):
    settings : user settings dictionary
    this function should return URL

    and this function can change player_info

- otolog4linux development team