bladeacer/yams
2
2
Fork 0
Code Issues Pull requests 1 Activity
Yet another audio status indicator. playerctl wrapper go brr
59 commits 1 branch 0 tags 451 KiB
  • C 83.8%
  • Makefile 14.2%
  • Meson 2%
Find a file
bladeacer 3aa796f305
 Fixed Art jp2a flag
2026-05-01 17:49:52 +08:00
src Fixed Art jp2a flag 2026-05-01 17:49:52 +08:00
.gitignore Split art rendering into its own file 2026-04-27 16:38:33 +08:00
LICENSE.APACHE Update License 2026-04-27 14:19:38 +08:00
LICENSE.MIT Update License 2026-04-27 14:19:38 +08:00
Makefile Fixed Art jp2a flag 2026-05-01 17:49:52 +08:00
meson.build Split art rendering into its own file 2026-04-27 16:38:33 +08:00
preview.webp Added preview 2026-04-28 19:09:24 +08:00
README.md Fixed CPU usage 2026-04-30 17:35:06 +08:00

README.md

yams

Screenshot

Yet another media screensaver.

Or status indicator

playerctl wrapper go brr.

Features

  • CJK/Unicode Support (ncursesw)
  • Currently Playing Media (playerctl)
    • Metadata (Media name/title/etc.)
    • ASCII art (extracted from audio file/URL)
    • Lyrics (if available)
    • Play/Pause Next/Previous
  • Help Menu for keybinds
  • Refresh Button (if auto-refresh/polling does not work)

Planned

  • Rendering layout for smaller screens

Known Issues

Needs programme restart.

  • Fallback mode check not triggered by refresh hotkey.

When opened in tmux, switching focus away and then back means programme can only exit with Ctrl + C instead of q.

Tested Media Players

  • mpv (requires mpv-mpris)

  • YouTube Web

  • YouTube Music Web

  • Tauon

  • Firefox-based browser(s)

Should work with media players detectable by playerctl or those that implement mpris.

PRs welcome to add tested media player entries.

Requirements

Core Dependencies

Built on the shoulders of giants.

  • ncurses (TUI)
  • playerctl
  • ffmpeg (Extract image thumbnail from audio file)
  • imagemagick (Convert to WEBP, used so jp2a handles image scaling better)
  • jp2a (JPG/WEBP to ASCII)
  • sed (Regex replace)

Dev Dependencies

  • GNU Make
  • meson
  • ninja

Platform support

Linux.

Should work on MacOS/WSL (untested).

Setup

Clone the repository, ensure you have listed dependencies on your system.

git clone --depth=1 https://codeberg.org/bladeacer/yams.git

  • Use make install to install binary to /usr/local/bin.

  • Use make release to install stripped binary to ./build/yams.

  • Use make run to install binary with debug to ./build/yams.

Binary size comparison

make flag Binary size
make install ~ 32 kB
make release ~ 40 kB
make run ~ 84 kB

LLM Usage Disclaimer

I used LLMs to help with development.

This is my first project using ncurses, C and UNIX tools like strace, stat.

License

Dual licensed under either the MIT or Apache-2.0 License, at your own choice.