fum: a tui-based mpris music client.

fum is a tui-based mpris music client designed to provide a simple and efficient way to display and control your music within a tui interface.

Demo

demo.mp4

Roadmap / TODO

• Make some stuff visible optional
• Dont start if it cant find set players
• Customization of layout
• width, height on config
• Config
• CLI with clap

Installation

Arch

yay -S fum
# paru -S fum

Cargo (From Source)

git clone https://github.com/qxb3/fum.git
cd fum
cargo build --release

# Either copy/move `target/release/yum` to /usr/bin
# Or add the release path to your system's path

# Moving fum binary to /usr/bin
mv target/release/fum /usr/bin

Configuration

Config are located on ~/.config/fum/config.json.

Example config with their default values:

{
    "players": ["spotify"],
    "align": "center",
    "layout": "top-to-bottom",
    "hidden": [],
    "progress": "󰝤",
    "empty": "󰁱"
}

Values:

Name	Type	Description
players	string[]	String of player names that will be detected by fum.
align	string	Where in the terminal fum will be. Values: center top left bottom right top-left top-right bottom-left bottom-right.
layout	string	Which layout fum will use. Values: top-to-bottom bottom-to-top left-to-right right-to-right.
hidden	string[]	Hide some stuff from the ui. Values: title artists buttons progress-bar progress-text.
progress	string	The char that will be displayed on current progress.
empty	string	The char that will be displayed on empty progress.

Compability

Some terminals will have some issues of rendering the image as those don't support an image protocol yet. See Compability For compatible terminals.

Contributing

Thank you for considering contributing to fum! Contributions are welcome and appreciated.

LICENSE

MIT License

Copyright (c) 2025 qxb3

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.