Skip to content

JakeStanger/mpd-lyricsd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Lyrics fetching service for MPD.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages