39 lines
1.8 KiB
Markdown
39 lines
1.8 KiB
Markdown
# Musixmatch-Inofficial
|
|
|
|
This is an inofficial client for the Musixmatch API that uses the key embedded in the
|
|
Musixmatch Android app or desktop client.
|
|
|
|
It allows you to obtain synchronized lyrics in different formats
|
|
([LRC](<https://en.wikipedia.org/wiki/LRC_(file_format)>),
|
|
[DFXP](https://www.w3.org/TR/ttml1/), JSON) for almost any song.
|
|
|
|
If you use the Android client, you need a free Musixmatch account
|
|
([you can sign up here](https://www.musixmatch.com/de/sign-up)). The desktop client can
|
|
be used anonymously and is currently the default option, but since Musixmatch
|
|
discontinued that application, they may shut it down.
|
|
|
|
## ⚠️ Copyright disclaimer
|
|
|
|
Song lyrics are copyrighted works (just like books, poems and the songs themselves).
|
|
|
|
Musixmatch does allow its users to obtains song lyrics for private use (e.g. to enrich
|
|
their music collection). But it does not allow you to publish their lyrics or use them
|
|
commercially.
|
|
|
|
You will get in trouble if you use this client to create a public lyrics site/app. If
|
|
you want to use Musixmatch data for this purpose, you will have to give them money (see
|
|
their [commercial plans](https://developer.musixmatch.com/plans)) and use their
|
|
[official API](https://developer.musixmatch.com/documentation).
|
|
|
|
## Development info
|
|
|
|
You can choose which client to test by setting the `MUSIXMATCH_CLIENT` environment
|
|
variable to either `Desktop` or `Android` (it defaults to Desktop).
|
|
|
|
Running the tests for the Android client requires Musixmatch credentials. The
|
|
credentials are read from the `MUSIXMATCH_EMAIL` and `MUSIXMATCH_PASSWORD` environment
|
|
variables.
|
|
|
|
To make local development easier, I have included `dotenvy` to read the credentials from
|
|
an `.env` file. Copy the `.env.example` file in the root directory, rename it to `.env`
|
|
and fill in your credentials.
|