Skip to content

Latest commit

 

History

History
103 lines (79 loc) · 4.81 KB

README.md

File metadata and controls

103 lines (79 loc) · 4.81 KB
Raw

xsct-cake

Interface for xsct written in POSIX compliant shell-script.
Intended to be used as a simple and minimal alternative to other blue light filters / night modes.
Designed with polybar integration in mind.

Two files are created in ~/.cache/

  • xsct.tempk - Stores the current xsct Kelvin value
  • xsct.state - Stores the ON/OFF state

logo Logo font: https://velvetyne.fr/fonts/resistance/

High Quality Demo

High Quality Demo

Dependencies

Installation

Just git clone this repo and move the file xsct-cake to any location of your choice.
For example:

git clone https://github.com/edermats32/xsct-cake.git && \
cp ./xsct-cake/xsct-cake ~/.local/bin/xsct-cake

You also need to make it executable:

chmod +x ~/.local/bin/xsct-cake

Usage

The xsct-cake parameters do not start with a - in order to distinguish them from the xsct ones.
Only one parameter can be used at a time (only the first parameter is read).

Command Explanation
xsct-cake init Only creates the files xsct.tempk and xsct.state in ~/.cache (all other commands will also do this)
xsct-cake print Prints the current value in ~/.cache/xsct.tempk if ~/.cache/xsct.state is ON else it prints "OFF"
xsct-cake tail Same as xsct-cake print but will continuously print on every value and state change
xsct-cake restore Sets xsct to the value stored in ~/.cache/xsct.tempk
xsct-cake toggle Turns the state ON/OFF (not the same as xsct --toggle)
____________________

All xsct can of course also be used. See https://github.com/faf0/sct/

Example

Assuming xsct-cake is in ~/.local/bin/xsct-cake

Polybar

~/.config/polybar/config.ini

[module/xsct]
type = custom/script
exec = ~/.local/bin/xsct-cake tail # Look for value and state changes

tail = true # Don't worry, this will not blow up your CPU (hopefully)

click-left = ~/.local/bin/xsct-cake toggle      # Turn ON/OFF
scroll-up = ~/.local/bin/xsct-cake -d 300 1     # Increase by 300K
scroll-down = ~/.local/bin/xsct-cake -d -300 1  # Decrease by 300K

label = "XSCT %output%"
# If you have a NerdFont, a good glyph is [f0594]:
# label = "󰖔 %output%"

bspwm

~/.config/bspwm/bspwmrc

~/.local/bin/xsct-cake restore & # Restores the previous temperature

sxhkd

~/.config/sxhkd/sxhkdrc

super + XF86AudioRaiseVolume
        ~/.local/bin/xsct-cake -d 300 1    # Increase by 300K

super + XF86AudioLowerVolume
        ~/.local/bin/xsct-cake -d -300 1   # Decrease by 300K

super + XF86AudioMute
        ~/.local/bin/xsct-cake toggle      # Turn ON/OFF

Comparison to other Blue Light Filters (table base copied from blugon repo)

xsct-cake blugon Redshift f.lux
written in POSIX SHELL Python C closed source
interface CLI CLI CLI or GUI GUI
timing configuration nope user defined day and night day and night
gamma configuration yep, temperature RGB values or temperature temperature temperature
brightness configuration nope, maybe in future none none none
has to do with cake 🍰😋 nope nope nope probably not