Skip to content
This repository has been archived by the owner on Apr 27, 2024. It is now read-only.

NyaomiDEV/Sunamu

Repository files navigation

Logo

Sunamu (スナム)

Show your currently playing song in a stylish way!

Screenshots

Lyrics preview Browser preview Widget preview OBS source preview Sunamu will never gonna give you up Hey!

OwO wats dis?

Sunamu (pronounced as it is written) is a fancy music controller whose only purpose is to look as fancy as possible on secondary displays.

It effectively is the WAY TOO COMPLEX successor of MPRISLyrics, a project I made back when synchronized lyrics on Linux was a niche thing to have.

Features

  • Display what you are playing in your TV, secondary display, or (heck) around the entire house!

  • Get the Spotify link for every song you listen to!*

  • Get lyrics for your songs!

  • Get a GOOD Discord Rich Presence, finally!*

  • Bragging rights for your particular taste in music!**

    *This feature, or part of it, requires a Spotify Client ID and Client Secret.

    **No responsibility is taken from the Sunamu devs and contributors if you have bad taste in music

Installation

Sunamu only works on Linux! Do not spam the issue section regarding Windows or macOS, as it cannot be ported to those computers!

Linux

NOTE: Sunamu is very slow on development, mostly because there's hardly anything to implement that the developer can do. Please consider this when running a tagged release, as you can easily run a months-old, or even years-old, version. Please try compiling Sunamu from this repo instead!

Get the latest release from the Releases section.

Configuration

Sunamu's configuration file is located in:

  • Linux: Usually ~/.config/sunamu/config.json5 ($XDG_CONFIG_HOME/sunamu/config.json5);
  • Linux Flatpak: ~/.var/app/xyz.nyaomi.sunamu/config/sunamu/config.json5 (unsupported! but you can compile it yourself);

You can use it to enable or disable features, and there are a LOT of them!

Do you want to give it a read? Here it is!

Usage

Just launch it and preferably put it in fullscreen!

Notable observed quirks

Check and contribute to the compatibility table here.

License

See the LICENSE file.