Skip to content

Modules

Federico Di Pierro edited this page Nov 1, 2020 · 11 revisions

Every functionality in clight is achieved through a "module". An inter-modules dependencies system has been created ad-hoc to ease development of such modules.
This way, it does not matter modules' init calls sorting; moreover, each module can be easily disabled if not needed/desired.

Default Enabled Modules

By default Clight enables all its functions, fallbacking to disable them where they are not supported. This means that these features are all enabled by default:

  • BRIGHTNESS: to make webcam captures and change screen backlight level to match ambient brightness
  • KEYBOARD: to manage keyboard backlight based on ambient brightess
  • DIMMER: to dim screen after a certain idle time
  • GAMMA: to change screen temperature based on current time of day
  • DPMS: to switch off screen after a certain idle time
  • SCREEN: to compute screen-emitted brightness and compensate for it. Enabled by default only on AC
Module Xorg Wayland TTY
BRIGHTNESS
KEYBOARD
DIMMER
GAMMA
DPMS
SCREEN

BRIGHTNESS, KEYBOARD and DIMMER are screen-server agnostic.

All these features can be turned off through cmdline and config file options.

Wayland support

Both DPMS and GAMMA require specific wayland protocols implemented in your compositor; give a look at clightd wiki pages:

Clone this wiki locally