From 750cf9371538c18ee41577106227ddbd47876abb Mon Sep 17 00:00:00 2001 From: Saltssaumure Date: Wed, 19 Jun 2024 18:53:36 +0100 Subject: [PATCH] Update readme --- README.md | 58 +++++++++++++++++++++++++++++++++++---------------- manifest.json | 6 +++--- 2 files changed, 43 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index a0e0807..699c48c 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,12 @@ [BetterDiscord]: https://betterdiscord.app/ [Replugged]: https://replugged.dev/ -[Vencord]: https://github.com/Vendicated/Vencord +[Vencord]: https://vencord.dev/ [shield-donate]: https://img.shields.io/badge/Donate-ko--fi-orange?style=flat-square&logo=kofi&logoColor=orange [ko-fi]: https://ko-fi.com/saltssaumure "Buy me a coffee!" -[shield-bd-dl]: https://img.shields.io/github/downloads/MiniDiscordThemes/Pesterchum/Pesterchum.theme.css?color=purple&label=Downloads&style=flat-square +[shield-css-dl]: https://img.shields.io/github/downloads/MiniDiscordThemes/Pesterchum/Pesterchum.theme.css?color=purple&label=Downloads&style=flat-square [shield-asar-dl]: https://img.shields.io/github/downloads/MiniDiscordThemes/Pesterchum/net.saltssaumure.Pesterchum.asar?color=purple&label=Downloads&style=flat-square [shield-repo-size]: https://img.shields.io/github/repo-size/MiniDiscordThemes/Pesterchum?label=Repository&style=flat-square "Total size" @@ -27,12 +27,12 @@ [release-bd]: https://betterdiscord.app/theme/?id=000 "BetterDiscord store page" [release-rp]: https://replugged.dev/store/net.saltssaumure.Pesterchum "Replugged store page" -[release-bd-gh]: https://github.com/MiniDiscordThemes/Pesterchum/releases/latest/download/Pesterchum.theme.css "Get latest release" +[release-css-gh]: https://github.com/MiniDiscordThemes/Pesterchum/releases/latest/download/Pesterchum.theme.css "Get latest release" [release-rp-gh]: https://github.com/MiniDiscordThemes/Pesterchum/releases/latest/download/net.saltssaumure.Pesterchum.asar "Get latest release" # Pesterchum Discord Theme [![Buy me a coffee on ko-fi][shield-donate]][ko-fi] -[![BetterDiscord GitHub downloads][shield-bd-dl]][release-bd-gh] +[![CSS GitHub downloads][shield-css-dl]][release-css-gh] [![Replugged GitHub downloads][shield-asar-dl]][release-rp-gh] [![Total repository size][shield-repo-size]][github] @@ -40,20 +40,25 @@ ![Screenshot of Friends tab with Pesterchum theme applied][screenshot] -| Dark mode | Light mode | -| ---------------------------------------------- | ------------------------------------------------ | -| ![Screenshot of Pesterchum in dark mode][dark] | ![Screenshot of Pesterchum in light mode][light] | +| Dark mode | Light mode | +| :------------------------------: | :--------------------------------: | +| ![Pesterchum in dark mode][dark] | ![Pesterchum in light mode][light] | ## Installation ### [BetterDiscord][BetterDiscord] +
Click to expand + 1. Download `Pesterchum.theme.css`: - - [GitHub][release-bd-gh] + - [GitHub][release-css-gh] 2. Place the file in the themes folder: - `Settings` > `BetterDiscord` > `Themes` > `Open Themes Folder` 3. Toggle on the theme card. +
### [Replugged][Replugged] +
Click to expand + #### Automatic 1. Click to install: - [Replugged store][release-rp] @@ -63,39 +68,51 @@ 2. Place the file in the themes folder: - `Settings` > `Replugged` > `Themes` > `Open Themes Folder` 3. Click `Load Missing Themes` and toggle on the theme card. +
### [Vencord][Vencord] +
Click to expand + #### Local 1. Download `Pesterchum.theme.css`: - - [GitHub][release-bd-gh] + - [GitHub][release-css-gh] 2. Place the file in the themes folder: - `Settings` > `Vencord` > `Themes` > `Local Themes` > `Open Themes Folder` 3. Click `Load missing Themes` and toggle on the theme card. #### Online 1. Paste the link in `Settings` > `Vencord` > `Themes` > `Online Themes`: - `https://minidiscordthemes.github.io/Pesterchum/Pesterchum.theme.css` +
## Customisation -| Description | Variable name | Valid values | Default value | -| -------------------- | ---------------------- | ------------------------- | ------------- | -| Common border colour | `--chum-dark` | Any [colour][css-color]. | `#C48A00` | -| Main colour | `--chum-medium` | Any [colour][css-color]. | `#FDB302` | -| Bright border colour | `--chum-light` | Any [colour][css-color]. | `#FFF700` | -| Sidebar width | `--chum-sidebar-width` | Any [length][css-length]. | `300px` | +| Variable name | Description | Valid values | Default value | +| ---------------------- | -------------------- | ------------------------- | ------------- | +| `--chum-dark` | Common border colour | Any [colour][css-color]. | `#C48A00` | +| `--chum-medium` | Main colour | Any [colour][css-color]. | `#FDB302` | +| `--chum-light` | Bright border colour | Any [colour][css-color]. | `#FFF700` | +| `--chum-sidebar-width` | Sidebar width | Any [length][css-length]. | `300px` | ### BetterDiscord +
Click to expand + 1. Open `Settings` > `BetterDiscord` > `Themes`. 2. Click the pencil icon on this theme. 3. Edit the variable values and save changes. +
### Replugged +
Click to expand + 1. Enable `Automatically Apply Quick CSS` in `Settings` > `Replugged` > `General`. 1. Open `Settings` > `Replugged` > `Quick CSS`. 3. Copy and paste lines 15-21 of [`Pesterchum.theme.css`][.theme.css]. 3. Edit the variable values and save. +
### Vencord +
Click to expand + #### Local 2. `Open Themes Folder` in `Settings` > `Vencord` > `Themes` > `Local Themes` 3. Open `Pesterchum.theme.css` with your favourite text editor. @@ -104,20 +121,25 @@ 1. `Enable Custom CSS` in `Settings` > `Vencord` > `Vencord` and click `Open QuickCSS File`. 2. Copy and paste lines 15-21 of [`Pesterchum.theme.css`][.theme.css]. 3. Edit the variable values. +
## License See [LICENSE.md][license] for details. ## Credits - ### Sources -[pestercord]: https://github.com/luminaryFlowers/Pesterchum-Discord-Theme +[pestercord]: https://github.com/luminaryFlowers/Pesterchum-Discord-Theme - [Pestercord][pestercord] by [luminaryFlowers](https://github.com/luminaryFlowers) and [winterClover](https://github.com/winterClover) ### Themes -[squared]: https://github.com/MiniDiscordThemes/Squared +[squared]: https://github.com/MiniDiscordThemes/Squared - [Squared][squared] by [MiniDiscordThemes](https://github.com/MiniDiscordThemes) ([Saltssaumure](https://github.com/Saltssaumure)) - MIT license +### Fonts +[courierprime]: https://github.com/quoteunquoteapps/CourierPrime +- [Courier Prime][courierprime] by [Quote-Unquote Apps](https://github.com/quoteunquoteapps) ([Alan Dague-Greene](https://github.com/a-dg)) - OFL-1.1 +- Courier New Cyr by The Monotype Corporation + ## Questions or suggestions? - Post [an issue][issues] on GitHub. - Post in `#theme-support` on [my support server][discord]. \ No newline at end of file diff --git a/manifest.json b/manifest.json index cff4c36..ff6d633 100644 --- a/manifest.json +++ b/manifest.json @@ -27,8 +27,8 @@ "main": "scss/chum.scss", "source": "https://github.com/MiniDiscordThemes/Pesterchum", "image": [ - "https://i.imgur.com/y84rg1f.png", - "https://i.imgur.com/lolHUD9.png", - "https://i.imgur.com/1gqGyQI.png" + "https://minidiscordthemes.github.io/Pesterchum/preview/chum.png", + "https://minidiscordthemes.github.io/Pesterchum/preview/dark.png", + "https://minidiscordthemes.github.io/Pesterchum/preview/light.png" ] }