Lyrics Universe v1.22
Copyright (C) Falk Schubert
E-mail: schubert@ipg.geo.tu-dresden.de
NuWorks FreeWareShop - Our FreeWareShop
http://freewareshop.8m.com
E-mail:webmaster@freewareshop.8m.com
----------------------------------------------------------------------------------------------

This Winamp plug-in displays the lyrics (.lrc/.txt file) of a song (.mp3 file) in a winamp-like
window that is skinnable since version 1.2. It can also be used to create a .lrc file from a .htm
file or a plain text file .txt (have a look at section 'HOW TO CREATE A LYRIC FILE' for further
information). In the case there isn't a lyric available for the song a visualisation is performed.
Since version 1.22 user defined settings can be saved/loaded.


REQUIREMENTS
------------

- Windows 95/98/NT
- Winamp 2.05 or higher 


HOW TO INSTALL
--------------

All you have to do is to unzip the lyruni.dll to the Winamp plug-in directory. Then you
must select it in Winamp as the actual visualization plug-in. Before you start the plug-in
you should use CONFIGURE and set the path to the folder with the lyric files. There is no
need to do that if the lyric files are in the same folder like the .mp3 files. But files
must either have the same name as the appropriate .mp3 or similiar files (apart from the file
extension of course) or they must have a name that is composed of the entries in the MP3-tag/
CDDB-info (in the case of CD) in the way 'Artist - Title'. The correct format of the .lrc/.txt
file is essential (have a look at the example.lrc). There MUST NOT be a UNIX end of line (0Ah)
but a Windows end of line (0Dh 0Ah) !
If you use a CD, you should get the information from the CDDB before, so that Winamp shows the
correct title. Otherwise the filenames would be like Track01.lrc, so that there could be a problem
using many CD's. Well, thats all.


HOW TO CUSTOMIZE
----------------

If you click the right mouse button in the plug-in window, a small popup menu will appear.
You can use CONFIGURATION to change common settings (stay on top e.g.) and settings
controlling the appearance of the lyrics and the visualization (just try it out). If there
is no lyric available for the current song, you have the opportunity to open a 'potential'
lyric file using FILE OPEN or FILE NEW (have a look at the next section). You can resize the plug-in window
both in lyric and visualization mode. Just click with the left mouse button on the lower right corner
and drag it to the right position. If you got a fast computer, you can try the full screen mode
(menuitem MODE). If the hole lyric can't be displayed because the window width is too small,
a red corner will appear. If you click on that corner, the window will blow up to the appropriate size.
If you don't want to see any lyrics you can uncheck the checkbox SHOW LYRIC IF AVAILABLE in the common tab,
so the visualization is performed by default.
Important: If the plug-in is active, you can't use CONFIGURE PLUG-IN in the Winamp
           VISUALIZATION MENU. You have to use CONFIGURATION in the plug-in's popup menu !

Some remarks to the visualization: If you resize the window, the size of the spectrum is changed
automatically. It's up to you to change the size of the sun. It's reasonable to change both the SIZE
and the WAVES value in the visualization tab, not only one of them. If you add a lot of waves, you should
increase the COMPLEXITY value, too. But in the end it's at matter of your taste, of course. Very
quiet songs may need an increase of the activity.
If you have a slow machine or if you use a bigger window than the default, you will have to change the
PERFORMANCE to high (common tab).

USER DEFINED SETTINGS
---------------------

It's possible to store own settings using the settings-tab. In the listbox all available sets
are listed. The 'Actual' and 'Default' settings cannot be changed or deleted. If you changed the
configuration and you want to save it, just type a new name in the edit line and press the
STORE-button. The name is added to the list and in the popup menu (under SETTINGS). You can
activate these settings later by either clicking in the appropriate line in the listbox and
pressing OK or just by selecting the settings in the popup menu. Please pay attention to the
following rules:

- the actual size of the window is saved too
- the mode (windowed/fullscreen) is stored
- the lyric path and the state of the checkbox 'Use settings from skin pack' in settings tab
  are NOT saved (they are unique for all sets)

If you check the 'Use settings from skin pack' checkbox the plug-in looks in the actual skin
directory for a file named 'Lyruni.set' with a subset of settings, concerning the colors of
lyric/visualisation and lyric font style. The plug-in will use this settings INSTEAD the ones from
the stored sets ! By pressing the button 'Save actual settings for skin pack' you can create
such a file from the actual configuration.
If you want to delete a set click on it in the listbox and press the DEL-key.

HOW TO CREATE A LYRIC FILE
--------------------------

