Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Smile4ever/VLC-Lyrics-Finder

VLC media player lyrics extension
https://github.com/Smile4ever/VLC-Lyrics-Finder

Last synced: 3 months ago
JSON representation

VLC media player lyrics extension

Host: GitHub
URL: https://github.com/Smile4ever/VLC-Lyrics-Finder
Owner: Smile4ever
License: gpl-2.0
Created: 2014-11-12T20:05:14.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2020-08-18T13:09:34.000Z (about 4 years ago)
Last Synced: 2024-06-12T17:59:07.428Z (5 months ago)
Language: Lua
Homepage:
Size: 722 KB
Stars: 55
Watchers: 13
Forks: 16
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

VLC Lyrics Finder
==============

VLC Media Player lyrics extension. Supports MetroLyrics, Sonic Hits, Lyrics Mode, Golyr.de, AZ Lyrics, Lyrics.com and Lyricsmania.com.

![Lyrics Finder 0.3.0 on Linux](http://hugsmile.eu/file/lyricsfinder/screenshot-v030.png)

Installation
-------------
For version 0.3.7 and later, VLC 3.0 or higher is required. The last version compatible with VLC 2.x is 0.3.6.

* Download installer for Windows: [install 0.3.7 for VLC 3](https://github.com/Smile4ever/VLC-Lyrics-Finder/raw/master/windows-releases/lyricsfinder-0.3.7.exe) or [install 0.3.6 for VLC 2](https://github.com/Smile4ever/VLC-Lyrics-Finder/raw/master/windows-releases/lyricsfinder-0.3.6.exe)
* Installation steps for Linux and macOS:

1. Download [lyricsfinder.lua 0.3.7 for VLC 3](https://raw.githubusercontent.com/Smile4ever/VLC-Lyrics-Finder/master/lyricsfinder.lua) or [lyricsfinder 0.3.6 for VLC 2](https://raw.githubusercontent.com/Smile4ever/VLC-Lyrics-Finder/d941cd0f9a29b042401b4cb4680f008c0e0dadb0/lyricsfinder.lua) (Use **File -> Save as** if necessary).
2. Move the file lyricsfinder.lua to **lua/extensions** inside your VLC folder. For example, **C:\Program Files\VideoLAN\VLC\lua\extensions\lyricsfinder.lua**
3. To install the language files, put them inside your VLC folder in the subdirectory **lua/extensions/lyricsfinder/locale**. For example, **C:\Program Files\VideoLAN\VLC\lua\extensions\lyricsfinder\locale**
3. Restart VLC or open **Tools -> Plugins and extensions** and hit **reload extensions**.

VLC folder path:

* Windows: **C:\Program Files\VideoLAN\VLC\lua\extensions\**
* macOS: **~/Library/Application\ Support/org.videolan.vlc/lua/extensions/**
* Linux user path: **/home/$USER/.local/share/vlc/lua/extensions**
* Linux system path: **/usr/share/vlc/lua/extensions**

Usage
-------
1. Go to **View -> Lyrics Finder**.
2. Make sure *title* and *artist* are correct.
3. Hit **Get Lyrics**.

Other buttons:

* Search with Google: open a new browser tab to look for lyrics
* Save lyrics: save lyrics to a TXT file in /tmp or C:\Temp
* Switch: artist and title wrongly guessed? Click this button to switch them. The artist text becomes the title text, the title text becomes the artist text.

When you open Lyrics Finder, an attempt will be made to get the lyrics of the song. When the song changes, starting from 0.3.7, Lyrics Finder will attempt to find lyrics for the current song.

Intelligent guessing
--------------------
Since version 0.3.0, this script supports intelligent guessing. This means that when you name your files properly, it will detect the artist and song title from the filename. Good examples of file names:

* Artist - Title (year of release) -> Steve Allen - Letter From My Heart (1984)
* Artist - Title -> Steve Allen - Letter From My Heart
* Artist - Title (anything): the information between parenthesis is discarded
* Artist-Title: also works without spaces before and after the hyphen

Wrong file names:
* Title - Artist
* File names that contain two hyphens, like "Artist - Title - Album name". There is one exception: artist names that contain a hyphen are valid. For example "A-ha - Stay On These Roads".

If your files contain metadata, Lyrics Finder uses that information. Otherwise, it uses intelligent guessing.

Sources
-------
Lyrics Finder gets its lyrics from several websites. If Lyrics Finder is unable to find lyrics for your song, verify that you comply with the Intelligent Guessing Format (see above) or make sure that you have proper metadata tags attached to your files.

With so many sites supported, it's still imaginable that the lyrics for a specific song are not yet available. You can add them yourself [using MetroLyrics](http://www.metrolyrics.com/add.html) or [using LyricsMode](http://www.lyricsmode.com/lyrics_submit.php).

Translation
-------
If you would like to make a translation of Lyrics Finder to your own language, follow these steps:

1. [Make an account at Transifex](https://www.transifex.com/signup/)
2. [Start translating](https://www.transifex.com/projects/p/vlc-lyrics-finder/)

If the language you want to translate is not present, [make an issue](https://github.com/Smile4ever/VLC-Lyrics-Finder/issues) asking to add the desired language or request a language on Transifex.