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
Arch Linux
- AUR use your preferred AUR helper
openSUSE Build Service packages by @markusgod
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
Other distributions/manual install
Expand
- Clone/download this repository and cd to it
git clone https://github.com/luisbocanegra/kde-material-you-colors --branch main
cd kde-material-you-colors
- Make the installer executable and run it as root
For Ubuntu based distros:
chmod +x install-ubuntu-based.sh
sudo ./install-ubuntu-based.sh
For Fedora based distros:
chmod +x install-fedora-based.sh
sudo ./install-fedora-based.sh
Updating
Fetch latest changes:
cd kde-material-you-colors
git pull
Repeat step 2
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
from terminal, this should change your Desktop colors right after.
NOTE: Without any configuration/arguments your wallpaper will be reset to Image Wallpaper Plugin
Options
- Run
kde-material-you-colors -h
to see the list of available options
Desktop entries
- To start/restart the program launch KDE Material You Colors from your applications list
- To stop it launch Stop KDE Material You Colors from your applications list
Startup script
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,
NOTE: your wallpaper will be reset to Image Wallpaper Plugin
Removing the autostart script
- Open
System Settings
>Startup and Shutdown
- Remove
kde-material-you-colors
by clicking on the-
button.
Changing Current Wallpaper plugin
Use the configuration file !!
Using Plasma Wallpaper Settings may Crash Plasmashell and will set again the plugin from Configuration file
Working Wallpaper plugins
This is a list of compatible 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 |
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
File details
Details for the file kde-material-you-colors-1.5.1.tar.gz
.
File metadata
- Download URL: kde-material-you-colors-1.5.1.tar.gz
- Upload date:
- Size: 52.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 867c591a31b80b052f1f3e1bbdad7e0e5648d64c0c838b4019346e7a4e858d38 |
|
MD5 | d345a6eeccf07769433e3e6f58b1fd51 |
|
BLAKE2b-256 | 4b857752d27690731fe5f7a0ea58ae71f669c5010fa5e334fa11fd15d35460ae |
File details
Details for the file kde_material_you_colors-1.5.1-py3-none-any.whl
.
File metadata
- Download URL: kde_material_you_colors-1.5.1-py3-none-any.whl
- Upload date:
- Size: 56.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a996983e788f0d2fb6a91d87e167e0be521c9c26216e35aff37ed7f8a36c90d |
|
MD5 | 911294c521513c1a0ecd2c1725b25849 |
|
BLAKE2b-256 | 995869edc9e5f429c37fede4021e462b2a21a467d694385531108558d959aec0 |