guz013/frappuccino-theme
Archived
1
0
Fork 0
Code Activity

docs: First draft of simpler readme

Browse Source
This commit is contained in:
Jade Herd
2023-10-25 14:45:18 -04:00
parent 7b8ba848f2
commit 23af2d30a8
1 changed files with 4 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@@ -34,31 +34,6 @@
## Usage
### [BeautifulDiscord](https://github.com/leovoel/BeautifulDiscord)
1. Download your preferred flavour:
- 🌻 [Latte](./themes/latte.theme.css?raw=1)
- 🪴 [Frappe](./themes/frappe.theme.css?raw=1)
- 🌺 [Macchiato](./themes/macchiato.theme.css?raw=1)
- 🌿 [Mocha](./themes/mocha.theme.css?raw=1)
2. Move the downloaded file into a location of your choosing, for example `~/.config/discord` on Linux or `%APPDATA%\discord` on Windows.
3. Ensure Discord is **running**.
4. Install and run [BeautifulDiscord](https://github.com/leovoel/BeautifulDiscord#installing):
```bash
# Install using pip
python3 -m pip install -U https://github.com/leovoel/BeautifulDiscord/archive/master.zip
# Run BeautifulDiscord providing the path to your downloaded theme file
# Linux:
beautifuldiscord --css ~/.config/discord/catppuccin-mocha.theme.css
# Windows:
beautifuldiscord --css %APPDATA%\discord\catppuccin-mocha.theme.css
```
### [BetterDiscord](https://betterdiscord.app)
1. Download your preferred flavour:
@@ -73,7 +48,7 @@ beautifuldiscord --css %APPDATA%\discord\catppuccin-mocha.theme.css
### Clients/Mods with custom CSS support
1. Simply add your preferred flavour into `Discord > Settings > Custom CSS`
1. Simply add your preferred flavour into your discord clients CustomCSS file/editor.
```css
/* latte */
@@ -92,45 +67,16 @@ beautifuldiscord --css %APPDATA%\discord\catppuccin-mocha.theme.css
@import url("https://catppuccin.github.io/discord/dist/catppuccin-frappe-maroon.theme.css");
```
### [DiscoCSS](https://github.com/mlvzk/discocss)
1. Follow the instructions from [DiscoCSS](https://github.com/mlvzk/discocss#installation) to install DiscoCSS.
2. Use your preferred flavour as your DiscoCSS `custom.css`
```bash
# latte
curl -L https://catppuccin.github.io/discord/dist/catppuccin-latte.theme.css > ~/.config/discocss/custom.css
# frappe
curl -L https://catppuccin.github.io/discord/dist/catppuccin-frappe.theme.css > ~/.config/discocss/custom.css
# macchiato
curl -L https://catppuccin.github.io/discord/dist/catppuccin-macchiato.theme.css > ~/.config/discocss/custom.css
# mocha
curl -L https://catppuccin.github.io/discord/dist/catppuccin-mocha.theme.css > ~/.config/discocss/custom.css
# You can also append Catppuccin colors to customize the accent, e.g.
# mocha (pink accent)
curl -L https://catppuccin.github.io/discord/dist/catppuccin-mocha-pink.theme.css > ~/.config/discocss/custom.css
# frappe (maroon accent)
curl -L https://catppuccin.github.io/discord/dist/catppuccin-frappe-maroon.theme.css > ~/.config/discocss/custom.css
```
### [Stylus](https://github.com/openstyles/stylus)
1. Enable CSP Patching from Stylus Settings > Advanced.
2. [Click here to install](https://github.com/catppuccin/discord/raw/main/discord.user.css)
2. [Click here to install](https://github.com/catppuccin/discord/raw/main/discord.user.css).
3. Choose your preferred flavour and accent color from the Stylus preference dropdown.
## 🙋 FAQ
- Q: **_"Can this get my account banned?"_**
- A: Using third party clients and injecting custom css is against the ToS. We are not responsible for anything that might happen to your account by using third party clients. Use at your own discretion!
- Q: **_"Latte/Light theme doesn't look right!?"_**
- A: Using the Latte theme requires Discord's light mode to be on. You can set it up to sync between e.g. Mocha in dark mode, and Latte in light mode with this snippet:
```css
@import url("https://catppuccin.github.io/discord/dist/catppuccin-mocha.theme.css") (prefers-color-scheme: dark);
@import url("https://catppuccin.github.io/discord/dist/catppuccin-latte.theme.css") (prefers-color-scheme: light);
```
- A: Using third party clients and injecting custom css is against the ToS. While nobody has ever been banned for simply using discord client mods, We are not responsible for anything that might happen to your account by using third party clients. Use at your own discretion!
## 💝 Thanks to
@@ -139,6 +85,7 @@ curl -L https://catppuccin.github.io/discord/dist/catppuccin-frappe-maroon.theme
- [Ren](https://github.com/watatomo)
- [winston](https://github.com/nekowinston)
- [rubyowo](https://github.com/rubyowo)
- [Aven](https://github.com/ToxicAven)