awesomewm config

Welcome to my Awesomewm dotfiles

Introduction to Awesome

Awesomewm, or the Awesome Window Manager, is a minimalist program based on dwm, an even more minimal program designed to manipulate, display, and manage clients in a Linux X server environment. Awesomewm provides a well-defined API for defining custom widgets, controlling windows, and responding to button presses. This allows for awesome to be used to create User Interfaces that are dynamic and beautiful while still remaining light weight. For more information, visit the awesomewm documentation at https://awesomewm.org/apidoc/

Introduction to my Theme

This theme was designed with the following set of standards:

• Good User Interfaces should improve the workflow of both Power-Users and New Users alike.
• Good User Interfaces should not take up unnessecary screenspace.
• Good User Interfaces should consist of items that are immediately recognizable in their functionality.
• Good User Interfaces should be consistent with different screen resolutions.
• Good User Interfaces should be easily customizable.
• Good User Interfaces should, well... look nice.

In order to tackle these challenges, I took the following steps:

• Remain faithful to both Tiling Window Manager concepts and Floating Window Manager concepts through providing easy to access keybinds and panel buttons to change between different tags and Windows.
• The panel hides itself when the Super Key (Windows button on most keyboards) is not held down and the mouse is not hovering over the panel. It hides itself down to 1/40th of its regular size.
• Contains easily recognizable symbols and buttons, such as the volume, microphone, and brightness bars, the weather widget with its weather icons, and the music player with its control icons.
• This configuration uses Awesome's beautiful.xresources library to account for the dpi, or dots-per-inch, of the current display, as recognized by xrdb, to determine sizes independent of the actual screen resolution.

Gallery

Note: The following images are subject to change.

The following images use the Gruvbox-Dark GTK3+ theme:

*The Next Image is Outdated*

The following image uses the Nordic GTK3+ theme:

*The Following Images are even more Outdated*

The following images uses the Juno GTK3+ theme:

The following uses the Adwaita-Dark GTK3+ theme:

Functionality

By default, Awesomewm comes with a set of fairly sane defaults. However, many aspects of modern desktop environments are left to the user to work around or designate to external programs. As an example, the default Awesomewm config does not have any way to modify the volume of the system or display the battery life. To do so, you would need to install a third-party systray application or make a custom configuration. Another example comes in the form of the panel not hiding for fullscreen applications by default. My configuration offers the following features over the basic awesomewm config:

• On Screen Volume, Microphone Volume, and Brightness Controls
• On Screen Battery Display
• On Screen Weather provided by wttr.in
• Clickable shortcuts for common applcations (WIP)
• Buttons to swap between Virtual Desktops, or more precisely, tags.
• Built in MPD, or Music Player Daemon, Controls.
• Easily Configure Panel Settings, such as changing profile image (WIP)
• View disk usage for both home and root partitions.

TODO

• Make it possible to change/add taskbar shortcuts through GUI
• Get more colors from the GTK theming
• Add Missing Weather States from wttr.in to icon set.^WIP
• Add functionality for airplane mode, do not disturb mode, and blue light filtering mode
• Finalize Icon Set
• Make Settings panel^WIP
• Make Poweroff Prompt ^WIP
• Display current tag name in front of Tasklist.
• App Launcher
• Correct Rofi theming Rofi replaced by awesome's menu system
• Make Bars respond to click events rather than poll.
• Make MPD respond to click events rather than poll.
• Simplify & Clean Design
• Installation Playbook

Required Dependencies

Name	Comment	Reason
awesome-git	Core Window Management	Core of UI. awesome-git needed for certain features.
awestore	Asynchronous Animations	Animates numeric values
rofi	Dmenu Replacement with CSS styling	Application Launcher/Fallback Alt-Tab
sysstat	System Monitoring tool	Used for measuring CPU util.
mpc	MPD Control Program	Music Widget Controls uses this
pamixer	PulseAudio/PipeWire Volume Controller	Volume and Microphone Volume Controls use this
brightnessctl	Screen Brightness Controller	Brightness Control uses this
upower	Power Daemon	Configures Power for System & Battery widget uses this
redshift	Blue Light Filter	Used by blue light filter button on panel

***NOTE: PLEASE INSTALL WHAT YOU CAN FROM YOUR PACKAGE MANAGER FIRST***

Installation

One of my tenants for good UI is that it cannot be over overly-specialized. Overly-specialized UI's are generally amazing for what they are designed for and useless for everything else. Being useable for everyone is a core goal of the project. As such, the installation is designed to be simple with minimal dependencies.

1. Install the Dependencies
2. Clone the repository into the $HOME/.config/awesome directory. To do so, please copy the following command: git clone https://github.com/jonesad-etsu/awesomewm-config.git $HOME/.config/awesome

• Use the provided Ansible Playbook

How to Contribute

1. Download the Source.
2. Read the contents of the widget.util subdirectoris..
3. Cry
4. ????
5. Make PR
6. Profit

Credits

Made with [contributers-img](https://contrib.rocks/) [Jonesad](https://github.com/jonesad-etsu)