If you opened a file you are in the edit mode of the plug-in. If you open a HTML-file the plug-in
tries to eliminate HTML-tags and leading spaces or tabulators. When you have the opportunity
to edit the file in a small editor.  In most cases you will have to delete some unnecessary lines.
If you used FILE NEW you can use the clipboard functions to insert a text (Ctrl-V). If you think
you are ready then press OK. Now there will be three small buttons on the right side of the plug-in
window. With the left arrow you can go back a line if you made a mistake. The play time in Winamp
will be set two lines before (if possible), so you can prepare yourself for setting the time tag again.
With the big button in the middle you can set a time tag on the actual line (beside this button).
If there is a line on which you won't set a time tag, click on the right arrow, so this line will be
jumped over. If you have finished (and the checkbox ALLOW EDITING BEFORE SAVE in the 
common tab is checked), you can edit the time tagged text before saving (using the SAVE button).
The file name is created automatically in dependence of the .mp3 file name and the file is stored in
the lyrics folder. If the checkbox isn't checked, the file will be saved automatically.
If you open an other file while editing, all entered information will be lost ! Otherwise
this is the only possible way to interrupt an edit session (beside closing the plug-in).

SKIN SUPPORT
------------

Since version 1.2 a skin support is implemented. If you want to make your own one please have a look at
the lyruni.bmp included in this zip-package. There's not a lot to say if you are familiar with making
skins. Please take into account that the resize button overlaps both the right border and the lower
right corner. All buttons are centered to the right border. The long piece in the header is responsible
for showing the song title, so there must be enough space for that. I use an 8pt Arial font with a
transparent background. The pieces beside it are meant to 'round off' the title display.

You can download the Lyrics Universe Skin Pack from our site at http://freewareshop.8m.com. 
The Lyrics Universe Skin Pack contains Winamp(C) 2.x skin and Lyrics Universe skin that created 
to match each other.


KNOWN PROBLEMS
--------------

Using Winamp 2.20 or later may result in a heavy disturbed motion. I don't know why. Maybe my computer
is too slow (Pentium 133) or the way Winamp calls the plug-in drawing routine has changed.
Sometimes, especially near the end of a song, the lyric is displayed too late. This is (in most cases)
NOT due to a false time-tag in the lyric file. It seems to be a problem with the time the plug-in gets 
from Winamp, but I'm not sure about this at the moment.
Sometimes the plug-in may hang up if it's closed by Winamp. I don't know why. The plug-in is written
in Delphi, so there may be a problem with the function calls from C. That's why I put a menuitem CLOSE
into the popup menu/title bar. If you use it, the plug-in will always close properly.

WARNINGS
--------

I tested this plug-in, but there may be left a lot of bugs and strange behavior. Use this
plug-in on your own risk. I'm not responsible for any damage the plug-in may cause on your computer or
on any other living and not living thing ;).


WORDS OF THANKS
---------------

Here I would like to thank people who helped me or made some useful proposals for improvements.

1. a lot of thanks to DENNY SUHARDI for his BIG support, especially for maintaining our homepage at
   http://freewareshop.8m.com, and for his great moral assistance; check out his homepage at 
   http://members.xoom.com/Stillhard ,too

2. and thanks to MIK who tested the plug-in in detail and made a lot of suggetions for improvement that I
   carried out in this version (I hope so at least); check out his biiig database of tagged lyrics
   at http://www.come.to/mp3lyrics 


WHAT NOW ?
----------

I hope you give the plug-in a try and enjoy being in the LYRICS UNIVERSE as much as you can. If you have
any comments or suggestions for improvements concerning both the lyric or visualization part, or if you found a
bug or if you just like the plug-in, I would be glad if you e-mail me, please.

Have fun !
Falk Schubert

Dresden, Germany
28.09.1999

P.S.: Soon I will finishing my studies in geodesy at the TUD (Technical University Dresden), so I'm looking
      for a job in the area of GIS (using GIS or programming GIS solutions/applications or so).


SHORT HISTORY
-------------

  1.22  : - fixed title bug (version 1.21)
          - skins are not stretched any more
		  - load/save of user defined settings now possible
		  - looks for subset of settings in skin pack
  
  1.21	: - looks for lyric files in the local path too
          - better recognition of lyric files
          - jump to line by click
		  - moving window now by clicking at the title bar
		  - added the activity value to the visualisation tab
		  - fixed some other small bugs

  1.2 	: - added skin support
    	  - fixed some bugs

  1.1 	: - first official release of LYRICS UNIVERSE
    