fum: A fully ricable 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

Installation

Arch

yay -S fum
# paru -S fum

Nix Flakes

To install fum using Nix Flakes and configure it with configuration.nix, follow these steps:

1. Add fum as an input in your flake.nix:

   {
     inputs = {
       nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
       flake-utils.url = "github:numtide/flake-utils";
       fum.url = "github:qxb3/fum";
     };
   
     outputs = { self, nixpkgs, flake-utils, fum }:
       flake-utils.lib.eachDefaultSystem (system: let
         pkgs = import nixpkgs { inherit system; };
       in {
         nixosConfigurations = {
           hostname = pkgs.lib.nixosSystem {
             system = system;
             modules = [
               ./configuration.nix
               fum.nixosModules.fum
               {
                 services.fum = {
                   enable = true;
                   players = ["spotify"];
                   use_active_player = true;
                   align = "center";
                   direction = "vertical";
                   flex = "start";
                   width = 20;
                   height = 18;
                   debug = false;
                   layout = [];
                 };
               }
             ];
           };
         };
       });
   }

2. Apply the NixOS configuration:

   sudo nixos-rebuild switch

Nix Profile

To install fum using Nix profile, run the following command:

nix profile install github:qxb3/fum

Nix Run

To run fum directly using nix run, use the following command:

nix run github:qxb3/fum

Cargo (From Source)

Caution

Installing from source is typically not recommended as it will probably have breaking stuff.

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

Configuring

See Wiki

Need help?

Join Discord Server!.

Showcase on a rice

Contributing

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

LICENSE

MIT