add lrc plugin (#156)
* added lrc plugin to display lyrics of playing music * added a small demonstration * fixed the readme and added proper thumbnail * added a demo * trimmed up some deps and removed the demo --------- Co-authored-by: shin01221 <mohamed@madin372.com>
This commit is contained in:
@@ -0,0 +1,32 @@
|
||||
# LRC
|
||||
|
||||

|
||||
|
||||
Displays current song lyrics on the bar widget via `lrc_tty`. Works with MPD and Spotify.
|
||||
|
||||
## Plugin
|
||||
|
||||
| Field | Value |
|
||||
| --- | --- |
|
||||
| ID | `shin/lrc` |
|
||||
| Entries | Bar widget: `lrc` |
|
||||
|
||||
## Requirements
|
||||
|
||||
- `lrc_tty` — fetches synchronized lyrics over the network from the configured provider.
|
||||
- `playerctl` — reads MPRIS player status and metadata.
|
||||
|
||||
## Usage
|
||||
|
||||
Enable `shin/lrc` in Settings → Plugins, then add the **LRC** bar widget. It displays the current lyric line when a track is playing.
|
||||
|
||||
The widget checks MPD first, then falls back to Spotify.
|
||||
|
||||
## Spawned processes
|
||||
|
||||
- `playerctl` — enumerates MPRIS players and queries playback status and metadata.
|
||||
- `lrc_tty` — fetches synchronized lyrics and outputs them.
|
||||
|
||||
## Network access
|
||||
|
||||
`lrc_tty` connects to remote lyric APIs to fetch synchronized lyrics for the currently playing track.
|
||||
Reference in New Issue
Block a user