Skip to content

About

Solium Player is a Windows OBS plugin that adds a Music Overlay source for showing the currently playing track in your OBS scenes.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 

Repository files navigation

Solium Player

Solium Player is a Windows OBS plugin that adds a Music Overlay source, showing the track you are currently playing inside your OBS scenes. It reads what Windows already knows through its media controls, so there is no account to connect, no API key, and nothing leaves your machine.

This repository distributes the Windows installer through GitHub Releases. The plugin source is kept outside this public release repository.

Requirements

  • Windows 10 build 19041 (version 2004) or later, 64-bit. Windows 11 included.
  • OBS Studio 64-bit, with the Browser source that ships with official OBS builds.
  • The .NET 8 runtime, for the music engine. The installer detects it and offers to install it (about 70 MB). You may decline: the plugin then falls back to a PowerShell engine that works without it, slightly slower and without the cover-based accent colour.

Built and tested against OBS Studio 32.1.2.

Download

  1. Open the Releases tab in this repository.
  2. Download SoliumPlayerSetup.exe from the latest release.
  3. Close OBS before running the installer.
  4. Run SoliumPlayerSetup.exe.
  5. If the installer does not detect OBS automatically, select your OBS installation folder.

Typical OBS path on Windows:

C:\Program Files\obs-studio

Installing in OBS

After installation:

  1. Open OBS.
  2. In your scene, click Sources > +.
  3. Add Music Overlay.
  4. Open the source properties to configure the music platform, layout, visual style, and custom CSS.

You can also open the plugin panel from:

Tools > Solium Player

This opens global Solium Player settings, including performance controls.

Supported players

Solium Player reads the media sessions Windows exposes. Each of these can be picked explicitly in the source properties:

Player Desktop app Browser tab or PWA
Spotify yes yes
Apple Music / iTunes yes yes
YouTube Music yes yes
Deezer yes yes
Tidal yes yes
Amazon Music yes yes
Qobuz yes yes
SoundCloud yes yes
VLC yes —
Windows Media Player, foobar2000, MusicBee, AIMP, Winamp, MediaMonkey yes —

Anything else Windows shows in its media controls works through All Windows players.

Playing in a browser

Windows only reports which application owns a media session, never which website it is playing. A service running in a tab or a PWA therefore shows up as Chrome, Edge, Firefox, Brave or Arc.

Picking a service explicitly handles this for you: Solium Player looks for the dedicated application first, and if none is running it accepts the browser session instead of showing nothing. A dedicated application always wins over a browser tab.

If a player is still not picked up, use Custom (keywords/domain) and type the service domain, for example deezer.com.

Main options

In the Music Overlay source properties:

  • music source: auto, Spotify, Apple Music, YouTube Music, SoundCloud, Deezer, Tidal, Amazon Music, Qobuz, VLC, local player, browsers, custom, all Windows players
  • layout: compact, standard, minimal, vertical
  • background: dominant colour, blurred cover, solid
  • visual presets: Minimal, Cyber, Glassmorphism, Spotify-like, Neon, Compact streamer, No background
  • platform label: automatic, "En écoute", "Now Playing", or the raw Windows source
  • toggles: progress bar, platform label, smart scrolling for long titles, accent glow
  • custom theme: background, opacity, border, text, progress colour, corner radius, blur
  • size: overlay width and height
  • SoliumEditor CSS: enable custom CSS, open the native OBS editor, open the themes folder

In Tools > Solium Player, global performance options:

  • overlay FPS: 15, 30, or 60
  • particles
  • blur
  • pause animations outside track changes
  • performance mode

SoliumEditor CSS

Solium Player includes SoliumEditor CSS, a custom CSS workflow for streamers and theme authors.

It provides:

  • a native OBS popup editor for quick edits;
  • a bundled Monaco-based web editor for the full editor experience;
  • local .css theme imports;
  • selector helpers for common overlay parts;
  • guard rails to keep custom CSS CSS-only.

To use it:

  1. Open OBS.
  2. Select a Music Overlay source.
  3. Open the source properties.
  4. Enable SoliumEditor CSS.
  5. Click SoliumEditor CSS: open OBS editor.
  6. Save your CSS from the editor.

Selectors for common overlay parts:

  • .solium-player: root overlay card
  • .music-card: card alias
  • .cover: cover container
  • .cover-image: cover image
  • .title: track title
  • .artist: artist name
  • .progress: progress bar
  • .barre: progress bar alias
  • .barre-fill: progress fill
  • .platform: platform label
  • .time: track time
  • .particles: particle layer
  • .spotify-playing: playing state
  • .spotify-paused: paused state
  • .spotify-loading: loading state

You can also click SoliumEditor CSS: open themes folder and drop extra .css theme files there. The editor can insert local imports such as:

@import url("./my-theme.css");

For safety, only CSS is accepted. Script tags, JavaScript URLs, SVG data URLs, eval(), fetch(), remote imports, and CSS escape variants of unsafe tokens are blocked. Imports are limited to local .css files inside the themes folder.

The editor is served on 127.0.0.1 and only accepts writes coming from its own page, so no website you visit can reach it and rewrite your overlay. The overlay itself only loads files from your own machine, never from a remote address.

Updating

  1. Close OBS.
  2. Download the latest SoliumPlayerSetup.exe from the releases.
  3. Run the installer again.

The installer replaces the plugin files and cleans old Solium Player data without touching other OBS plugins.

Uninstalling

Use the Windows app uninstaller for Solium Player.

OBS must be closed during installation, updates, and uninstallation.

Troubleshooting

The overlay stays on "Recherche musique"

  • Make sure music is actually playing.
  • Check that Windows sees the player: press a media key on your keyboard, or open the volume flyout. If Windows cannot control the player, Solium Player cannot read it either.
  • Try Music source > Auto.
  • If you play in a browser, pick your service explicitly, or use Browsers, or Custom with the service domain.
  • Close and reopen OBS after installing.

The overlay never leaves the loading state on a fresh install

This usually meant a missing .NET 8 runtime on earlier versions. Since 0.2.3 the plugin detects it and switches to its PowerShell engine on its own, so it should no longer happen. If it does, reinstall and accept the .NET 8 step.

OBS does not show the Music Overlay source

Run the installer as administrator, and make sure the OBS folder you selected contains bin, data and obs-plugins.

Known limitation

The native OBS popup uses Qt widgets. Monaco cannot be embedded directly inside that popup unless OBS ships QtWebEngine or a WebView runtime. Solium Player therefore provides both a native OBS popup editor and a bundled Monaco web editor.

About

Solium Player is a Windows OBS plugin that adds a Music Overlay source for showing the currently playing track in your OBS scenes.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors