Update readme and version bump

Saltssaumure · May 8, 2023 · 8f22b8e · 8f22b8e
1 parent d00f8d2
commit 8f22b8e
Show file tree

Hide file tree

Showing 22 changed files with 114 additions and 82 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 [screenshot-old]: https://user-images.githubusercontent.com/29710355/123527529-72121600-d6d8-11eb-9580-da3987ee8398.png
-[screenshot]: https://user-images.githubusercontent.com/29710355/235468134-a4f95a88-627a-4ed9-ae3d-b288591374b2.png
+[dark]: https://user-images.githubusercontent.com/29710355/235468134-a4f95a88-627a-4ed9-ae3d-b288591374b2.png
+[light]: https://user-images.githubusercontent.com/29710355/236739532-3c62f571-bd1b-4285-a296-46f1c1eb13b4.png
 
 [cosy]: https://user-images.githubusercontent.com/29710355/154400330-eb4434ac-1716-4c3f-bca1-8b6ba509e9c3.png
 [compact]: https://user-images.githubusercontent.com/29710355/154400528-66fea4d8-53c1-4178-91f5-88729bde0e81.png
@@ -20,54 +21,85 @@
 [crt-stripe]: https://user-images.githubusercontent.com/29710355/182611054-c0cb9122-1eac-42ec-93d1-ab5a203a7e15.png
 [crt-scanline]: https://drive.google.com/uc?id=1xFbTWA5qIZAurVJdjOptnCd6OMBLBfEz
 
