Automatic Material You Colors Generator from your wallpaper for the Plasma Desktop
Project description
🎨 KDE Material You Colors
Automatically generate Light/Dark Color Themes for KDE (and pywal if installed) from your current wallpaper, using Python implementation of Google's Material Color Utilities
Features
Plasma specific
- Plasma Widget
- Support for all Wallpaper plugins (color, image, slideshows, animated, Plasma 5.26+ dark wallpaper variants)
- Update automatically on wallpaper change
- Change icon themes
- 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
Plasma widget
Install from the KDE Store
- Right click on panel > Add Widgets > Get New Widgets > Download New Plasma Widgets
- Search for "KDE Material You Colors"
Backend (MANDATORY)
Using pypi with pipx
(recommended) or pip
pipx install kde-material-you-colors
# Optional
# pywal to theme other programs using Material You Colors
pipx install pywal
Arch Linux
- AUR use your preferred AUR helper
Optional features
- 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 configuration file, run
kde-material-you-colors -h
to see the list of available options
Starting/Stopping Desktop entries
If not installed by your package manager, 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.
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. -
The wallpaper is obtained in the following order:
-
First, uses the Plasma Desktop Scripting API to read Wallpaper plugin configuration.
-
If the previous fails it uses the KWin Scripting API and KWin's Screenshot plugin to take a Screenshot of the Desktop view
-
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). Google LLC. / Pictogrammers for the widget icon
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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 950022d35248849f9245c03afdc81f4d8dcb30f13cc5c9c780663004791a6695 |
|
MD5 | 95e2ccf89845f8d4fe7a5fa0aaedf4b0 |
|
BLAKE2b-256 | 33324a6e854c392d3b0cd725a87ba9a59593368b17c54063465017e238f5a587 |
Hashes for kde_material_you_colors-1.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c97f066198d3788a27604379c6b2798f2060e57dbde5935e8d22705f5dafd996 |
|
MD5 | 436b850d06dae7ca306c2438bfd5329a |
|
BLAKE2b-256 | ff6955bf094a1de309580aa198188d121805fbd7e802971093fe3c988e95c2f9 |