Automatic Material You Colors Generator from your wallpaper for the Plasma Desktop
Project description
🎨 KDE Material You Colors
Automatic Material You Colors Generator from your wallpaper for the Plasma Desktop
This is a Python program that uses the Python implementation of Google's Material Color Utilities to generate a Material Design 3 color scheme. Which is used to generate Light and Dark Color Themes for KDE (and pywal if installed) from your current wallpaper, automatically.
Features
Plasma specific
- Update automatically on wallpaper change
- Multiple wallpaper plugins supported
- Support for selecting Wallpaper plugin from secondary monitors
- Dark and Light Icon theme
- Support Plasma 5.26+ dark wallpaper variants
- Start automatically on login
- Make titlebar darker to match specified applications like terminals, code editors and other programs themed by pywal
- Follow Plasma Material You Dark/Light change to work with theme schedulers like Koi
- Plasma addons
- Tint SierraBreeze window decoration buttons
- TitleBar opacity control for Klassy and SierraBreezeEnhanced window decorations
- ToolBar opacity control for Lightly Application style
- Tint Klassy window decoration outline
Themeable programs
- Konsole color scheme
- opacity control
- Pywal support to theme other programs using Material You Colors
- Basic KSyntaxHighlighting support (Kate, KWrite, KDevelop...)
Theming options
- Alternative Material You color selection if the wallpaper provides more than one
- Use your favorite color to generate Material You color schemes
- Custom colors list used for konsole/pywal
- Custom amount for background color tint
- Dark/light Color schemes (Plasma and pywal/konsole independently)
- Set a script/command that will be executed on start or wallpaper/dark/light/settings change
- Configuration file
Installing
Using pypi
pip install kde-material-you-colors
# Optional
# pywal to theme other programs using Material You Colors
pip install pywal
# Colr to display colored palette and seed colors from terminal (approximate)
pip install colr
Arch Linux
- AUR use your preferred AUR helper
openSUSE Build Service packages by marknefedov
Fedora
Add repository and install as root:
dnf config-manager --add-repo https://download.opensuse.org/repositories/home:MarkNefedov/Fedora_37/home:MarkNefedov.repo
dnf install kde-material-you-colors
openSUSE
For openSUSE Tumbleweed add repository and install as root:
zypper addrepo https://download.opensuse.org/repositories/home:MarkNefedov/openSUSE_Tumbleweed/home:MarkNefedov.repo
zypper refresh
zypper install kde-material-you-colors
For openSUSE 15.4 add repository and install as root:
zypper addrepo https://download.opensuse.org/repositories/home:MarkNefedov/15.4/home:MarkNefedov.repo
zypper refresh
zypper install kde-material-you-colors
Optional features
- Install the Colr python module to display colored palette and seed colors from terminal
- Install the pywal python module to theme other programs using Material You Colors
- Check pywal Customization Wiki to theme supported programs
Running from terminal to debug your configuration
-
Run
kde-material-you-colors
-
Flags take precedence over sonfiguration file, run
kde-material-you-colors -h
to see the list of available options
Starting/Stopping Desktop entries
Run kde-material-you-colors -cl
to copy desktop entries to ~/.local/share/applications/
- To start the program launch KDE Material You Colors from your applications list
- To stop it launch Stop KDE Material You Colors from your applications list
Running on Startup
After finishing the setup, you can make it run automatically on boot
-
Copy the default configuration to ~/.config/kde-material-you-colors/config.conf:
kde-material-you-colors -c
-
Set the program to automatically start with Plasma:
kde-material-you-colors -a
-
Reboot or logout/login and test the changes
Removing from autostart
- Open
System Settings
>Startup and Shutdown
- Remove
kde-material-you-colors
by clicking on the-
button.
Supported Wallpaper plugins
Wallpaper plugins must store the current wallpaper in ~/.config/plasma-org.kde.plasma.desktop-appletsrc
Confirmed working Plasma Wallpaper Plugins:
Name | ID |
---|---|
Image (default) | org.kde.image |
Picture of the day | org.kde.potd |
Slideshow | org.kde.slideshow |
Plain color | org.kde.color |
Conway's Game of Life (cell color) | org.kde.plasma.gameoflife |
Active blur | a2n.blur |
Configuration file
- Copy default configuration: run
kde-material-you-colors -c
- Edit ~/.config/kde-material-you-colors/config.conf
- Run
kde-material-you-colors
with no arguments from terminal to test it. - You can view the sample configuration file here
Notes
- To update color with
plasma-apply-colorscheme
(utility provided by plasma developers), the file containing the new color scheme must have a different name than the current one, to workaround this the program creates two scheme files with different names, then applies one after the other. As a result you end up with duplicated color schemes and maybe some lag while updating schemes.
Bug reporting / Feature requests / Contributing
Please read the Contributing guidelines in this repository
Thanks & Credits
- Avanish Subbiah for the Python implementation of Material Color Utilities required by this project.
- This comment by throwaway6560192 on Reddit and @pashazz (Pavel Borisov) ksetwallpaper for the script to get the current Wallpaper that served me as starting point.
- Everyone that made material-color-utilities possible.
- Pywal developers
- Albert Ragány-Németh for the C# implementation of Material Color Utilities (used until v0.8.0).
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 kde-material-you-colors-1.5.1.post9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6633a1cd4800f5a85ea418e40f040a9da5ca5b8002b0232277533945e198c5d |
|
MD5 | 4d1eeb6ff8af191113c9914c52a04d45 |
|
BLAKE2b-256 | b15b21fde68ca626d7d876a21632ed9fe377af68bf3bb2a7c12574c32c8d5465 |
Hashes for kde_material_you_colors-1.5.1.post9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f992ea87c5ecbaa2074b83c67d93b9e39d6078eb48edfdfa128360c4312c590 |
|
MD5 | e6044897fb4d02150e4212c7a48499c6 |
|
BLAKE2b-256 | 951aa63737b440275d86b9f49e212564e1f696d12009a5040cd1991bf83b2aed |