awesomewm/modules
Mark 9da54839fb
Added modules readme
2022-07-16 18:00:58 -07:00
..
backlight Misc cleanup 2022-07-16 17:41:00 -07:00
battery Misc cleanup 2022-07-16 17:41:00 -07:00
i3lock Misc cleanup 2022-07-16 17:41:00 -07:00
ibus Started migrating to module architecture 2022-07-16 14:13:03 -07:00
launcher Misc cleanup 2022-07-16 17:41:00 -07:00
mpc Started migrating to module architecture 2022-07-16 14:13:03 -07:00
screenshot Misc cleanup 2022-07-16 17:41:00 -07:00
simple_widgets More cleanup 2022-07-16 17:18:27 -07:00
volume More cleanup 2022-07-16 17:18:27 -07:00
README.md Added modules readme 2022-07-16 18:00:58 -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.

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 audomatically loaded if the module is enabled.
This MUST be a table formed by awful.key(). See ibus or screenshot for examples.

init
Defines an init method. This is called once when awesome starts.