.dotfiles/sway/catppuccin/README.md

102 lines
3.3 KiB
Markdown
Raw Normal View History

2023-05-12 04:57:21 +00:00
<h3 align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
Catppuccin for <a href="https://github.com/i3/i3">i3</a> & <a href="https://github.com/swaywm/sway">sway</a>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
</h3>
<p align="center">
<a href="https://github.com/catppuccin/i3/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/i3?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/i3/issues"><img src="https://img.shields.io/github/issues/catppuccin/i3?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/i3/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/i3?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
</p>
<p align="center">
![preview](assets/preview.webp)
</p>
## Previews
<details>
<summary>🌻 Latte</summary>
![latte](assets/latte.webp)
</details>
<details>
<summary>🪴 Frappé</summary>
![frappé](assets/frappe.webp)
</details>
<details>
<summary>🌺 Macchiato</summary>
![macchiato](assets/macchiato.webp)
</details>
<details>
<summary>🌿 Mocha</summary>
![mocha](assets/mocha.webp)
</details>
## Usage
1. Download the file with your desired flavour e.g. `catppuccin-mocha` (to be
found in the release or after cloning the repository in themes/)
2. Copy it into your i3 or sway config directory (usually `~/.config/i3/` or
`~/.config/sway/`)
3. Follow the instructions for your WM
4. When editing the config, use the
[name of the colour](https://github.com/catppuccin/catppuccin#-palettes) such
as `$base`.
```i3config
# target title bg text indicator border
client.focused $pink $base $text $rosewater $pink
client.focused_inactive $mauve $base $text $rosewater $mauve
client.unfocused $mauve $base $text $rosewater $mauve
client.urgent $peach $base $peach $overlay0 $peach
client.placeholder $overlay0 $base $text $overlay0 $overlay0
client.background $base
```
## Sway
- Include the file at the top of your `config`:
```i3config
include catppuccin-mocha
```
## i3
- Due to a limitation in i3, you cannot use variables from imported files in the top-level config.
- As a workaround, you may create another file to set the colors by importing them, and import in `config`.
## 🙋 FAQ
- Q: **_"Sway/i3 doesn't work with the colors"_**
\
A: Make sure you included the file in the right place and you are using
`$color`
## 💝 Thanks to
- [rubyowo](https://github.com/rubyowo)
&nbsp;
<p align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" />
</p>
<p align="center">
Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
</p>
<p align="center">
<a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
</p>