https://github.com/NyaomiDEV/Sunamu

Show your currently playing song in a stylish way!
https://github.com/NyaomiDEV/Sunamu

Last synced: 26 days ago
JSON representation

Show your currently playing song in a stylish way!

• Host: GitHub
• URL: https://github.com/NyaomiDEV/Sunamu
• Owner: NyaomiDEV
• License: mpl-2.0
• Archived: true
• Created: 2021-09-24T18:11:08.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-30T11:41:08.000Z (11 months ago)
• Last Synced: 2024-08-03T09:04:05.251Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 10.2 MB
• Stars: 396
• Watchers: 8
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-linux-ricing - Sunamu

README

        


# Sunamu (スナム)

Show your currently playing song in a stylish way!

## Screenshots

















## 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](https://github.com/NyaomiDEV/Sunamu/releases/latest) 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!](assets/config.json5)

## Usage

Just launch it and preferably put it in fullscreen!

## Notable observed quirks

Check and contribute to the compatibility table [here](COMPATIBILITY.md).

## License

See the [LICENSE](LICENSE) file.