
XMMS SingIt Lyrics Displayer
============================

1. Introduction
  1. Features
2. Quick install instructions
3. Configuration
4. Lyrics editor
  1. Timestamp mode
  2. Text mode
5. Lyrics structure
6. Key bindings
  1. Quick key access to songs in the playlist
7. Known "bugs"
8. Development (or Translations)
9. License
10. Credits


1. Introduction
---------------

This "X Multi Media System" (XMMS) plugin displays formated lyrics.
If you don't know XMMS visit the homepage (see 9. Credits).

It was mainly inspired by a WinAmp lyric plugin called
"Kuo's Lyrics Visualization Plugin" by Kuo Shiang-Shiang.

The plugin has some remote functions, so you don't need
to switch to XMMS for basic manipulations.
Just install...

Hints, bugfixes, ideas, comments, constructive criticism, code,
translations ... (everything you can add to this list) welcome

Write to:

  Jan-Marek Glogowski <glogow@stud.fbi.fh-darmstadt.de>


1.1. Features
-------------

See NEWS


2. Quick install instructions
-----------------------------

1.) ./configure
2.) make
3.) strip xmms-singit/.libs/libxmms_singit.so (removes debugging code)
4.) su -c "make install"
    or become root and "make install"

Hint:
- - -

If there doesn't exist the "./configure" script run

	make -f Makefile.create

If you want to view console debug output: ./configure --with-debug
To pipe the output into a file:      xmms > cout.log
If you want to include error mesages:  xmms >& cout.log


3. Configuration
----------------

The lyric filename is constructed from:

	Lyric dir + song filename without the (last) extension + lyric extension

Defaults:
	Lyric dir        :   "~/lyrics/"
	Lyric extension  :   "txt"
	Lyric font       :   "-adobe-helvetica-bold-r-*-*-14-*"

Example:
	Song file        :   "PUR_-_Lena.mp3"
	Lyric dir        :   "~/lyrics/"
	Lyric extension  :   "txt"
	Home             :   "/home/mp3"

	Result           :   "/home/mp3/lyrics/PUR_-_Lena.txt"


4. Lyrics editor
----------------

First look at the tooltips of the button.

The toolbar contains the following buttons:
  * New file -> clear lyrics
  * Open file -> open a lyrics file
  * Catch lyrics from current song
  * Save file
  * Save file with other filename

  * Editor mode : timestamps
  * Editor mode : text

  * Strip HTML : Removes HTML-Tags (everything between <>) from the file
                 (If you get lyrics from the internet as HTML files)
  * Strip timetags (if you want to print them ;-)

  * Temporally enable / disable tooltips
                 If you want to permanently change the state use
		 config -> lyric cretor -> show tooltips

  * Show about window

  * Close editor


4.1. Timestamp mode
-------------------

Left-Click          : The program prepends the current time to the line
                      Moves the next line to the middle of the box if possible
Shift + Left-Click  : As Left-Click
                      Doesn't alter the line pos

Ctrl + Left-Click   : The program removes the first item (if existing)
                      Doesn't alter the line pos


4.2. Text mode
-------------------

In this mode you can edit the text. This removes the  annoying "misfeature"
of Kyo's WinAmp plugin. It wasn't very handy to edit the textfile.
(You had to select the line and edit it - also it was a little bit tricky to
insert or remove a line - best way was to use an extra editor)


5. Lyrics structure
-------------------

[Timestamp] Lyrictext

Example:

[00:00]Lalila
[00:08][00:17]Lilola ;-)

I put a lyric example into the lyrics directory.


6. Key bindings
---------------

You can also see the key bindings at the about window

[zy]		Previous song
 x		Play
 c		Pause
 v		Stop
 b		Next song

CTRL + c	Show the configuration window
CTRL + e	Show the lyrics editor
CTRL + a	Show the about window (incl. key bindings)
CTRL + 3	Show the id3 tag window

[Key pad]
 +	Volume up
 -	Volume down


6.1. Quick key access to songs in the playlist
----------------------------------------------

Enable NumLock on your keyboard.
Type the number of the playlist entry and hit "enter".
The "decimal" (,.) clears the internal buffer.
No numbers > playlist length are accepted.

Example:

Playlist entries  : 320
  Input           : 123456789
  "Output"        : 123 45 67 89
  Current Buffer  : 89


7. Known "bugs"
---------------

There are no known bugs, but the delivered filename from XMMS seems
to be "wrong" (look at the status bar : '//'). Since I use this filename,
(without modifing it) and everything works fine it's no real bug.
When I first saw it I found it a little bit strange ?:-.


8. Development
--------------

Ok - you want to develop something for the plugin, or want to contribute
a "missing" feature. First read the TODO of the latest development release.
If the feature doesn't appear in the list, please send me a small mail
explaining the feature. I will add it to the TODO list, so that nobody
else will start the same. That's it...
If you want to update a translation use msgmerge (see "info msgmerge").
Expl: msgmerge de.po xmms-singit.pot > de.new
If your language doesn't exist copy "po/xmms-singit.pot".


9. License
----------

See COPYING.
If this file doesn't exist (should not be possible, but who knows)
get a copy of the "GNU Public License v2" (GPL)


10. Credits
-----------

XMMS   -    htto://www.xmms.org
SciTE  -    http://www.scintella.org
WinAmp -    http://www.winamp.com

Kuo's Lyrics Visualization Plugin
       -    http://come.to/djohan
SingIT for Windows
       -    have to check for the page


Jan-Marek Glogowski <glogow@stud.fbi.fh-darmstadt.de>

Last modified: 2002-06-17