SyncLyrics

Description

A lightweight, cross-platform desktop application that displays synchronized lyrics for your currently playing song on Spotify and Windows Media.

Notes: Forked by me for personal use. It focuses on Windows 10/11 and Spotify desktop client. I can't guarantee it will work on other OS or other music players.

Main UI

Minimal Mode can be accessed by adding ?minimal=true to the URL

✨ Features

• Instant Sync: Fetches time-synced lyrics from multiple providers like LRCLib, NetEase, Spotify, and QQ Music (configurable).
• Parallel Search: Queries all providers simultaneously for zero lag.
• Cross-Platform: Works on Windows (native media integration) and Linux (via playerctl).
• Customizable: Dark/Light themes, transparency, and minimized "Overlay" mode.
• Resource Efficient: Smart caching ensures <1% CPU usage.

🚀 Installation

Option 1: Download Executable (Windows)

1. Go to the Releases page.
2. Download SyncLyrics.zip.
3. Extract and run SyncLyrics.exe.
4. Configure the app:
   • Rename .env.example to .env in the SyncLyrics folder.
   • (Optional) Add your Spotify Client ID/Secret for better reliability.

Option 2: Run from Source

1. Install Python 3.10+.
2. Clone the repo:

   git clone https://github.com/AnshulJ999/SyncLyrics.git
   cd SyncLyrics

3. Install dependencies:

   pip install -r requirements.txt
   # For Windows Media support (included in requirements.txt):
   # pip install winsdk

4. Create your configuration:
   • Rename .env.example to .env.
   • (Optional) Add your Spotify Client ID/Secret for better reliability.
5. Run the app:
   • Regular Use (Hidden): Double-click Run SyncLyrics.vbs
   • Debug Mode (Console Visible): Double-click Run Debug.vbs or run:

     python sync_lyrics.py

🛠️ Build

To create a standalone executable:

python build.py

This will generate the executable in build_final/SyncLyrics/SyncLyrics.exe.

⚙️ Configuration

You can configure the app via the System Tray icon -> Settings, or by editing config.py / .env.

Setting	Description
ENABLE_PARALLEL_FETCH	Speed up search by asking all providers at once.
CACHE_DURATION_DAYS	How long to keep lyrics offline (Default: 30 days).
SPOTIFY_LYRICS_SERVER	Custom Spotify lyrics API server.

🤝 Contributing

Pull requests are welcome! Please make sure to update tests as appropriate.

📜 License

MIT

Disclaimer (AI Usage)

Much of the app has been coded with AI assistance (vibe-coded), so please keep an open mind.

❤️ Credits

Based on the original work by Konstantinos Petrakis.

Libraries used:

• Lyricify
• Syncedlyrics
• spotify-lyrics-api