Skip to content

README.md

Latest commit

聽

History

History
93 lines (67 loc) 路 4.87 KB

README.md

File metadata and controls

93 lines (67 loc) 路 4.87 KB
Raw

Logo
Catppuccin for KDE

Previews

馃尰 Latte
馃 Frapp茅
馃尯 Macchiato
馃尶 Mocha

Installation

For KDE Plasma Desktop:

  1. git clone --depth=1 https://github.com/catppuccin/kde catppuccin-kde && cd catppuccin-kde
  2. Run the install script using ./install.sh and follow the instructions.

Automated Installation

Install without any prompts by passing the flavour, accent, and window-decoration numbers plus auto:

./install.sh [-q|--quiet] [-n|--no-cursor] [-c|--local-cursor <dir>] <flavour 1-4> <accent 1-14> <window_decoration 1-2> auto

Pass -n/--no-cursor to keep your current cursor theme untouched.

Pass -c <dir>/--local-cursor <dir> to install an already-downloaded cursor theme directory instead of fetching one.

Example (Mocha, Blue, Classic): ./install.sh 1 13 2 auto

For Krita:

  1. Download the colour-scheme zip file for your preferred flavour from the release tab.
  2. Extract the file and move the theme(s) you wish to install into the following folders for your platform: Windows: %appdata%\krita\color-schemes
    Linux: ~/.local/share/krita/color-schemes
  3. Open Krita, and you can choose the theme from Settings > Themes.

Notes

  1. If you are using KDE 5.27 or below, you might want to run git checkout v0.2.5 before running the install script to avoid running into compatibility issues. Alternatively, the release binaries are available here.
  2. If you encounter an error similar to 'connection refused' while running the installation script, it may be due to store.kde.org being down or issues with your internet connection.
  3. Applying the theme writes BorderSizeAuto=false to ~/.config/kwinrc (for borderless windows); this is the only setting the installer changes outside the theme directories.

Development

Colour schemes, splash screens, and look-and-feel metadata are rendered from templates/*.tera into the committed generated/ tree by Whiskers; install.sh only ever reads generated/, never the templates or the palette directly, so end users need no Rust/Cargo toolchain.

Requires just.

  • just build: fetch a pinned, checksum-verified Whiskers binary into .bin/ (gitignored) and render templates/*.tera into generated/.
  • just check: verify generated/ matches a fresh render (the same check CI runs).

After editing a template, run just build, review the diff, and commit the template change together with the regenerated generated/ output.

馃挐 Current Maintainers

馃挅 Past Maintainers

聽

Copyright 漏 2021-present Catppuccin Org