awesomewm/modules
Mark 459e31371f
Minor cleanup
2023-08-21 16:09:33 -07:00
..
backlight Show popup on hover 2022-11-19 10:20:15 -08:00
battery Fixed a few errors 2022-09-10 21:52:40 -07:00
ibus Added ibus hook for host interface 2022-08-03 18:04:09 -07:00
keymap_popup Cleanup 2022-11-05 08:44:42 -07:00
launcher Improve rofi config 2022-11-04 21:20:18 -07:00
lock Improved lock module 2022-11-04 10:23:41 -07:00
mpc Cleanup 2022-11-05 08:42:16 -07:00
picom Improved popups 2022-11-05 11:40:42 -07:00
screenshot Remove pdf in screenshot script 2022-08-03 18:05:24 -07:00
simple_widgets Added app icons 2022-07-23 16:27:13 -07:00
volume Minor cleanup 2023-08-21 16:09:33 -07:00
README.md Added for_each_screen module value 2022-11-05 08:08:15 -07:00

README.md

Modules

Modules are parts of this configuration that can be disabled. Nearly all features in this config are defined by a module.

Enable / Disable Modules

See config-template.lua

Organization

Every directory in modules/ is a module. Modules cannot be in subdirectories.
Each module directory MUST have an init.lua, which returns a table. That table can contain anything, but a few keys are special:

keybinds
Defines keybinds the module provides. It is automatically loaded if the module is enabled.
This MUST be a table formed by awful.key(). See ibus or screenshot for examples.

init
Called once when awesome starts if defined. Takes no arguments.

for_each_screen(s)
Called for each screen at start if defined. Takes one argument, s, the screen.