The documentation is located at currentsong.nerixyz.de.
This project is a rewrite of the CurrentSong Overlay. The core is
written in Rust now. Both Windows and Unix platforms are supported. On Windows, GlobalSystemMediaTransportControls
is used and on Unix, D-Bus is used.
The goal of the project is to create a simple yet powerful overlay that displays the currently playing song. There are a few unique features separating this project:
-
Near zero latency ⏱ Current Song 2 doesn't poll applications or APIs for updates.
-
Displaying Progress 💯 Progress is displayed where available.
-
Display Album Art 🖼
-
Customizable 🔧 The overlay is customizable through CSS (
theme.css
) and JavaScript (user.js
), see Customization. Modules and the server can be configured in aconfig.toml
file, see Configuration.
graph TD;
gsmtc[GSMTC<br><i>Windows</i>]
dbus[MPRIS D-Bus<br><i>Unix</i>]
ext[Browser Extension]
cso2[CurrentSong2]
ext-->cso2
Browser-->dbus
Spotify-->dbus
VLC-->dbus
MPV-->dbus
Browser-- limited <br> playback progress -->gsmtc
Browser-- playback progress -->ext
Spotify-->gsmtc
gsmtc-->cso2
dbus-->cso2
cso2-->Overlay
See more in the projects tab.