Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elvyria/mixxc
Minimalistic and flavorful volume mixer for widget enthusiasts.
https://github.com/elvyria/mixxc
gtk4 gui linux pipewire pulseaudio relm4 rust volume-control wayland
Last synced: 3 days ago
JSON representation
Minimalistic and flavorful volume mixer for widget enthusiasts.
- Host: GitHub
- URL: https://github.com/elvyria/mixxc
- Owner: Elvyria
- License: mit
- Created: 2023-09-23T00:52:38.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-20T21:25:12.000Z (4 days ago)
- Last Synced: 2025-01-21T22:02:27.881Z (3 days ago)
- Topics: gtk4, gui, linux, pipewire, pulseaudio, relm4, rust, volume-control, wayland
- Language: Rust
- Homepage:
- Size: 407 KB
- Stars: 41
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Mixxc
[](https://crates.io/crates/mixxc)
[](https://opensource.org/licenses/MIT)
Mixxc is a minimalistic and customizable volume mixer, created to seamlessly complement desktop widgets.
Currently, it supports only `pulseaudio` and `pipewire` (through the pulseaudio interface) by utilizing `libpulseaudio` to receive audio events.
## Installation
Can be installed from [crates.io](https://crates.io/) with `cargo`:
```sh
cargo install mixxc --locked --features Sass,Wayland...
```
## Dependencies
* [GTK4](https://www.gtk.org/) (4.15.1+)
* [gtk4-layer-shell](https://github.com/wmww/gtk4-layer-shell) (Feature: Wayland)
* [libpulseaudio](https://www.freedesktop.org/wiki/Software/PulseAudio)
* [libxcb](https://xcb.freedesktop.org/) (Feature: X11)
## Features
Some features can be enabled at compile time.
* [Accent](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Settings.html) - Inherits the accent color from the system's settings.
* [Sass](https://sass-lang.com/) - Allows you to use SCSS instead of CSS.
* [Wayland](https://wayland.freedesktop.org/) - Uses wlr-layer-shell to imitate window positioning.
* [X11](https://www.x.org/) - Sets WM hints and properties, and repositions the window.
## Usage
```
Usage: mixxc [-w ] [-h ] [-s ] [-a ] [-A] [-C] [-m ] [-M] [-b ] [-u ] [-k] [-i] [-x ] [-P] [-v]
Minimalistic volume mixer.
Options:
-w, --width window height
-h, --height window width
-s, --spacing spacing between clients
-a, --anchor screen anchor point: (t)op, (b)ottom, (l)eft, (r)ight
-A, --active show only active sinks
-C, --accent inherit accent color from the system's settings
-m, --margin margin distance for each anchor point
-M, --master enable master volume slider
-b, --bar volume slider orientation: (h)orizontal, (v)ertical
-u, --userstyle path to the userstyle
-k, --keep keep window open
-i, --icon enable client icons
-x, --max-volume max volume level in percent (default: 100; 1-255)
-P, --per-process use only one volume slider for each system process
-v, --version print version
--help display usage information
```
## Customization
Mixxc is built with GTK4 and uses CSS to define its appearance.
You will find the style sheet in your config directory after the first launch.
```sh
${XDG_CONFIG_HOME:-$HOME/.config}/mixxc/style.css
```
If you have enabled the Sass feature, it will also look for *.scss and *.sass files.
```sh
${XDG_CONFIG_HOME:-$HOME/.config}/mixxc/style.sass
${XDG_CONFIG_HOME:-$HOME/.config}/mixxc/style.scss
```
## Tips
### Anchoring
It is often desirable to be able to position widgets relatively to a screen side.
Two flags will help with this: `-a --anchor` and `-m --margin`.
Each margin value provided will match every anchor point respectively.
```sh
mixxc --anchor left --anchor bottom --margin 20 --margin 30
```
### Startup Time
If startup seems a bit slow or memory usage seems a bit too high try this:
```sh
GSK_RENDERER=cairo GTK_USE_PORTAL=0 mixxc
```
### Manual Closing
By default window will be closed if it looses focus.
This is a workaround for WM's that don't send `close` request to layer-shells under Wayland.
If this behavior is not desirable, you can disable it:
```sh
mixxc --keep
```
### Toggle Window
If you want to toggle window with a click of a button, Unix way is the way:
```sh
pkill mixxc | mixxc
```
## Troubleshooting
### Environment
Mixxc is developed and tested with:
* Wayland (Hyprland): `0.45.2`
* PipeWire: `1.2.6`
If your setup is different and you experience issues, feel free to file a bug report.
### GTK
To get GTK related messages a specific environment variable must be non empty.
```sh
GTK_DEBUG=1 mixxc
```
## Building
To build this little thing, you'll need some [Rust](https://www.rust-lang.org/).
```sh
git clone --depth 1 https://github.com/Elvyria/mixxc
cd mixxc
cargo build --locked --release --features Sass,Wayland...
```