Home

Welcome to i3-volume

i3-volume is a powerful volume control script with on-screen display notifications. It works with any window manager (i3wm, bspwm, KDE) and status bars (polybar, i3blocks, i3status).

What is i3-volume?

i3-volume provides comprehensive audio control through PipeWire/WirePlumber, including:

• Volume control with decimal and dB support
• Microphone control
• Per-application volume management
• Multiple audio device (sink) management
• Volume profiles and presets
• Smooth volume transitions
• Custom notification methods
• Plugin system for extensibility

Quick Start

New to i3-volume? Start here:

1. Getting Started - Step-by-step setup guide
2. Installation - Installation instructions for your setup
3. Basic Configuration - Configure notifications and basic settings
4. Examples - Common use cases and recipes

Documentation

Getting Started

• Getting Started - Complete setup guide for new users
• Installation - Installation instructions for different setups
• Configuration - Configuration file settings and options

Features & Usage

• Features - Complete feature documentation
• Examples - Common use cases and configuration recipes
• Tips & Tricks - Advanced usage and power user tips

Integrations

• Integrations - All integration guides (status bars, notifications, etc.)
  • i3blocks
  • polybar
  • i3status-rust
  • xob
  • XOSD
  • herbe
  • volnoti
  • KOSD

Customization

• Notifications - Supported notification methods
• Plugins - Custom plugin development
• Keybindings - Keybinding examples

Advanced

• Tips & Tricks - Advanced usage patterns
• Migration - Migrating from other tools

Troubleshooting

• Common Issues - Troubleshooting guide
• FAQ - Frequently asked questions

Popular Guides

Guide	Description
Getting Started	First-time setup guide
Installation	Installation for i3wm, polybar, i3blocks
Examples	Common configuration recipes
Configuration	Complete configuration reference
Features	All available features

What's New

v4.0.0 - i3-volume now uses PipeWire/WirePlumber for audio control. See the Features page for all available capabilities including:

• Per-application volume control
• Volume profiles and presets
• Volume boost feature
• Smooth volume transitions (fade)
• Enhanced listen mode with filtering
• Mouse wheel support
• Port management (BETA)
• Plugin system for custom notifications and output formats
• Per-sink configuration
• Exit codes for script integration
• Balance control
• Volume normalization
• Volume history and undo
• Dry-run mode for testing commands
• Logging and debug mode for troubleshooting

Quick Navigation

Getting Started	Installation	Configuration	Features	Examples	Common Issues
Setup guide for new users	Installation instructions	Configuration settings	Feature documentation	Use cases & recipes	Troubleshooting help

Need Help?

• First time? → Start with Getting Started
• Having issues? → Check Common Issues
• Looking for examples? → See Examples
• Want to customize? → Read Configuration and Plugins