JakeStanger/mpd-lyricsd
1
0
Fork 0
mirror of https://github.com/JakeStanger/mpd-lyricsd.git synced 2026-07-11 09:15:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
Lyrics fetching service for MPD.
3 commits 1 branch 0 tags 229 KiB
  • Rust 100%
Find a file
Exact
Jake Stanger a8b9830887
 docs(readme): fix crate link
2023-03-13 22:49:31 +00:00
.idea chore: initial commit 2023-03-13 22:44:12 +00:00
src chore: initial commit 2023-03-13 22:44:12 +00:00
.gitignore chore: initial commit 2023-03-13 22:44:12 +00:00
Cargo.lock chore: initial commit 2023-03-13 22:44:12 +00:00
Cargo.toml chore: add cargo license/description fields 2023-03-13 22:48:29 +00:00
README.md docs(readme): fix crate link 2023-03-13 22:49:31 +00:00

README.md

mpd-lyricsd

Lyrics fetching service for MPD.

Currently capable of fetching lyrics from Genius only.

Installation

Cargo

cargo install mpd-lyricsd

crate

From source

git clone https://github.com/jakestanger/mpd-lyricsd
cd mpd-lyricsd
cargo build --release

Configuration

mpd-lyricsd uses universal-config, which means it supports any of JSON, YAML, TOML, and Corn.

Create a file of your preferred type at ~/.config/mpd-lyricsd/ called config, for example config.corn.

Name Type Default Description
lyrics_path String null [Required] Path to save lyrics on disk.
genius.access_token String null [Required] Access token for Genius API. See below.
mpd.address String localhost:6600 TCP or Unix socket to connect to MPD on.

Example

config.toml:

lyrics_path = "/home/jake/Music/.lyrics"

[genius]
access_token = "<redacted>"

[mpd]
address = "media-server:6600"

Genius access token

Genius requires you to provide an access token to authenticate against the API.

To create one, you require a Genius account, and then must create an API Client registration. Create one here: https://genius.com/api-clients/new.

You can use any app name and website URL.

Once created, generate an access token and copy it into your config.