slonopot / museexmatch Goto Github PK

It's just a lyrics provider.

This plugin is made and published exclusively for educational purposes. The plugin uses the private Musixmatch API and may stop working whenever the legal owners decide to take action. I take no responsibility, if someone asks then it wasn't me.

Using private Musixmatch API to get lyrics. Synced lyrics are supported. Pulling metadata from the file itself for MusicBee 3.6.8922+ which is not the main release at the moment.

Get a release and extract all .dll files into %APPDATA%\MusicBee\Plugins\ directory. For portable version use Plugins directory.

Preferences -> Plugins -> Enable Museexmatch.
Preferences -> Tags (2) -> Lyrics -> Musixmatch via Museexmatch.

Create museexmatch.conf in the %APPDATA%\MusicBee\ directory (AppData for portable) and use this template:

{
    "allowedDistance": 5,
    "delimiters": ["&", ";", ","],
    "verifyAlbum": false,
    "addLyricsSource": false,
    "trimTitle": false,
    "preferSyncedLyrics": false,
    "onlySyncedLyrics": false
}

museexmatch.conf includes several options. You are allowed to use only ones you need, just omit the line and don't forget about commas in JSON.

1. Configurable title distance for minor differences. Defaults to 5. This means that a present N-character difference in search results won't affect the filtering and be considered a hit.
2. Configurable artist delimiters ("A & B, C" => "A"). Defaults to none. Useful when you have several artists for the track but Musixmatch includes only the main one.
3. Configurable album verification. Plugin will check if the album is the same. Names must be identical.
4. Configurable lyrics source marker. Plugin will append "Source: Musixmatch via Museexmatch" to the lyrics' beginning if enabled.
5. Configurable title trim. This option will remove all content in brackets from the title. By default MusicBee removes only features in the round brackets, this option will remove all content in [], {}, <> and ().
6. Configurable synced lyrics preference. Plugin will return synced lyrics in LRC format. Advanced LRC (split by words) is not supported by MusicBee.
7. Configurable synced lyrics preference (forced). Plugin will only return synced lyrics in LRC format and pass the request to another plugin if not found. This allows to choose synced Musixmatch first and text Genius second, for example. Restart MusicBee to apply changes.

1. Plugin gets either the "artist" field or the first artist in the extended list if you've edited it manually alongside with the "title".
2. Plugin searches for results just like they are. Results (artist + title) are allowed to differ no more than allowedDistance characters.
3. Plugin checks for result artist aliases.
4. Plugin strips down the artist using the delimiters (if provided), searches and handles aliases.

You can find log at %APPDATA%\MusicBee\museexmatch.log (AppData\museexmatch.log for portable).

https://github.com/toptensoftware/JsonKit

https://nlog-project.org/

https://github.com/mono/taglib-sharp