2022-08-18 16:52:25 +00:00
< img align = "left" alt = "Project logo" src = "https://github.com/GradienceTeam/Gradience/blob/main/data/icons/hicolor/scalable/apps/com.github.GradienceTeam.Gradience.svg" / >
2022-07-18 14:11:46 +00:00
2022-08-12 21:24:10 +00:00
# Gradience
2022-07-20 12:18:05 +00:00
Change the look of Adwaita, with ease
2022-08-18 16:52:25 +00:00
![Screenshot of interface with Adwaita light theme ](https://github.com/GradienceTeam/Design/blob/main/Screenshots/main_screenshot.png )
2022-07-20 12:18:05 +00:00
2022-08-16 21:06:18 +00:00
Gradience is a tool for customizing Libadwaita applications and the adw-gtk3 theme.
2022-07-18 14:11:46 +00:00
2022-07-18 14:49:17 +00:00
< details >
2022-07-18 14:51:16 +00:00
< summary > More screenshots< / summary >
2022-08-19 23:17:06 +00:00
![Screenshot of interface of Monet Tab ](https://github.com/GradienceTeam/Design/blob/main/Screenshots/monet_purple.png )
2022-07-18 14:51:16 +00:00
2022-08-18 16:52:25 +00:00
![Screenshot of proof that this actually works ](https://github.com/GradienceTeam/Design/blob/main/Screenshots/proof_of_work_screenshot.png )
2022-07-18 14:49:17 +00:00
< / details >
2022-08-18 16:52:25 +00:00
[![Build flatpak ](https://github.com/GradienceTeam/Gradience/actions/workflows/flatpak.yml/badge.svg )](https://github.com/GradienceTeam/Gradience/actions/workflows/flatpak.yml)
[![Build flatpak nightly ](https://github.com/GradienceTeam/Gradience/actions/workflows/flatpak-nightly.yml/badge.svg )](https://github.com/GradienceTeam/Gradience/actions/workflows/flatpak-nightly.yml)
2022-08-16 21:45:51 +00:00
[![Translate on Weblate ](https://hosted.weblate.org/widgets/GradienceTeam/-/svg-badge.svg )](https://hosted.weblate.org/engage/GradienceTeam)
2022-08-18 04:35:00 +00:00
[![Chat on Matrix ](https://matrix.to/img/matrix-badge.svg )](https://matrix.to/#/#Gradience:matrix.org)
2022-08-20 00:58:10 +00:00
[![All Contributors ](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square )](#contributors-)
2022-08-10 08:23:06 +00:00
2022-07-18 14:11:46 +00:00
## Building and Installing
2022-08-10 18:30:32 +00:00
2022-08-16 23:37:04 +00:00
**[NOTE]** See `next` branch for latest commits.
2022-08-12 21:18:24 +00:00
## Requirements:
- Python 3 `python`
- PyGObject `python-gobject`
- Blueprint < code > [blueprint-compiler](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/setup.html)</ code >
- GTK4 `gtk4`
- libadwaita (>= 1.2.alpha) `libadwaita`
- Meson `meson`
- Ninja `ninja`
## Building from source:
Install required Python libraries:
```sh
pip install -r requirements.txt
```
### Global installation:
```sh
2022-08-18 16:52:25 +00:00
git clone https://github.com/GradienceTeam/Gradience.git
cd Gradience
2022-08-12 21:18:24 +00:00
meson builddir --prefix=/usr/local
sudo ninja -C builddir install
```
### Local build (for testing and development purposes):
```sh
2022-08-18 16:52:25 +00:00
git clone https://github.com/GradienceTeam/Gradience.git
cd Gradience
2022-08-12 21:18:24 +00:00
meson builddir
meson configure builddir -Dprefix="$(pwd)/builddir/testdir"
ninja -C builddir install
ninja -C builddir run
```
**[NOTE]** During testing and developement, as a convenience, you can use the `local.sh` script to quickly rebuild local builds.
### Building using flatpak-builder:
2022-08-10 18:30:32 +00:00
2022-07-26 13:31:16 +00:00
1. Open Terminal
2022-08-16 21:06:18 +00:00
2. Run `git clone https://github.com/GradienceTeam/Gradience.git && cd Gradience`
2022-07-26 13:31:16 +00:00
3. Add the `gnome-nightly` Flatpak repository `flatpak remote-add --if-not-exists gnome-nightly https://nightly.gnome.org/gnome-nightly.flatpakrepo`
2022-07-26 13:34:48 +00:00
4. Install the `master` version of GNOME SDK: `flatpak install org.gnome.Sdk/x86_64/master org.gnome.Platform/x86_64/master`
2022-08-16 21:06:18 +00:00
5. Run `flatpak-builder --install --user --force-clean repo/ com.github.GradienceTeam.Gradience.json`
2022-07-18 14:11:46 +00:00
2022-07-26 13:31:16 +00:00
Alternatively, open the project with GNOME Builder, then build and run it.
2022-07-18 14:11:46 +00:00
## Setup Tutorial
### Libadwaita applications
No additional setup is required for native Libadwaita applications.
2022-07-20 12:18:05 +00:00
For Flatpak Libadwaita applications, you need to override their permissions:
2022-07-20 12:41:03 +00:00
- Run `sudo flatpak override --filesystem=xdg-config/gtk-4.0` or
- Use [Flatseal ](https://github.com/tchx84/Flatseal ) and adding `xdg-config/gtk-4.0` to **Other files** in the **Filesystem** section of **All Applications**
2022-07-18 14:11:46 +00:00
### Vanilla GTK 4 applications
Use [this guide ](https://github.com/lassekongo83/adw-gtk3/blob/main/gtk4.md ) to theme vanilla GTK 4 applications.
### GTK 3 applications
- Install and apply the [adw-gtk3 ](https://github.com/lassekongo83/adw-gtk3#readme ) theme (don't forget to install the Flatpak package!)
2022-07-20 12:21:15 +00:00
- For Flatpak applications, you need to override their permissions:
2022-07-20 12:41:03 +00:00
- Run `sudo flatpak override --filesystem=xdg-config/gtk-3.0` or
- Use [Flatseal ](https://github.com/tchx84/Flatseal ) and adding `xdg-config/gtk-3.0` to **Other files** in the **Filesystem** section of **All Applications**
2022-07-18 14:11:46 +00:00
## Roadmap
2022-07-20 12:18:05 +00:00
This tool is currently WIP, but it already has a plenty of features and is very usable. Below is the roadmap, where all the checked features are already implemented:
2022-07-18 14:11:46 +00:00
2022-07-18 19:20:02 +00:00
- [x] Customize named colors, either with a color picker or with text
2022-07-18 14:11:46 +00:00
- [x] Explanations for some named colors
2022-07-18 19:20:02 +00:00
- [x] Partial theme preview
2022-07-18 14:23:01 +00:00
- [x] Built-in presets for Adwaita and Adwaita Dark (based on default libadwaita colors)
2022-07-18 19:20:02 +00:00
- [x] Apply changes to libadwaita, GTK4 (with extracted libadwaita theme) and GTK3 (with the adw-gtk3 theme) applications
- [x] Load and create custom presets
- [x] View adw-gtk3's support of variables
- [x] View parsing errors
2022-07-21 19:03:18 +00:00
- [x] Customize palette colors
2022-07-24 17:46:37 +00:00
- [x] Add custom CSS code
2022-07-26 13:31:16 +00:00
- [x] Localization support
2022-07-30 05:10:31 +00:00
- [x] Normalize color variables
2022-08-10 18:30:32 +00:00
- [x] Make the code more secure
2022-08-19 23:09:56 +00:00
- [ ] Add plugin support. Will help integration with others tools. (WIP)
2022-07-21 19:03:18 +00:00
- [ ] Release on Flathub
2022-07-18 14:11:46 +00:00
- [ ] Full theme preview
2022-07-21 19:03:18 +00:00
- [ ] Customize GNOME Shell
- [ ] Customize GDM
2022-07-24 13:32:12 +00:00
- [ ] Customize KvLibadwaita
2022-07-21 19:03:18 +00:00
- [ ] Customize Firefox GNOME theme
2022-07-18 16:15:03 +00:00
2022-07-26 13:31:16 +00:00
## Contribute
### Code
Fork this repository, then create a push request when you're done adding features or fixing bugs.
2022-08-16 21:53:10 +00:00
### Localisation
2022-07-26 13:31:16 +00:00
2022-08-16 21:45:51 +00:00
[![Translations ](https://hosted.weblate.org/widgets/GradienceTeam/-/multi-auto.svg )](https://hosted.weblate.org/engage/GradienceTeam)
2022-08-14 13:16:54 +00:00
## About Name
2022-08-14 13:15:59 +00:00
Gradience is originally named Adwaita Manager
Meaning of Gradience is: https://en.wiktionary.org/wiki/gradience
2022-08-14 17:16:10 +00:00
Meaning of an icon is: "A Paint Roller repaints Adwaita window keeping it's functionality"
2022-08-20 00:43:40 +00:00
## Contributors ✨
2022-08-20 00:59:19 +00:00
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)) (If you have contributed to this project and you want to be mentionned here, just see [how to add yourself ](https://allcontributors.org/docs/en/bot/usage ))
2022-08-20 00:43:40 +00:00
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
< td align = "center" > < a href = "https://github.com/rene-coty" > < img src = "https://avatars.githubusercontent.com/u/95506494?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > rene-coty< / b > < / sub > < / a > < br / > < a href = "#translation-rene-coty" title = "Translation" > 🌍< / a > < / td >
2022-08-20 00:50:42 +00:00
< td align = "center" > < a href = "https://github.com/0xMRTT" > < img src = "https://avatars.githubusercontent.com/u/105598867?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > 0xMRTT< / b > < / sub > < / a > < br / > < a href = "#maintenance-0xMRTT" title = "Maintenance" > 🚧< / a > < a href = "#translation-0xMRTT" title = "Translation" > 🌍< / a > < a href = "https://github.com/GradienceTeam/Gradience/commits?author=0xMRTT" title = "Code" > 💻< / a > < / td >
2022-08-20 01:21:21 +00:00
< td align = "center" > < a href = "https://github.com/daudix-UFO" > < img src = "https://avatars.githubusercontent.com/u/77155297?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > David Lapshin< / b > < / sub > < / a > < br / > < a href = "#translation-daudix-UFO" title = "Translation" > 🌍< / a > < a href = "#design-daudix-UFO" title = "Design" > 🎨< / a > < / td >
2022-08-20 01:00:44 +00:00
< td align = "center" > < a href = "https://github.com/ArtyIF" > < img src = "https://avatars.githubusercontent.com/u/8017858?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > ArtyIF< / b > < / sub > < / a > < br / > < a href = "https://github.com/GradienceTeam/Gradience/commits?author=ArtyIF" title = "Code" > 💻< / a > < / td >
2022-08-20 01:02:27 +00:00
< td align = "center" > < a href = "https://github.com/tfuxu" > < img src = "https://avatars.githubusercontent.com/u/73042332?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > tfuxu< / b > < / sub > < / a > < br / > < a href = "https://github.com/GradienceTeam/Gradience/commits?author=tfuxu" title = "Code" > 💻< / a > < / td >
2022-08-20 00:43:40 +00:00
< / tr >
< / table >
<!-- markdownlint - restore -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2022-08-20 00:54:31 +00:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!