🎵 SyncLyrics: Real-Time Synced Lyrics for Your HA Dashboard

[Anshul99 (Anshul)]

SyncLyrics: Real-Time Synced Lyrics for Your HA Dashboard

Hey everyone! I’ve been working on this for over a year now (on and off) and finally polished it up enough that I wanted to share it.

What is it?

A free and open-source Windows app / Home Assistant addon that displays real-time synchronized lyrics on any device. Think Spotify lyrics, but on your tablet dashboard with multiple lyrics providers, album art backgrounds, playback controls, and more. It might run on Linux too, so I welcome anyone looking to test and give feedback.

Why I built it

I wanted lyrics on my desk tablet while working/jamming, but Spotify’s lyrics only work in the app and aren’t automatic. So I built this.

Once you get it up and running, it’s meant to run silently in the background at all times (an always-on server) and simply display lyrics whenever you start playing music.

Key Features

• Home Assistant addon (one-click install)

• 4 lyrics providers (Spotify, LRCLib, NetEase, QQ)

• Shazam audio recognition

• Beautiful album art backgrounds and artist images

• Works on any device (tablets, phones, TV, any device with a web browser)

• Reaper DAW integration

• Lots of configuration options

There’s a ton of other features that might make this post too long haha.

Demo and Screens

Watch Demo Video

Installation

Available via my addon repository with a full guide there: GitHub - AnshulJ999/homeassistant-addons: My personal HASS addons. · GitHub

Or run from source.

The HASS Addon requires Spotify credentials (client ID and secret) to connect to their API.

Once you get this up and running, displaying it inside an HA dashboard as easy as putting the server URL in an iFrame card!

Feedback needed!

I’d love to hear what you think:

• What features would you want added?

• Any bugs or issues you encounter?

• UI/UX suggestions?

• Ideas for better HA integration?

I’m open to contributors and pull requests to help expand this further!

GitHub: GitHub - AnshulJ999/SyncLyrics: A real-time synced lyrics app. Cross-platform support (including Home Assistant). Runs as a server that can be displayed on any device via a webpage. Optimized for tablet dashboards. · GitHub

[Mats789]

Nice But something is wrong with your demo video

I was probably to quick

[Thijsjuhhh]

This. Is. Awsome. !

I am looking for something like this for so long now, but every option i try isn’t either working, or it just isn’t that nice.

Simply install the addon, connect with Spotify, and put the url in a webcard and BAM Lyrics!

Thanks man! This thread needs more attention

When setting it up i did follow your instal instructions but stumbled upon a problem, might just be me, but i figured i leave it here for other people who might experience the same.
When you want to connect with Spotify for me it didnt work to use the IP adres in spotify developer segment + the config in the addon http://192.168.1.100:9012/callback. I got an error message that it wasn’t ‘‘safe’’. When i used https://192.168.1.100/9013 both in spotify as in the addon config it worked flawlessly

Cheerio!

[Anshul99 (Anshul)]

Thanks so much for your support and kind words! Really appreciate it, as well as the clarification with the Spotify OAuth change; this HTTPS is a recent requirement it seems.

I have just updated my app to v1.8.0 with new features and improvements, plus a full documentation that should help make it easier to work.

[Rick99]

Hi @Anshul99 ,

I am trying to setup the add-on but it keeps restarting and I can’t see the reason why because the log level doesn’t show more than what I am putting in this comment. Could you please provide some guidance?

spotify_client_id: XXX
spotify_client_secret: XXX
spotify_redirect_uri: https://192.168.1.64:9013/callback
spotify_base_url: https://spotify-lyrics-proxy.vercel.app
lastfm_api_key: ""
fanart_tv_api_key: ""
audiodb_api_key: ""
server_port: 9012
spotify_cache_path: /config/.spotify_cache
debug: true
log_level: ERROR
spotify_polling_fast_interval: 2
spotify_polling_slow_interval: 6
https_enabled: true
https_port: 9013
save_lyrics_locally: true
album_art_db: true
music_assistant_server_url: ""
music_assistant_token: ""
music_assistant_player_id: ""
compatibility_mode: false
openblas_coretype: ""

Starting SyncLyrics…

s6-rc: info: service legacy-services: stopping

s6-rc: info: service legacy-services successfully stopped

s6-rc: info: service legacy-cont-init: stopping

s6-rc: info: service legacy-cont-init successfully stopped

s6-rc: info: service fix-attrs: stopping

s6-rc: info: service fix-attrs successfully stopped

s6-rc: info: service s6rc-oneshot-runner: stopping

s6-rc: info: service s6rc-oneshot-runner successfully stopped

s6-rc: info: service s6rc-oneshot-runner: starting

s6-rc: info: service s6rc-oneshot-runner successfully started

s6-rc: info: service fix-attrs: starting

s6-rc: info: service fix-attrs successfully started

s6-rc: info: service legacy-cont-init: starting

s6-rc: info: service legacy-cont-init successfully started

s6-rc: info: service legacy-services: starting

s6-rc: info: service legacy-services successfully started

Starting SyncLyrics…

s6-rc: info: service legacy-services: stopping

s6-rc: info: service legacy-services successfully stopped

s6-rc: info: service legacy-cont-init: stopping

s6-rc: info: service legacy-cont-init successfully stopped

s6-rc: info: service fix-attrs: stopping

s6-rc: info: service fix-attrs successfully stopped

s6-rc: info: service s6rc-oneshot-runner: stopping

s6-rc: info: service s6rc-oneshot-runner successfully stopped

It seems that it cannot access the Spotify server and it doesn’t start and stop immediately.

I have functioning Spotify and SpotifyPlus integrations, so it’s probably related to the add-on and I also tried it without https but I am not sure.

Thanks for help.

[Anshul99 (Anshul)]

Hey @Rick99, can you please try the latest version of the HA addon and see if this fixes your issue? Also there’s a Debian version for compatibility that might work too.

If you still face this issue please let me know more details if you can and I will investigate further.

[floodwayprintco (Cory @ Floodway)]

Love it! I can see my lyrics in MusicAssistant now. Is there any doc or guide on how to get them to show up in a Lovelace panel?

[Anshul99 (Anshul)]

Thanks so much! I don’t have an exact guide but I just have a simple iFrame card on my dashboard pointing to my local synclyrics URL. Might write a proper one later. Basically since it’s a webpage, you can embed it anywhere you like, and it supports pretty much any custom size.

[nikno (Niklas)]

I already have a Spotify app created for HA on my Spotify Dev Dashboard, can I reuse that?

(as I have reached the limit on number of development mode apps - probably only allow for nonpaying developers)

[Anshul99 (Anshul)]

I believe that should work; just add the redirect URI for SyncLyrics based on how you're running it and it should work.