Compare commits
15 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
5b6c477850 | ||
|
4f4501f83b | ||
|
8d9803f089 | ||
|
26b0d12b1b | ||
|
5b043b61c6 | ||
|
3b802c6b03 | ||
|
939386a30a | ||
|
e279ceffca | ||
|
c577226e9c | ||
|
76cccfa215 | ||
|
9082969c1c | ||
|
f3faf6d9da | ||
|
761a075ca9 | ||
|
23a48d8b81 | ||
|
03376d1003 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -3,6 +3,9 @@ pkgs/
|
|||||||
__pycache__
|
__pycache__
|
||||||
venv/
|
venv/
|
||||||
.venv
|
.venv
|
||||||
|
bin/
|
||||||
|
lib*/
|
||||||
|
*.cfg
|
||||||
|
|
||||||
# Releases folder
|
# Releases folder
|
||||||
releases
|
releases
|
||||||
|
121
README.md
121
README.md
@@ -23,9 +23,8 @@ This GTK theme is based on the [Colloid](https://github.com/vinceliuice/Colloid-
|
|||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
- GTK `>=3.20`
|
- GTK `>=3.20`
|
||||||
- `gnome-themes-extra` (or `gnome-themes-standard`)
|
- `gnome-themes-extra` (or `gnome-themes-standard`)
|
||||||
- Murrine engine
|
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
@@ -36,31 +35,42 @@ This GTK theme is based on the [Colloid](https://github.com/vinceliuice/Colloid-
|
|||||||
### For Arch Linux users
|
### For Arch Linux users
|
||||||
|
|
||||||
We have 4 AUR packages for all the 4 flavours of the theme:
|
We have 4 AUR packages for all the 4 flavours of the theme:
|
||||||
|
|
||||||
- [Latte](https://aur.archlinux.org/packages/catppuccin-gtk-theme-latte)
|
- [Latte](https://aur.archlinux.org/packages/catppuccin-gtk-theme-latte)
|
||||||
- [Frappe](https://aur.archlinux.org/packages/catppuccin-gtk-theme-frappe)
|
- [Frappe](https://aur.archlinux.org/packages/catppuccin-gtk-theme-frappe)
|
||||||
- [Macchiato](https://aur.archlinux.org/packages/catppuccin-gtk-theme-macchiato)
|
- [Macchiato](https://aur.archlinux.org/packages/catppuccin-gtk-theme-macchiato)
|
||||||
- [Mocha](https://aur.archlinux.org/packages/catppuccin-gtk-theme-mocha)
|
- [Mocha](https://aur.archlinux.org/packages/catppuccin-gtk-theme-mocha)
|
||||||
|
|
||||||
With your favourite AUR helper, install them:
|
With your favourite AUR helper, install them:
|
||||||
```bash
|
|
||||||
yay -S catppuccin-gtk-theme-mocha catppuccin-gtk-theme-macchiato catppuccin-gtk-theme-frappe catppuccin-gtk-theme-latte
|
```bash
|
||||||
```
|
yay -S catppuccin-gtk-theme-mocha catppuccin-gtk-theme-macchiato catppuccin-gtk-theme-frappe catppuccin-gtk-theme-latte
|
||||||
|
```
|
||||||
|
|
||||||
### For Nix users
|
### For Nix users
|
||||||
|
|
||||||
The [catppuccin-gtk](https://github.com/NixOS/nixpkgs/blob/master/pkgs/data/themes/catppuccin-gtk/default.nix) package in Nixpkgs allows you to specify the accents, size, tweaks and variant (flavour) of the theme by overriding the package.
|
The [catppuccin-gtk](https://github.com/NixOS/nixpkgs/blob/master/pkgs/data/themes/catppuccin-gtk/default.nix) package in Nixpkgs allows you to specify the accents, size, tweaks and variant (flavour) of the theme by overriding the package.
|
||||||
|
|
||||||
By default, the variant is `frappe`, the accent is `blue`, the size is `standard`, and no tweaks are enabled. To change them, override the package. A list of valid choices are available in the package definition [here](https://github.com/NixOS/nixpkgs/blob/7ce8e7c4cf90492a631e96bcfe70724104914381/pkgs/data/themes/catppuccin-gtk/default.nix#L16).
|
By default, the variant is `frappe`, the accent is `blue`, the size is `standard`, and no tweaks are enabled. To change them, override the package. A list of valid choices are available in the package definition [here](https://github.com/NixOS/nixpkgs/blob/7ce8e7c4cf90492a631e96bcfe70724104914381/pkgs/data/themes/catppuccin-gtk/default.nix#L16).
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
pkgs.catppuccin-gtk.override {
|
# as per wiki examples
|
||||||
accents = [ "pink" ]; # You can specify multiple accents here to output multiple themes
|
environment.systemPackages = with pkgs; [
|
||||||
size = "compact";
|
...
|
||||||
tweaks = [ "rimless" "black" ]; # You can also specify multiple tweaks here
|
(catppuccin-gtk.override {
|
||||||
variant = "macchiato";
|
accents = [ "pink" ]; # You can specify multiple accents here to output multiple themes
|
||||||
}
|
size = "compact";
|
||||||
|
tweaks = [ "rimless" "black" ]; # You can also specify multiple tweaks here
|
||||||
|
variant = "macchiato";
|
||||||
|
})
|
||||||
|
...
|
||||||
|
];
|
||||||
```
|
```
|
||||||
|
|
||||||
To use it in home-manager:
|
To use it in home-manager:
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
# home.nix
|
# home.nix
|
||||||
{
|
{
|
||||||
@@ -80,11 +90,19 @@ To use it in home-manager:
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Now symlink the `~/.config/gtk-4.0/` folder declaratively:
|
||||||
|
xdg.configFile = {
|
||||||
|
"gtk-4.0/assets".source = "${config.gtk.theme.package}/share/themes/${config.gtk.theme.name}/gtk-4.0/assets";
|
||||||
|
"gtk-4.0/gtk.css".source = "${config.gtk.theme.package}/share/themes/${config.gtk.theme.name}/gtk-4.0/gtk.css";
|
||||||
|
"gtk-4.0/gtk-dark.css".source = "${config.gtk.theme.package}/share/themes/${config.gtk.theme.name}/gtk-4.0/gtk-dark.css";
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
### For GTK 4 users
|
### For GTK 4 users
|
||||||
|
|
||||||
To theme GTK 4 applications you have to manually symlink the `~/.config/gtk-4.0/` to the themes folder. Use the following commands
|
To theme GTK 4 applications you have to manually symlink the `~/.config/gtk-4.0/` to the themes folder. Use the following commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mkdir -p "${HOME}/.config/gtk-4.0"
|
mkdir -p "${HOME}/.config/gtk-4.0"
|
||||||
ln -sf "${THEME_DIR}/gtk-4.0/assets" "${HOME}/.config/gtk-4.0/assets"
|
ln -sf "${THEME_DIR}/gtk-4.0/assets" "${HOME}/.config/gtk-4.0/assets"
|
||||||
@@ -95,30 +113,84 @@ ln -sf "${THEME_DIR}/gtk-4.0/gtk-dark.css" "${HOME}/.config/gtk-4.0/gtk-dark.css
|
|||||||
### For Flatpak users
|
### For Flatpak users
|
||||||
|
|
||||||
1. To give your Flatpaks access to your themes folder run:
|
1. To give your Flatpaks access to your themes folder run:
|
||||||
```bash
|
|
||||||
sudo flatpak override --filesystem=$HOME/.themes
|
```bash
|
||||||
```
|
sudo flatpak override --filesystem=$HOME/.themes
|
||||||
|
```
|
||||||
|
|
||||||
2. To set the theme for all Flatpaks, replace `##theme##` with the name of the theme you want to use and run this command:
|
2. To set the theme for all Flatpaks, replace `##theme##` with the name of the theme you want to use and run this command:
|
||||||
```bash
|
|
||||||
sudo flatpak override --env=GTK_THEME=##theme##
|
```bash
|
||||||
```
|
sudo flatpak override --env=GTK_THEME=##theme##
|
||||||
|
```
|
||||||
|
|
||||||
3. For a more in depth tutorial see Hamza Algohary's tutorial on [It's FOSS](https://itsfoss.com/flatpak-app-apply-theme/)
|
3. For a more in depth tutorial see Hamza Algohary's tutorial on [It's FOSS](https://itsfoss.com/flatpak-app-apply-theme/)
|
||||||
|
|
||||||
|
### Handling GTK theme installation from window manager
|
||||||
|
|
||||||
|
1. Install unzip and curl.
|
||||||
|
2. Go to your window manager config file.
|
||||||
|
3. Add an entrance to the config file to be executed when your window manager is loaded.
|
||||||
|
- i3/sway example:
|
||||||
|
```
|
||||||
|
# catppuccin
|
||||||
|
set $ctp-version v0.6.1
|
||||||
|
exec_always if [ ! -e ~/.themes/Catppuccin-Frappe-Standard-Lavender-dark ]; then \
|
||||||
|
mkdir -p ~/.themes \
|
||||||
|
&& curl -L https://github.com/catppuccin/gtk/releases/download/$ctp-version/Catppuccin-Frappe-Standard-Lavender-dark.zip -o ~/.themes/catppuccin.zip \
|
||||||
|
&& unzip ~/.themes/catppuccin.zip -d ~/.themes/ \
|
||||||
|
&& rm -rf ~/.themes/catppuccin.zip; fi
|
||||||
|
```
|
||||||
|
> Note: The previous example execute that script every time i3/sway is reloaded.
|
||||||
|
4. Set the GTK_THEME environment variable:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
export GTK_THEME='Catppuccin-Frappe-Standard-Lavender-dark:dark'
|
||||||
|
```
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> in order to update the theme's version, just change the variable `$ctp-version`.
|
||||||
|
|
||||||
|
### GDM Theme
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Applying a custom theme to GDM is not recommended as it is not themeable, however you can do it through certain *hacks*.
|
||||||
|
|
||||||
|
To apply the theme to GDM, A new `gnome-shell-theme.gresource.xml` needs to be complied.
|
||||||
|
To achieve this, you can run the following:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Backup the current gresource file.
|
||||||
|
sudo cp -av /usr/share/gnome-shell/gnome-shell-theme.gresource{,~}
|
||||||
|
sudo glib-compile-resources --target="/usr/share/gnome-shell/gnome-shell-theme.gresource" --sourcedir="$THEME_DIR" "$THEME_DIR/gnome-shell-theme.gresource.xml"
|
||||||
|
```
|
||||||
|
|
||||||
|
Make sure to replace `$THEME_DIR` to where the theme was extracted accordingly.
|
||||||
|
|
||||||
|
- For nix users, it'll be the nix store path of the package.
|
||||||
|
- For AUR users, it'll be in `~/.themes`
|
||||||
|
- Otherwise, it'll be wherever you extracted the theme.
|
||||||
|
|
||||||
### Using the script
|
### Using the script
|
||||||
|
|
||||||
**Note**: Ensure that you have at least Python version 3.10 installed
|
**Note**: Ensure that you have at least Python version 3.10 installed
|
||||||
|
|
||||||
Clone the repository using
|
Set up the installer using
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone --recurse-submodules git@github.com:catppuccin/gtk.git
|
git clone --recurse-submodules git@github.com:catppuccin/gtk.git
|
||||||
|
cd gtk
|
||||||
virtualenv -p python3 venv # to be created only once and only if you need a virtual env
|
virtualenv -p python3 venv # to be created only once and only if you need a virtual env
|
||||||
source venv/bin/activate
|
source venv/bin/activate
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
To check out the install script, run
|
To check out the install script, run
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python install.py --help
|
python install.py --help
|
||||||
```
|
```
|
||||||
|
|
||||||
> Tip: `python install.py --help` allows the following options:
|
> Tip: `python install.py --help` allows the following options:
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -137,12 +209,16 @@ Compulsory field Specify color variant(s) [mocha|frappe|macchiato|latte|a
|
|||||||
4. float: Floating gnome-shell panel style
|
4. float: Floating gnome-shell panel style
|
||||||
-h, --help Show help
|
-h, --help Show help
|
||||||
```
|
```
|
||||||
|
|
||||||
You can install any theme like the following example
|
You can install any theme like the following example
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python install.py mocha -a sky --tweaks rimless -d ~/.themes
|
python install.py mocha -a sky --tweaks rimless -d ~/.themes
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
You can build all possible variations of the theme possible using the following command and it will install it to releases folder
|
You can build all possible variations of the theme possible using the following command and it will install it to releases folder
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python install.py all -a all
|
python install.py all -a all
|
||||||
```
|
```
|
||||||
@@ -150,6 +226,7 @@ python install.py all -a all
|
|||||||
## Development
|
## Development
|
||||||
|
|
||||||
You need to install the following packages to build the theme. Check with your distribution for the package names in the repository
|
You need to install the following packages to build the theme. Check with your distribution for the package names in the repository
|
||||||
|
|
||||||
- `sassc`
|
- `sassc`
|
||||||
- `inkscape`
|
- `inkscape`
|
||||||
- `optipng`
|
- `optipng`
|
||||||
@@ -163,14 +240,18 @@ A few important notes to keep in mind
|
|||||||
## 💝 Thanks to
|
## 💝 Thanks to
|
||||||
|
|
||||||
**Current maintainers**
|
**Current maintainers**
|
||||||
|
|
||||||
- [npv12](https://github.com/npv12)
|
- [npv12](https://github.com/npv12)
|
||||||
- [ghostx31](https://github.com/ghostx31)
|
- [ghostx31](https://github.com/ghostx31)
|
||||||
- [Syndrizzle](https://github.com/Syndrizzle)
|
- [Syndrizzle](https://github.com/Syndrizzle)
|
||||||
|
|
||||||
**Contributions**
|
**Contributions**
|
||||||
- [rubyowo](https://github.com/rubyowo) - for working on the build and CI script
|
|
||||||
|
- [rubyowo](https://github.com/rubyowo) - CI and docs
|
||||||
|
- [braheezy](https://github.com/braheezy) - Instructions for the GDM theme.
|
||||||
|
|
||||||
**Previous maintainer(s)**
|
**Previous maintainer(s)**
|
||||||
|
|
||||||
- [sadrach-cl](https://github.com/sadrach-cl)
|
- [sadrach-cl](https://github.com/sadrach-cl)
|
||||||
|
|
||||||
|
|
||||||
|
2
colloid
2
colloid
Submodule colloid updated: b3bb0af34f...6cf7ea0237
@@ -1 +1 @@
|
|||||||
catppuccin>=1.1.1
|
catppuccin>=1.1.1,<2.0.0
|
Reference in New Issue
Block a user