No project description provided
Project description
Hyprshade
Frontend to Hyprland's screen shader feature
Description
Hyprshade takes full advantage of Hyprland's decoration:screen_shader
feature
by automating the process of switching screen shaders, either from a user-defined
schedule or on the fly. It can be used as a replacement[^1] for apps that adjust
the screen's color temperature such as f.lux,
redshift, or gammastep
with blue-light-filter
, which is installed by default.
[^1]: Gradual color shifting currently unsupported.
Installation
Arch Linux
Use your favorite AUR helper (e.g. paru):
paru -S hyprshade
Or manually:
sudo pacman -S --needed base-devel
git clone https://aur.archlinux.org/hyprshade.git
cd hyprshade
makepkg -si
Other
If your distribution isn't officially supported, you can also install directly from PyPI with pip:
pip install --user hyprshade
Or with pipx:
pipx install hyprshade
Usage
Hyprshade uses the shader files in your ~/.config/hypr/shaders
directory
(in addition to the ones installed to /usr/share/hyprshade
) for all of its commands.
Scheduling
To have specific shaders enabled during certain periods of the day, you can
create a config file in either ~/.config/hypr/hyprshade.toml
or ~/.config/hyprshade/config.toml
.
[[shades]]
name = "vibrance"
default = true # shader to use during times when there is no other shader scheduled
[[shades]]
name = "blue-light-filter"
start_time = 19:00:00
end_time = 06:00:00 # optional if you have more than one shade with start_time
For starters, you can copy the example config:
cp /usr/share/hyprshade/examples/config.toml ~/.config/hypr/hyprshade.toml
After writing your config, install the systemd timer/service files and enable the timer:
hyprshade install
systemctl --user enable --now hyprshade.timer
hyprshade install
must be run after updatinghyprshade.toml
.
By default, they are installed to ~/.config/systemd/user
as user units.
You also probably want the following line in your hyprland.conf
:
exec = hyprshade auto
This ensures that the correct shader is enabled when you log in.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hyprshade-0.6.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59d95fee63ba69ed4339d708301da4de73499b0f58c5de6b0dbb4f74b355636c |
|
MD5 | 1eac1d4f4dfcad85058c94e2370e6e75 |
|
BLAKE2b-256 | f653ea2b13e57f2252984a1f3037464b22f2b13d664195be4ebdab91147e38b9 |