| Name | kde-material-you-colors JSON |
| Version |
1.10.0
JSON |
| download |
| home_page | None |
| Summary | Automatic Material You Colors Generator from your wallpaper for the Plasma Desktop |
| upload_time | 2025-01-13 10:10:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
# 🎨 KDE Material You Colors
<img src="https://github.com/luisbocanegra/kde-material-you-colors/assets/15076387/6bd4e04a-48a7-48bc-8dd1-3a75524cd10e" alt="Screenshot" height="250px">
Automatically generate light/dark color themes for KDE (and pywal if installed) from your current wallpaper, using [@T-Dynamos Python implementation](https://github.com/T-Dynamos/materialyoucolor-python) of Google's [Material Color Utilities](https://github.com/material-foundation/material-color-utilities)
[](https://aur.archlinux.org/packages/kde-material-you-colors)
[](https://pypi.org/project/kde-material-you-colors/)
[](https://store.kde.org/p/2136963)
</div>
[](https://user-images.githubusercontent.com/15076387/188578458-8171e42b-f36c-44c1-9eb0-506c301d4f16.gif)
## Features
### Plasma specific
- [Plasma Widget](https://store.kde.org/p/2136963) (Plasma 6 version)
- 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](https://github.com/baduhai/Koi)
- **Plasma addons**
- Tint [SierraBreeze](https://github.com/kay0u/SierraBreeze) window decoration buttons
- TitleBar opacity control for [Klassy](https://github.com/paulmcauley/klassy) and [SierraBreezeEnhanced](https://github.com/kupiqu/SierraBreezeEnhanced) window decorations
- ToolBar opacity control for [Lightly](https://github.com/Luwx/Lightly) Application style
- Tint [Klassy](https://github.com/paulmcauley/klassy) window decoration outline
### Themeable programs
- Konsole color scheme
- opacity & blur 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 colorfulness and brightness of theme
- Color scheme variants from Material You (Vibrant, Monochrome, Neutral...)
- Dark/light Color schemes (Plasma and pywal/konsole independently)
- Set a script that will be executed on start or wallpaper/dark/light/settings change
- Configuration file
## Installing
- Arch Linux [AUR](https://aur.archlinux.org/packages/kde-material-you-colors) use your preferred AUR helper (e.g `yay -S kde-material-you-colors`)
- openSUSE Tumbleweed, Fedora 40/41/Rawhide see [openSUSE Build Service repositories](https://software.opensuse.org//download.html?project=home%3Aluisbocanegra&package=kde-material-you-colors). These might break from time to time, reach out to me if you want to help maintaining them.
### Manual install
1. Install `pipx` system packages from your distribution packages.
2. Install the backend
**For Plasma 5** this is the last version, development has switched to plasma 6
```sh
pipx install kde-material-you-colors==1.7.1
pipx inject kde-material-you-colors pywal
```
**For Plasma 6**
```sh
pipx install kde-material-you-colors
pipx inject kde-material-you-colors pywal16
# to upgrade to newer version
pipx upgrade kde-material-you-colors
```
**Note:** You may need to install `gcc python-dbus-dev libglib2.0-dev` system packages or their equivalent for your distribution. Additionally, installing some libraries for Pillow may be necessary, see [Pillow docs](https://pillow.readthedocs.io/en/latest/installation.html#external-libraries)
3. Install the widget from the KDE Store [Plasma 6 version](https://store.kde.org/p/2136963) | [Plasma 5 version](https://www.pling.com/p/2073783/)
1. **Right click on the Panel** > **Add Widgets** > **Get New Widgets** > **Download New Plasma Widgets**
2. **Search** for "**KDE Material You Colors**", install & add it to your Panel/Desktop.
4. Install the screenshot helper. **Optional but recommended if you use other than default Image wallpaper plugin**
**Plasma 6**
Install `git extra-cmake-modules` system packages or their equivalent for your distribution.
```sh
git clone https://github.com/luisbocanegra/kde-material-you-colors
./install-screenshot-helper.sh
```
**NOTE:** Helper is now installed with `/usr` prefix, reboot if you get `The process is not authorized to take a screenshot` error
**Plasma 5**
Install `git extra-cmake-modules` system packages or their equivalent for your distribution.
```sh
git clone https://github.com/luisbocanegra/kde-material-you-colors -b plasma5
./install-screenshot-helper.sh
```
To upgrade to a new version repeat these steps.
**Note:** When you upgrade te widget to a newer version it will inform you if it requires a new version of the backend.
## Running
You can Start and change the configuration from the widget.
### From terminal
```sh
kde-material-you-colors
```
Run `kde-material-you-colors -h` to see the list of available options (Flags take precedence over configuration file)
### Starting/Stopping Desktop entries
**If not installed by your package manager**, run `kde-material-you-colors -cl`
- To start the program launch **KDE Material You Colors** from your applications list
- To stop, launch **Stop KDE Material You Colors** from your applications list
### Running on Startup
```sh
kde-material-you-colors -a
```
#### Removing from autostart
1. Open **System Settings** > **Autostart**
2. Remove **kde-material-you-colors** by clicking on the **Trash** button.
## Configuration file
The preferred way to change the configuration is from the widget. If the configuration doesn't exist, it will be automatically created by the widget.
**Editing manually**
The default configuration file can be created by running `kde-material-you-colors -c` the location is `~/.config/kde-material-you-colors/config.conf`
Run `kde-material-you-colors` with no arguments from terminal to test your changes in real time.
Due to Qt limitations, comments are removed from the configuration file by the widget. **You can view the sample configuration file with comments [here](https://github.com/luisbocanegra/kde-material-you-colors/blob/main/src/kde_material_you_colors/data/sample_config.conf)**.
## FAQ
**Q.** How does this different from Plasma's "**Accent Color From Wallpaper**" and "**Tint all colors with accent color**"?
There are some key differences:
- Brighter accent/buttons colors
- Option to choose another color if the wallpaper returns more than one
- Can also apply colors to Konsole and pywal (both from wallpaper and custom ones)
- Colors comparison https://imgur.com/a/a28uZka (kde-material-you-colors top, default tint option bottom)
**Q.** Why there are duplicated color schemes in **System Settings**
To update color with `plasma-apply-colorscheme` (utility provided by KDE developers), the file containing the new color scheme must have a different name than the current one, to workaround that, this program creates two color 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.
**Q.** Can't get wallpaper colors of the default wallpaper
If you are using the default Image wallpaper plugin try changing the image to something else at least once first.
**Q.** Slideshow wallpaper (or any other Plugin) doesn't update colors correctly
Try enabling **Only use screenshot method** from the widget **Advanced settings**
**Q.** How does wallpaper detection work and why it fails sometimes?
The wallpaper is obtained in the following order:
- First, uses the [Plasma Desktop Scripting API](https://develop.kde.org/docs/plasma/scripting/api/) to read Wallpaper plugin configuration.
- If the previous fails, the screenshot helper (if installed) is used
The backend uses the [KWin Scripting API](https://develop.kde.org/docs/plasma/kwin/api/) and calls the screenshot helper to take a Screenshot of the Desktop view using the [KWin's Screenshot plugin](https://github.com/KDE/kwin/tree/master/src/plugins/screenshot)
Both methods are somewhat robust but there are edge cases when detection will fail, which are [explained here](https://github.com/luisbocanegra/kde-material-you-colors/issues/187)
## Bug reporting / Feature requests / Contributing
Please read the [Contributing guidelines in this repository](https://github.com/luisbocanegra/kde-material-you-colors/blob/main/CONTRIBUTING.md)
## Support the development
- If you like the project please consider donating/sponsoring this and [my other open source work](https://github.com/luisbocanegra?tab=repositories&q=&type=source&language=&sort=stargazers)
[](https://github.com/sponsors/luisbocanegra) [](https://ko-fi.com/luisbocanegra) [](https://www.buymeacoffee.com/luisbocanegra) [](https://liberapay.com/luisbocanegra/) [](https://www.paypal.com/donate/?hosted_button_id=Y5TMH3Z4YZRDA)
- [Give it a star on GitHub](https://aur.archlinux.org/packages/kde-material-you-colors)
- Rate / leave review in the [KDE Store](https://store.kde.org/p/2136963)
## Acknowledgements
- [materialyoucolor-python](https://github.com/T-Dynamos/materialyoucolor-python) Python Implementation of Material Color Utilities used by this project.
- [Pywal16](https://github.com/eylles/pywal16) to apply material colors to pywal supported software
- [xdg-desktop-portal-kde](https://invent.kde.org/plasma/xdg-desktop-portal-kde) base for desktop screenshot helper.
- [kdotool](https://github.com/jinliu/kdotool) base for getting desktop window id.
- [ksetwallpaper](https://github.com/pashazz/ksetwallpaper) code to get the current Wallpaper that served me as inspiration.
- [Google LLC. / Pictogrammers](https://pictogrammers.com/library/mdi/) widget icon assets.
Raw data
{
"_id": null,
"home_page": null,
"name": "kde-material-you-colors",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Luis Bocanegra <luisbocanegra17b@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f2/e0/77b4ec29b1a2b54b83a1e4ea39e89df231f5a57ac80f9ff56c8b3354708c/kde_material_you_colors-1.10.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# \ud83c\udfa8 KDE Material You Colors\n\n<img src=\"https://github.com/luisbocanegra/kde-material-you-colors/assets/15076387/6bd4e04a-48a7-48bc-8dd1-3a75524cd10e\" alt=\"Screenshot\" height=\"250px\">\n\nAutomatically generate light/dark color themes for KDE (and pywal if installed) from your current wallpaper, using [@T-Dynamos Python implementation](https://github.com/T-Dynamos/materialyoucolor-python) of Google's [Material Color Utilities](https://github.com/material-foundation/material-color-utilities)\n\n[](https://aur.archlinux.org/packages/kde-material-you-colors)\n[](https://pypi.org/project/kde-material-you-colors/)\n[](https://store.kde.org/p/2136963)\n\n</div>\n\n[](https://user-images.githubusercontent.com/15076387/188578458-8171e42b-f36c-44c1-9eb0-506c301d4f16.gif)\n\n## Features\n\n### Plasma specific\n\n- [Plasma Widget](https://store.kde.org/p/2136963) (Plasma 6 version)\n- Support for all Wallpaper plugins (color, image, slideshows, animated, Plasma 5.26+ dark wallpaper variants)\n- Update automatically on wallpaper change\n- Change icon themes\n- Start automatically on login\n- Make titlebar darker to match specified applications like terminals, code editors and other programs themed by pywal\n- Follow Plasma Material You Dark/Light change to work with theme schedulers like [Koi](https://github.com/baduhai/Koi)\n- **Plasma addons**\n - Tint [SierraBreeze](https://github.com/kay0u/SierraBreeze) window decoration buttons\n - TitleBar opacity control for [Klassy](https://github.com/paulmcauley/klassy) and [SierraBreezeEnhanced](https://github.com/kupiqu/SierraBreezeEnhanced) window decorations\n - ToolBar opacity control for [Lightly](https://github.com/Luwx/Lightly) Application style\n - Tint [Klassy](https://github.com/paulmcauley/klassy) window decoration outline\n\n### Themeable programs\n\n- Konsole color scheme\n - opacity & blur control\n- Pywal support to theme other programs using Material You Colors\n- Basic KSyntaxHighlighting support (Kate, KWrite, KDevelop...)\n\n### Theming options\n\n- Alternative Material You color selection if the wallpaper provides more than one\n- Use your favorite color to generate Material You color schemes\n- Custom colors list used for konsole/pywal\n- Custom amount for colorfulness and brightness of theme\n- Color scheme variants from Material You (Vibrant, Monochrome, Neutral...)\n- Dark/light Color schemes (Plasma and pywal/konsole independently)\n- Set a script that will be executed on start or wallpaper/dark/light/settings change\n- Configuration file\n\n## Installing\n\n- Arch Linux [AUR](https://aur.archlinux.org/packages/kde-material-you-colors) use your preferred AUR helper (e.g `yay -S kde-material-you-colors`)\n\n- openSUSE Tumbleweed, Fedora 40/41/Rawhide see [openSUSE Build Service repositories](https://software.opensuse.org//download.html?project=home%3Aluisbocanegra&package=kde-material-you-colors). These might break from time to time, reach out to me if you want to help maintaining them.\n\n### Manual install\n\n1. Install `pipx` system packages from your distribution packages.\n\n2. Install the backend\n\n **For Plasma 5** this is the last version, development has switched to plasma 6\n\n ```sh\n pipx install kde-material-you-colors==1.7.1\n pipx inject kde-material-you-colors pywal\n ```\n\n **For Plasma 6**\n\n ```sh\n pipx install kde-material-you-colors\n pipx inject kde-material-you-colors pywal16\n # to upgrade to newer version\n pipx upgrade kde-material-you-colors\n ```\n\n **Note:** You may need to install `gcc python-dbus-dev libglib2.0-dev` system packages or their equivalent for your distribution. Additionally, installing some libraries for Pillow may be necessary, see [Pillow docs](https://pillow.readthedocs.io/en/latest/installation.html#external-libraries)\n\n3. Install the widget from the KDE Store [Plasma 6 version](https://store.kde.org/p/2136963) | [Plasma 5 version](https://www.pling.com/p/2073783/)\n\n 1. **Right click on the Panel** > **Add Widgets** > **Get New Widgets** > **Download New Plasma Widgets**\n 2. **Search** for \"**KDE Material You Colors**\", install & add it to your Panel/Desktop.\n\n4. Install the screenshot helper. **Optional but recommended if you use other than default Image wallpaper plugin**\n\n **Plasma 6**\n\n Install `git extra-cmake-modules` system packages or their equivalent for your distribution.\n\n ```sh\n git clone https://github.com/luisbocanegra/kde-material-you-colors\n ./install-screenshot-helper.sh\n ```\n\n **NOTE:** Helper is now installed with `/usr` prefix, reboot if you get `The process is not authorized to take a screenshot` error\n\n **Plasma 5**\n\n Install `git extra-cmake-modules` system packages or their equivalent for your distribution.\n\n ```sh\n git clone https://github.com/luisbocanegra/kde-material-you-colors -b plasma5\n ./install-screenshot-helper.sh\n ```\n\nTo upgrade to a new version repeat these steps.\n\n**Note:** When you upgrade te widget to a newer version it will inform you if it requires a new version of the backend.\n\n## Running\n\nYou can Start and change the configuration from the widget.\n\n### From terminal\n\n```sh\nkde-material-you-colors\n```\n\nRun `kde-material-you-colors -h` to see the list of available options (Flags take precedence over configuration file)\n\n### Starting/Stopping Desktop entries\n\n**If not installed by your package manager**, run `kde-material-you-colors -cl`\n\n- To start the program launch **KDE Material You Colors** from your applications list\n- To stop, launch **Stop KDE Material You Colors** from your applications list\n\n### Running on Startup\n\n```sh\nkde-material-you-colors -a\n```\n\n#### Removing from autostart\n\n1. Open **System Settings** > **Autostart**\n2. Remove **kde-material-you-colors** by clicking on the **Trash** button.\n\n## Configuration file\n\nThe preferred way to change the configuration is from the widget. If the configuration doesn't exist, it will be automatically created by the widget.\n\n**Editing manually**\n\nThe default configuration file can be created by running `kde-material-you-colors -c` the location is `~/.config/kde-material-you-colors/config.conf`\n\nRun `kde-material-you-colors` with no arguments from terminal to test your changes in real time.\n\nDue to Qt limitations, comments are removed from the configuration file by the widget. **You can view the sample configuration file with comments [here](https://github.com/luisbocanegra/kde-material-you-colors/blob/main/src/kde_material_you_colors/data/sample_config.conf)**.\n\n## FAQ\n\n**Q.** How does this different from Plasma's \"**Accent Color From Wallpaper**\" and \"**Tint all colors with accent color**\"?\n\nThere are some key differences:\n\n- Brighter accent/buttons colors\n- Option to choose another color if the wallpaper returns more than one\n- Can also apply colors to Konsole and pywal (both from wallpaper and custom ones)\n- Colors comparison https://imgur.com/a/a28uZka (kde-material-you-colors top, default tint option bottom)\n\n**Q.** Why there are duplicated color schemes in **System Settings**\n\nTo update color with `plasma-apply-colorscheme` (utility provided by KDE developers), the file containing the new color scheme must have a different name than the current one, to workaround that, this program creates two color 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.\n\n**Q.** Can't get wallpaper colors of the default wallpaper\n\nIf you are using the default Image wallpaper plugin try changing the image to something else at least once first.\n\n**Q.** Slideshow wallpaper (or any other Plugin) doesn't update colors correctly\n\nTry enabling **Only use screenshot method** from the widget **Advanced settings**\n\n**Q.** How does wallpaper detection work and why it fails sometimes?\n\nThe wallpaper is obtained in the following order:\n\n- First, uses the [Plasma Desktop Scripting API](https://develop.kde.org/docs/plasma/scripting/api/) to read Wallpaper plugin configuration.\n- If the previous fails, the screenshot helper (if installed) is used\n\nThe backend uses the [KWin Scripting API](https://develop.kde.org/docs/plasma/kwin/api/) and calls the screenshot helper to take a Screenshot of the Desktop view using the [KWin's Screenshot plugin](https://github.com/KDE/kwin/tree/master/src/plugins/screenshot)\n\nBoth methods are somewhat robust but there are edge cases when detection will fail, which are [explained here](https://github.com/luisbocanegra/kde-material-you-colors/issues/187)\n\n## Bug reporting / Feature requests / Contributing\n\nPlease read the [Contributing guidelines in this repository](https://github.com/luisbocanegra/kde-material-you-colors/blob/main/CONTRIBUTING.md)\n\n## Support the development\n\n- If you like the project please consider donating/sponsoring this and [my other open source work](https://github.com/luisbocanegra?tab=repositories&q=&type=source&language=&sort=stargazers)\n\n [](https://github.com/sponsors/luisbocanegra) [](https://ko-fi.com/luisbocanegra) [](https://www.buymeacoffee.com/luisbocanegra) [](https://liberapay.com/luisbocanegra/) [](https://www.paypal.com/donate/?hosted_button_id=Y5TMH3Z4YZRDA)\n\n- [Give it a star on GitHub](https://aur.archlinux.org/packages/kde-material-you-colors)\n- Rate / leave review in the [KDE Store](https://store.kde.org/p/2136963)\n\n## Acknowledgements\n\n- [materialyoucolor-python](https://github.com/T-Dynamos/materialyoucolor-python) Python Implementation of Material Color Utilities used by this project.\n- [Pywal16](https://github.com/eylles/pywal16) to apply material colors to pywal supported software\n- [xdg-desktop-portal-kde](https://invent.kde.org/plasma/xdg-desktop-portal-kde) base for desktop screenshot helper.\n- [kdotool](https://github.com/jinliu/kdotool) base for getting desktop window id.\n- [ksetwallpaper](https://github.com/pashazz/ksetwallpaper) code to get the current Wallpaper that served me as inspiration.\n- [Google LLC. / Pictogrammers](https://pictogrammers.com/library/mdi/) widget icon assets.\n",
"bugtrack_url": null,
"license": null,
"summary": "Automatic Material You Colors Generator from your wallpaper for the Plasma Desktop",
"version": "1.10.0",
"project_urls": {
"Bug Tracker": "https://github.com/luisbocanegra/kde-material-you-colors/issues",
"Homepage": "https://github.com/luisbocanegra/kde-material-you-colors",
"Repository": "https://github.com/luisbocanegra/kde-material-you-colors"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "920709e3811efef435a7982ce4c19d71b7d66339acc662e6364b4d01251e686c",
"md5": "1814929fc5aba50e3043c79fa60ed8cd",
"sha256": "bedb2ecaf72cb711763fcad2c1ae9718c34a8168bb5d833b7abf0e8ab3ebf279"
},
"downloads": -1,
"filename": "kde_material_you_colors-1.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1814929fc5aba50e3043c79fa60ed8cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 69245,
"upload_time": "2025-01-13T10:10:36",
"upload_time_iso_8601": "2025-01-13T10:10:36.954746Z",
"url": "https://files.pythonhosted.org/packages/92/07/09e3811efef435a7982ce4c19d71b7d66339acc662e6364b4d01251e686c/kde_material_you_colors-1.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f2e077b4ec29b1a2b54b83a1e4ea39e89df231f5a57ac80f9ff56c8b3354708c",
"md5": "4d5fea358ff3959e2c9e4557c35a2304",
"sha256": "0bad38a04630dca70b2ac12bf326620c52f2dbbf97ff402bc3298b9b3052c214"
},
"downloads": -1,
"filename": "kde_material_you_colors-1.10.0.tar.gz",
"has_sig": false,
"md5_digest": "4d5fea358ff3959e2c9e4557c35a2304",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 63509,
"upload_time": "2025-01-13T10:10:39",
"upload_time_iso_8601": "2025-01-13T10:10:39.610719Z",
"url": "https://files.pythonhosted.org/packages/f2/e0/77b4ec29b1a2b54b83a1e4ea39e89df231f5a57ac80f9ff56c8b3354708c/kde_material_you_colors-1.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 10:10:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "luisbocanegra",
"github_project": "kde-material-you-colors",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kde-material-you-colors"
}