+[css-color]:        https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
+[discord]:          https://discord.gg/uy8nKQVatp
+
+[BetterDiscord]:    https://betterdiscord.app/
+[Replugged]:        https://replugged.dev/
+[Vencord]:          https://github.com/Vendicated/Vencord
+
+[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/Saltssaumure/pios-discord-theme/piOS.theme.css?color=purple&label=BD%20GitHub%20downloads&style=flat-square
+[shield-asar-dl]:   https://img.shields.io/github/downloads/Saltssaumure/pios-discord-theme/net.saltssaumure.piOS.asar?color=purple&label=Replugged%20downloads&style=flat-square
+[shield-repo-size]: https://img.shields.io/github/repo-size/Saltssaumure/pios-discord-theme?style=flat-square "Total size"
+
+[license]:          https://github.com/Saltssaumure/pios-discord-theme/blob/main/LICENSE
+[issues]:           https://github.com/Saltssaumure/pios-discord-theme/issues
+[.theme.css]:       https://github.com/Saltssaumure/pios-discord-theme/blob/main/piOS.theme.css
+
+[release-gh]:       https://github.com/Saltssaumure/pios-discord-theme/releases/latest "Latest release"
+[release-bd]:       https://betterdiscord.app/theme/?id=572 "BetterDiscord store page"
+[release-rp]:       https://replugged.dev/install?identifier=Saltssaumure/pios-discord-theme&source=github "Replugged addon installer"
+
 # piOS Discord Theme
-[![GitHub downloads](https://img.shields.io/github/downloads/saltssaumure/pios-discord-theme/total?color=purple&label=GitHub%20downloads&style=flat-square)](https://github.com/Saltssaumure/pios-discord-theme/releases/latest "Latest release")
-![Total size](https://img.shields.io/github/repo-size/saltssaumure/pios-discord-theme?style=flat-square "Total size")
+[![Buy me a coffee on ko-fi][shield-donate]][ko-fi]
+[![BetterDiscord GitHub downloads][shield-bd-dl]][release-gh]
+[![Replugged downloads][shield-asar-dl]][release-rp]
+![Total size][shield-repo-size]
 
 ***A SUPERHOT piOS inspired Discord theme.***
 
-![Screenshot of piOS Discord Theme applied to Discord desktop client][screenshot]
+| Dark mode                                  | Light mode                                   |
+| ------------------------------------------ | -------------------------------------------- |
+| ![piOS dark mode applied to Discord][dark] | ![piOS light mode applied to Discord][light] |
 
 ## Installation
 
 ### BetterDiscord
-1. Install [BetterDiscord](https://betterdiscord.app/).
+1. Install [BetterDiscord][BetterDiscord].
 2. Download the theme file:
-    - [GitHub](https://github.com/Saltssaumure/pios-discord-theme/releases/latest)
-    - [BD Store](https://betterdiscord.app/theme/?id=572)
-3. Place theme file in BD's theme folder:
+    - [GitHub][release-gh]
+    - [BD Store][release-bd]
+3. Place theme file in the `themes` folder:
     - Windows: `%AppData%/BetterDiscord/themes`
     - Mac: `~/Library/Application Support/betterdiscord/themes`
     - Linux: `~/.config/BetterDiscord/themes`
 
 ### Replugged
-1. Install [Replugged](https://replugged.dev/).
+1. Install [Replugged][Replugged].
 2. Install the theme:
-    - [GitHub](https://github.com/Saltssaumure/pios-discord-theme/releases/latest)
-    - [Replugged.dev](https://replugged.dev/install?identifier=Saltssaumure/pios-discord-theme&source=github)
+    - [GitHub][release-gh]
+    - [Installer][release-rp]
 
 ### Vencord
-1. Install [Vencord](https://github.com/Vendicated/Vencord).
+1. Install [Vencord][Vencord].
 2. Paste the following in `Settings` > `Vencord` > `Themes`:
     - `https://saltssaumure.github.io/pios-discord-theme/piOS.theme.css`
 
 ## Customisation
 
 - **Discord setting:** `Settings` > `App Settings` > `Appearance` > `Message Display`.
 
-| Cosy          | Compact             |
-| ------------- | ------------------- |
-| ![Cosy][cosy] | ![Compact][compact] |
-
-| Description                    | Variable name           | Valid values                    | Default value            | Demonstration                                                               |
-| ------------------------------ | ----------------------- | ------------------------------- | ------------------------ | --------------------------------------------------------------------------- |
-| Glow intensity                 | `--pios-glow-intensity` | A number between `0` and `1`.   | `1` (maximum brightness) | `1` [chat][glow-1a], [icon][glow-1b] / `0` [chat][glow-0a], [icon][glow-0b] |
-| Compact message spacing        | `--pios-spacing`        | A number `0` or above.          | `1` (default spacing)    | [`1` spacing][spacing-1] / [`2.5` spacing][spacing-2.5]                     |
-| Colour accent hue              | `--pios-accent-hue`     | Any number.                     | `0` (red)                | `270` (purple) [colour picker][hue-picker], [screenshot][hue-screenshot]    |
-| Title bar text                 | `--pios-title-text`     | Any quoted text.                | `"piOS v2.1.01p"`        | [Screenshot][title-text]                                                    |
-| Scanline stripes on/off        | `--crt-stripe`          | `block` (on) or `none` (off).   | `block`                  | [Screenshot][crt-stripe]                                                    |
-| &#9936; Moving scanline on/off | `--crt-scanline`        | `block` (on) or `none` (off).   | `block`                  | [Video][crt-scanline]                                                       |
-| &#9888; Screen flicker on/off  | `--crt-flicker`         | `flicker` (on) or `none` (off). | `none`                   |
+| Cosy mode          | Compact mode             |
+| ------------------ | ------------------------ |
+| ![Cosy mode][cosy] | ![Compact mode][compact] |
+
+| Description                    | Variable name             | Valid values                    | Default value                        | Demonstration                                                               |
+| ------------------------------ | ------------------------- | ------------------------------- | ------------------------------------ | --------------------------------------------------------------------------- |
+| Glow hue                       | `--pios-glow-hue`         | A number between `0` and `1`.   | `1` (maximum brightness)             |                                                                             |
+| Glow intensity                 | `--pios-glow-intensity`   | A number between `0` and `1`.   | `1` (maximum brightness)             | `1` [chat][glow-1a], [icon][glow-1b] / `0` [chat][glow-0a], [icon][glow-0b] |
+| Compact message spacing        | `--pios-spacing`          | A number `0` or above.          | `1` (default spacing)                | [`1` spacing][spacing-1] / [`2.5` spacing][spacing-2.5]                     |
+| Colour accent hue              | `--pios-accent-hue`       | Any number.                     | `0` (red)                            | `270` (purple) [colour picker][hue-picker], [screenshot][hue-screenshot]    |
+| Title bar text                 | `--pios-title-text`       | Any quoted text.                | `"piOS v2.1.01p"`                    | [Screenshot][title-text]                                                    |
+| Scanline stripes on/off        | `--crt-stripe`            | `block` (on) or `none` (off).   | `block`                              | [Screenshot][crt-stripe]                                                    |
+| &#9936; Moving scanline on/off | `--crt-scanline`          | `block` (on) or `none` (off).   | `block`                              | [Video][crt-scanline]                                                       |
+| &#9888; Screen flicker on/off  | `--crt-flicker`           | `flicker` (on) or `none` (off). | `none`                               |                                                                             |
+| Background colour              | `--pios-background-color` | Any [colour][css-color].        | `#000000` (dark) / `#FFFFFF` (light) |                                                                             |
+| Bright foreground colour       | `--pios-bright-color`     | Any [colour][css-color].        | `#FFFFFF` (dark) / `#000000` (light) |                                                                             |
+| Middle foreground colour       | `--pios-middle-color`     | Any [colour][css-color].        | `#D3D3D3` (dark) / `#696969` (light) |                                                                             |
+| Dim foreground colour          | `--pios-dim-color`        | Any [colour][css-color].        | `#808080` (dark) / `#A9A9A9` (light) |                                                                             |
 
 - &#9936; This effect is performance-intensive.
 - &#9888; This is a fast flickering effect and may not be suitable for those with photosensitive epilepsy.
@@ -79,7 +111,7 @@
 
 ### Replugged
 1. Open `Settings` > `Replugged` > `Quick CSS`.
-3. Copy and paste line 15-25 of [`piOS.theme.css`](https://github.com/Saltssaumure/pios-discord-theme/blob/main/piOS.theme.css).
+2. Copy and paste lines 15-40 of [`piOS.theme.css`][.theme.css].
 3. Edit the variable values and apply changes.
 
 ### Vencord
@@ -88,13 +120,13 @@
 #### Recommended method
 1. Open `Settings` > `Vencord` > `Vencord`.
 2. Toggle on `Enable Custom CSS` and click `Open QuickCSS File`.
-3. Copy and paste line 15-25 of [`piOS.theme.css`](https://github.com/Saltssaumure/pios-discord-theme/blob/main/piOS.theme.css).
+3. Copy and paste lines 15-40 of [`piOS.theme.css`][.theme.css].
 4. Edit the variable values.
 
 ## License
-[GNU General Public License v3.0](https://github.com/Saltssaumure/pios-discord-theme/blob/main/LICENSE)
+[GNU General Public License v3.0][license]
 - <span title="Too long; didn't read; not a lawyer">TL;DR;NAL</span>: Do whatever you want with this theme, as long as you allow others to do the same with your version.
 
 ## Questions or suggestions?
-- Post [an issue](https://github.com/Saltssaumure/pios-discord-theme/issues) on GitHub.
-- Post in `#theme-support` on [my support server](https://discord.gg/uy8nKQVatp).
+- Post [an issue][issues] on GitHub.
+- Post in `#theme-support` on [my support server][discord].
diff --git a/manifest.json b/manifest.json
@@ -1,13 +1,13 @@
 {
     "id": "net.saltssaumure.piOS",
     "name": "piOS",
-    "description": "A SUPERHOT piOS inspired Discord theme.",
+    "description": "A SUPERHOT piOS inspired theme.",
     "author": {
         "name": "Saltssaumure",
         "discordID": "134142022092062720",
         "github": "Saltssaumure"
     },
-    "version": "9.2.1",
+    "version": "9.3.0",
     "updater": {
         "type": "github",
         "id": "Saltssaumure/pios-discord-theme"

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "pios-discord-theme",
-    "version": "9.2.1",
+    "version": "9.3.0",
     "description": "A SUPERHOT piOS inspired Discord theme.",
     "repository": "https://github.com/Saltssaumure/pios-discord-theme.git",
     "author": "Saltssaumure <[email protected]>",

diff --git a/scss-compile.config.js b/scss-compile.config.js
@@ -8,6 +8,6 @@ export default {
         /** The name of your theme repository. */
         repo: "pios-discord-theme",
         /** The version of your theme. */
-        version: "9.2.1"
+        version: "9.3.0"
     }
 };
diff --git a/scss/_part.scss b/scss/_part.scss
@@ -16,22 +16,22 @@
 }
 
 // discord friends tab: for some reason not currently using a variable
-.appmount-2ybxzl .container-2cd8Mz {
+.appMount-2yBXZl .container-2cd8Mz {
     background-color: $background-color;
 }
 
 // Checkboxes
-.appmount-2ybxzl .checkbox-f1HnKB.checked-1pZh2h {
+.appMount-2yBXZl .checkbox-f1HnKB.checked-1pZh2h {
     border-color: $bright-color !important;
     color: $bright-color;
     background: transparent !important;
 }
 
-.appmount-2ybxzl .checkbox-f1HnKB.checked-1pZh2h path {
+.appMount-2yBXZl .checkbox-f1HnKB.checked-1pZh2h path {
     fill: currentColor;
 }
 
-.appmount-2ybxzl .checkbox-1LuCGM.checked-22NTbO {
+.appMount-2yBXZl .checkbox-1LuCGM.checked-22NTbO {
     background: $accent-color !important;
     border-color: $accent-color !important;
 }

diff --git a/scss/main/_chat.scss b/scss/main/_chat.scss
@@ -150,7 +150,7 @@
 // Embeds
 .embedFull-1HGV2S.markup-eYLPri,
 // most embeds
-.appmount-2ybxzl .wrapperAudio-1Bzv_Z,
+.appMount-2yBXZl .wrapperAudio-1Bzv_Z,
 // audio
 .attachment-1PZZB2,
 // file
@@ -259,8 +259,8 @@
 }
 
 // Command suggestions bar
-.appmount-2ybxzl .selected-3H3-RC,
-.appmount-2ybxzl .option-Tt7anD {
+.appMount-2yBXZl .selected-3H3-RC,
+.appMount-2yBXZl .option-Tt7anD {
     background-color: hsla.default($accent-hue, 0.3);
 }
 
@@ -271,7 +271,7 @@
 }
 
 // Forums
-.appmount-2ybxzl .container-3wLKDe {
+.appMount-2yBXZl .container-3wLKDe {
     background: $background-color;
 }
 
@@ -286,8 +286,8 @@
 }
 
 // Browse channels
-.appmount-2ybxzl .container-2IKOsH,
-.appmount-2ybxzl .header-3xB4vB,
-.appmount-2ybxzl .container-1um7CU {
+.appMount-2yBXZl .container-2IKOsH,
+.appMount-2yBXZl .header-3xB4vB,
+.appMount-2yBXZl .container-1um7CU {
     background: $background-color;
 }
diff --git a/scss/main/_customise.scss b/scss/main/_customise.scss
@@ -2,8 +2,8 @@
 
 // Customise channels and roles / browse channels
 
-.appmount-2ybxzl .emptyPage-2TGR7j,
-.appmount-2ybxzl .scrollerContainer-y16Rs9 {
+.appMount-2yBXZl .emptyPage-2TGR7j,
+.appMount-2yBXZl .scrollerContainer-y16Rs9 {
     background: $background-color;
 }
 

diff --git a/scss/main/_discover.scss b/scss/main/_discover.scss
@@ -5,13 +5,13 @@
 // ---- Explore public servers ----
 
 // Background
-.appmount-2ybxzl .pageWrapper-2PwDoS {
+.appMount-2yBXZl .pageWrapper-2PwDoS {
     background-color: $background-color;
     @include bd.border(thick);
 }
 
 // Search results searchbox
-.appmount-2ybxzl .searchBox-pyIJJj {
+.appMount-2yBXZl .searchBox-pyIJJj {
     background-color: hsla.default($accent-hue, 0.2);
     backdrop-filter: brightness(0);
 }

diff --git a/scss/main/_settings.scss b/scss/main/_settings.scss
@@ -3,8 +3,8 @@
 @use "../top/hsla";
 
 // Values slider
-.appmount-2ybxzl .bar-1Bhnl9,
-.appmount-2ybxzl .markDash-yk2kJ- {
+.appMount-2yBXZl .bar-1Bhnl9,
+.appMount-2yBXZl .markDash-yk2kJ- {
     background-color: $dim-color;
 }
 
@@ -32,13 +32,13 @@
 }
 
 // Discord key redemption
-.appmount-2ybxzl .codeRedemptionRedirect-2hYMSQ {
+.appMount-2yBXZl .codeRedemptionRedirect-2hYMSQ {
     background-color: hsla.default($accent-hue, 0.2);
     border-color: $accent-color;
 }
 
 // Default payment method
-.appmount-2ybxzl .defaultIndicator-2ndWks {
+.appMount-2yBXZl .defaultIndicator-2ndWks {
     background: $accent-color;
 }
 
@@ -73,7 +73,7 @@
     background-color: hsla.default($accent-hue, 0.3);
 }
 
-.appmount-2ybxzl .keybindShortcut-3zF1P9 span {
+.appMount-2yBXZl .keybindShortcut-3zF1P9 span {
     box-shadow: inset 0 -4px 0 hsla.default($accent-hue, 0.2);
 }
 
@@ -83,7 +83,7 @@
 }
 
 // Remove game
-.appmount-2ybxzl .default-1Tkeeg {
+.appMount-2yBXZl .default-1Tkeeg {
     background-color: transparent;
     border: 1px solid hsla.default($accent-hue, 0.7);
 }
@@ -120,8 +120,8 @@
 }
 
 // Header
-.appmount-2ybxzl .tierHeaderLocked-30MLlO,
-.appmount-2ybxzl .tierHeaderUnlocked-1OpOLf {
+.appMount-2yBXZl .tierHeaderLocked-30MLlO,
+.appMount-2yBXZl .tierHeaderUnlocked-1OpOLf {
     background: transparent;
 }
 
@@ -131,12 +131,12 @@
 }
 
 // Locked tiers
-.appmount-2ybxzl .tierBody-1d3UiS {
+.appMount-2yBXZl .tierBody-1d3UiS {
     background: transparent;
 }
 
 // App directory
-.appmount-2ybxzl .directoryModal-YJsOMv {
+.appMount-2yBXZl .directoryModal-YJsOMv {
     background: $background-color;
 }
 

diff --git a/scss/main/_topbar.scss b/scss/main/_topbar.scss
@@ -1,7 +1,7 @@
 @use "../top/var-scss" as *;
 
 // Title bar
-.appmount-2ybxzl .titleBar-1it3bQ::before {
+.appMount-2yBXZl .titleBar-1it3bQ::before {
     content: var(--pios-title-text, "piOS v2.1.01p");
     color: $dim-color;
     background: $background-color;

diff --git a/scss/overlay/_modal.scss b/scss/overlay/_modal.scss
@@ -10,14 +10,14 @@
 @use "../top/border" as bd;
 
 // Modals
-.appmount-2ybxzl .root-1CAIjD {
+.appMount-2yBXZl .root-1CAIjD {
     @include bd.border(thick $bright-color);
     background-color: $background-color;
     box-shadow: 0 0 30px 0 $dim-color;
 }
 
 // Footer
-.appmount-2ybxzl .footer-IubaaS {
+.appMount-2yBXZl .footer-IubaaS {
     background-color: $background-color;
     box-shadow: none;
     border-top: 2px dashed $border-color-normal;

diff --git a/scss/overlay/modal/_deletemessage.scss b/scss/overlay/modal/_deletemessage.scss
@@ -3,7 +3,7 @@
 
 // Delete message confirmation modal
 // Message view
-.appmount-2ybxzl .message-G6O-Wv {
+.appMount-2yBXZl .message-G6O-Wv {
     background-color: $background-color;
     box-shadow: none;
     @include bd.border(thick);

diff --git a/scss/overlay/modal/_event.scss b/scss/overlay/modal/_event.scss
@@ -4,7 +4,7 @@
 
 // Event and new event modal
 // Event card
-.appmount-2ybxzl .previewCard-E137i2,
+.appMount-2yBXZl .previewCard-E137i2,
 .card-8UsK4b {
     @include bd.border(thin);
 }