AWM Kmodules

AWM Kmodules is a collection of small modules for AwesomeWM 4. These modules can be loaded individually.

Getting Started

Just clone it in your awesome configuration dir (usually ~/.config/awesome/) and require it in your rc.lua with require("awm_kmodules")
Each module can be loaded individually, the return value when loading the module is the return value of the require(module) function:

local my_modules = require("awm_kmodules")
my_modules("awm_brightness") -- Brightness
my_modules("awm_kborderless") -- Remove borders
local focus_gradient_border_fun = my_modules("awm_focus_gradient_border")

You can also clone them individually with git sparse

git clone --filter=blob=none --sparse https://github.com/Kuroneer/awm_kmodules
cd awm_kmodules
git sparse-checkout set init.lua awm_kborderless awm_titleless

For an explaination of the different modules, continue reading.

AWM Brightness

AWM Brightness is a really simple module to handle brightness with xbacklight, reporting the value with a highly customizable notification.

The default values for a notification like

are:

local brightness = require("awm_brightness") -- If awm_brightness.lua is directly in the config dir
local brightness = require("awm_kmodules")("awm_brightness")

brightness.brightness_step = 5
brightness.notification_text = {
    head = '☼ <span weight="bold">[',
    symbol_active = "#",
    symbol_inactive = " ",
    tail = "]</span> "
}
brightness.notification_defaults = {
    timeout = 2,
    border_width = 1,
    ignore_suspend = true,
}

(This module automatically hooks to the XF86MonBrightness* keys)

AWM DBusXrandr

AWM DBusXrandr is a module that provides a function to iterate over different xrandr configurations and listens to dbus events to automatically enable and disable screens upon connection.

It was largely inspired by http://awesome.naquadah.org/wiki/Using_Multiple_Screens (it builds the xrandr command and reports the selected setup in a similar way)

In order to achieve UDEV + DBUS integration, you need an udev rule like this:

$ cat /etc/udev/rules.d/95-monitor-hotplug.rules
KERNEL=="card[0-9]*", SUBSYSTEM=="drm", RUN+="/usr/bin/dbus-send --system --type=signal / org.custom.screen_change.screen_changed"

You can iterate over the configurations by calling the value returned when requiring this module:

local xrandr_setup_iter = require("awm_dbusxrandr") -- If awm_dbusxrandr.lua is directly in the config dir
local xrandr_setup_iter = require("awm_kmodules")("awm_dbusxrandr")

xrandr_setup_iter()

(This module automatically hooks that call to the XF86Display key)

If you'd rather have a different script in charge of setting up the screens on dbus event, you can use:

xrand_setup_iter.trigger_command_path = "~/.screen_layout_changed"

This path will be called with the connected screens as an argument (comma-separated)

You have some more config options, please check the first lines of the file

AWM Focus Gradient Border

AWM Focus Gradient Border is a module that applies a gradient over time to the focused client border color.

You can see the module in action in this video

You can customize it with values provided to the function returned by the require:

local focus_gradient_border_fun = require("awm_focus_gradient_border") -- If awm_focus_gradient_border.lua is directly in the config dir
local focus_gradient_border_fun = require("awm_kmodules")("awm_focus_gradient_border")

-- OPTION 1:
-- Focus starts with color border_focus but fades into border_normal
-- Fading stays, but faster, when unfocused
focus_gradient_border_fun("focus", {
    origin_color = beautiful.border_focus,
    target_color = beautiful.border_normal
})

-- OPTION 2:
-- Focus show briefly in blue before turning to border_focus
focus_gradient_border_fun("focus", {
    origin_color = "#109FFF",
    target_color = beautiful.border_focus,
    elapse_time = .6
})
-- When a client loses focus, change to border_normal from its current border color
focus_gradient_border_fun("unfocus", {target_color = beautiful.border_normal})

This plugin allows callbacks instead of target_color, the callback will be called with the client as argument.

AWM KBorderless

AWM KBorderless is a simple module that removes borders from clients when they are redundant (for example, when maximized or when that client is the only visible one)

You can provide callbacks to this module so it won't change anything about a client if it returns true for on its manage signal

local my_modules = require("awm_kmodules")
my_modules("awm_kborderless")(function(c) return othermodule:is_othermodule_client(c) end)

AWM Ti[t]leless

AWM Ti[t]leless is a really simple module that shows the title only on floating windows (and activates ontop).

You can provide callbacks to this module so it won't change anything about a client if it returns true for on its manage signal

local my_modules = require("awm_kmodules")
my_modules("awm_titleless")(function(c) return othermodule:is_othermodule_client(c) end)

AWM Simple Amixer Volume

AWM Simple Amixer Volume is a really simple widget to track the volume with amixer. It hooks to global XF86 keys.

local my_modules = require("awm_kmodules")
local volume_widget = my_modules("awm_simple_amixer_volume")

AWM Simple Pactl Volume

AWM Simple Pactl Volume is a really simple widget to track the volume with pactl. It hooks to global XF86 keys.

local my_modules = require("awm_kmodules")
local volume_widget = my_modules("awm_simple_pactl_volume")

AWM Simple Pacman Widget

AWM Simple Pacman Widget is a really simple widget that stays hidden checking whether there are updates or not, displaying a ! if there are updates available.

local my_modules = require("awm_kmodules")
local pacman_update = my_modules("awm_simple_pacman_widget")

AWM Distributed Tags

AWM Distributed Tags is a module for AwesomeWM 4 to redistribute the tags among the available screens and move them when new screens are added or removed.

local my_modules = require("awm_kmodules")
my_modules("awm_distributed_tags")

AWM Battery Widget

AWM Battery Widget is a widget for AwesomeWM 4 that monitors the battery status through upower. It hooks to the UPower DBus events.

local my_modules = require("awm_kmodules")
local battery_widget = my_modules("awm_battery_widget")

AWM Playerctl

AWM playerctl is a module for AwesomeWM 4 that monitors the list of players reported by playerctl and directs the XF86 media keys to the most recently used player.

local my_modules = require("awm_kmodules")
my_modules("awm_playerctl")

AWM FZF Launcher

AWM FZF Launcher displays a client on the screen with FZF to launch any executable in the $PATH, it includes taskbar clients for easy switching.

local my_modules = require("awm_kmodules")
local awm_fzf_launcher = my_modules("awm_fzf_launcher")
-- Show the launcher:
awm_fzf_launcher()

AWM Locker

AWM Locker listens to loginctl lock-session event in dbus and spawns the provided locker command

my_modules("awm_locker")("slock")

Authors

• Jose M Perez Ramos - Kuroneer

License

This project is released under the GPLv3. Check LICENSE for more information.