clarjon1 / Sunamu

Show your currently playing song in a stylish way! This fork aims to reduce the work NyaomiDEV has for getting windows support smoother!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Logo

Chat on Discord

Sunamu (スナム)

Show your currently playing song in a stylish way!

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.

It only supports Windows and Linux for now. macOS support is not planned. Pull request, someone?

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

Windows / Linux

NOTE: Windows builds are provided but they are highly experimental (think of that as essentially PoC / tech demos) and reported issues will not be fixed unless they also happen for the same reason on Linux. When reporting any issues you have to state that you are on Windows, since Sunamu works differently there and I am not able to support your platform of choice in official capacity.

NOTE 2: Sunamu is very slow on development, mostly because there's hardly anything to implement that I can do (local girl needs help). 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.

On Windows, you can choose between the installer and the ZIP file (portable app).

On Linux, the AppImage is recommended since it runs basically everywhere (but also Flatpak, Fedora/RedHat, Debian and Arch packages are provided.)

Arch Linux

sunamu and sunamu-git are available as AUR packages. Install either of them via your AUR helper of choice. The Git package usually breaks because I like using very recent Electron versions, so if you use that please be advised that there can be multiple issues if your system's Electron package is not the very latest (or close to).

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;
  • Windows: %APPDATA%\sunamu\config.json5.

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.

About

Show your currently playing song in a stylish way! This fork aims to reduce the work NyaomiDEV has for getting windows support smoother!

License:Mozilla Public License 2.0


Languages

Language:TypeScript 100.0%