mirror of
https://github.com/Felitendo/jellyfin-plugin-lyrics.git
synced 2026-11-01 17:23:25 +01:00
Felix
4fa0e31953
Changed the scheduled task name, key, and description for clarity. Updated plugin GUID and manifest metadata to reflect new features and category. Adjusted README instructions to match updated task and category names.
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
# 🎶 Jellyfin Lyrics Plugin
|
||
|
||
A plugin for **Jellyfin** that automatically downloads and displays lyrics for songs in your music library using [lrclib.net](https://lrclib.net).
|
||
|
||
---
|
||
|
||
## ✨ Features
|
||
|
||
- 🔄 Automatically downloads lyrics for your entire library
|
||
- 🎼 Seamlessly integrates with Jellyfin’s music player
|
||
- 🌐 Fetches lyrics directly from [lrclib.net](https://lrclib.net)
|
||
- 🕒 Real-time lyrics display during playback
|
||
|
||
---
|
||
|
||
## 🚀 Installation
|
||
|
||
1. Make sure your Jellyfin server is updated to **version 10.9.11 or higher**
|
||
2. Add the plugin repository URL to Jellyfin:
|
||
|
||
https://raw.githubusercontent.com/Felitendo/jellyfin-plugin-lyrics/master/manifest.json
|
||
|
||
3. Open the **Plugin Catalog** in your Jellyfin dashboard
|
||
4. Look for **"Lyrics"** under the **Metadata** category and install it
|
||
5. Restart Jellyfin
|
||
6. Search for the Plugin "LrcLib" (should be pre-installed) and uninstall it
|
||
7. Restart Jellyfin again
|
||
8. Go to **Scheduled Tasks** and run **"Download missing lyrics (new)"**
|
||
9. Go to **Libraries** and click on **Scan all Libraries**
|
||
|
||
---
|
||
|
||
## 🛠️ Troubleshooting
|
||
|
||
- **Plugin not appearing?**
|
||
→ Double check if your Jellyfin version is **10.9.11 or higher**
|
||
|
||
- **Lyrics not showing?**
|
||
→ Try to search for songs manually (right click on a song -> edit song text -> click on the search icon)
|
||
→ Try **refreshing metadata**
|
||
|
||
- **Missing lyrics for specific tracks?**
|
||
→ Manually refresh metadata (see below)
|
||
→ Toggle the `"Use strict search."` option in plugin settings
|
||
|
||
---
|
||
|
||
## 🔄 Manual Refresh
|
||
|
||
If lyrics aren't appearing for specific albums:
|
||
|
||
1. Navigate to the album
|
||
2. Right-click the album
|
||
3. Select **"Refresh metadata"**
|
||
|
||
---
|
||
|
||
## 🤝 Contributing
|
||
|
||
Contributions are welcome!
|
||
Feel free to open a **Pull Request**, or suggest new features / report bugs via an **Issue**.
|
||
|
||
---
|
||
|
||
## 📬 Support
|
||
|
||
👉 [Create an Issue](https://github.com/Felitendo/jellyfin-plugin-lyrics/issues)
|