liamaharon / volux

Table of contents

• Volux
  • Purpose
    • What does it do?
    • What will it do?
    • Screenshots
    • Supported platforms
  • Installation
    • Requirements
    • Install via pip
    • Install via wheel (.whl)
    • Build from source
  • Using Volux
    • Modes
    • Volume/brightness
    • Exit
  • Issues and bugs

( generated by gh-md-toc )

Volux

BRANCH	BUILD	COVERAGE	REQUIREMENTS	ISSUES	OPEN PRs
Master
Develop

Purpose

Volux is an application written in Python 3 aimed at media powerusers.

What does it do?

Volux allows you to perform many media operations quickly using just your mouse/touchpad.

All interactions are registered when hovering over the Volux bar on your screen.

• Increase/decrease volume using scroll
• Mute/unmute using middle-click

What will it do?

Features in development / planned for development

• Brightness control via mouse wheel
• Interface customisation

Screenshots

Mode	State	Image
Volume (active)	active
Volume (inactive)	inactive
Mute (active)	active
Brightness (active)	active

Supported platforms

   Windows 7 or later

   MacOS

   Linux (most distributions)

Installation

Requirements

$ sudo apt-get install python3-tk python3-xlib python3-dbus libasound2-dev

Install via pip

Install as user (recommended):

$ pip3 install volux --user

Install as root:

$ sudo pip3 install volux

Install via wheel (.whl)

Install as user (recommended):

$ pip3 install volux-*-py3-none-any.whl --user

Install as root:

$ sudo pip3 install volux-*-py3-none-any.whl

Build from source

Clone this repository:

$ git clone https://github.com/DrTexxOfficial/volux.git

Install pip requirements:

$ cd volux
$ pip3 install -r requirements.txt --user

Build:

$ python3 setup.py bdist_wheel

Using Volux

All interactions with Volux are only valid when hovering over the bar Volux produces. This allows you to interact with Volux without loosing your ability to use your scroll bar in other applications.

Modes

To cycle between modes in Volux, right-click the main bar. By default, a green bar signifies volume mode and a blue bar signifies brightness mode (wip).

Volume/brightness

While in volume or brightness mode, scroll up/down to increase/decrease volume or brightness while hovering over the main bar.

Exit

To exit Volux, double right-click the bar at any time.

Issues and bugs

If you have any problems running Volux, please kindly post an issue to this repository. Issues can be solved much faster if you can provide:

• Your OS
• Your desktop environment (if using Linux)
• A Summary of issues experienced
• Any relevant screenshot/s

Volux is developed under Debian (Linux) using GNOME 3.22.2 and Python 3.5. Providing you've correctly installed all dependencies, Volux is almost guranteed to work under these conditions.