From 557488dc8ff4f8b2c63d0e971877ee853956706b Mon Sep 17 00:00:00 2001 From: Saltssaumure Date: Mon, 14 Aug 2023 06:19:00 +0100 Subject: [PATCH] Update readme --- README.md | 63 +++++++++++++++++++++++++++++++-------------------- manifest.json | 4 ++-- package.json | 3 ++- 3 files changed, 42 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index ab0b510..9c17e21 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -[screenshot-old]: https://user-images.githubusercontent.com/29710355/123527529-72121600-d6d8-11eb-9580-da3987ee8398.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 @@ -51,7 +50,7 @@ [![Replugged GitHub downloads][shield-asar-dl]][release-rp-gh] [![Total repository size][shield-repo-size]][github] -***A SUPERHOT piOS inspired Discord theme.*** +***A customisable SUPERHOT piOS inspired Discord theme.*** | Dark mode | Light mode | | ------------------------------------------ | -------------------------------------------- | @@ -59,25 +58,35 @@ ## Installation -### BetterDiscord -1. Install [BetterDiscord][BetterDiscord]. -2. Download the theme file: +### [BetterDiscord][BetterDiscord] +1. Download `piOS.theme.css`: - [BetterDiscord store][release-bd] - [GitHub][release-bd-gh] -3. Place theme file in the `themes` folder: - - Windows: `%AppData%/BetterDiscord/themes` - - Mac: `~/Library/Application Support/betterdiscord/themes` - - Linux: `~/.config/BetterDiscord/themes` +2. Place the file in the themes folder: + - `Settings` > `BetterDiscord` > `Themes` > `Open Themes Folder` +3. Toggle on the theme card. -### Replugged -1. Install [Replugged][Replugged]. -2. Install the theme: +### [Replugged][Replugged] +#### Automatic +1. Click to install: - [Replugged store][release-rp] +#### Manual +1. Download `net.saltssaumure.piOS.asar`: - [GitHub][release-rp-gh] +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 -1. Install [Vencord][Vencord]. -2. Paste the following in `Settings` > `Vencord` > `Themes`: +### [Vencord][Vencord] +#### Local +1. Download `piOS.theme.css`: + - [BetterDiscord store][release-bd] + - [GitHub][release-bd-gh] +2. Place the file in the themes folder: + - `Settings` > `BetterDiscord` > `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://saltssaumure.github.io/pios-discord-theme/piOS.theme.css` ## Customisation @@ -112,23 +121,27 @@ 3. Edit the variable values and save changes. ### Replugged +1. Enable `Automatically Apply Quick CSS` in `Settings` > `Replugged` > `General`. 1. Open `Settings` > `Replugged` > `Quick CSS`. -2. Copy and paste lines 15-40 of [`piOS.theme.css`][.theme.css]. -3. Edit the variable values and apply changes. +3. Copy and paste line 15-20 of [`piOS.theme.css`][.theme.css]. +3. Edit the variable values and save. ### Vencord -#### Standard method -1. Follow the instructions in `Settings` > `Vencord` > `Themes`. -#### Recommended method -1. Open `Settings` > `Vencord` > `Vencord`. -2. Toggle on `Enable Custom CSS` and click `Open QuickCSS File`. -3. Copy and paste lines 15-40 of [`piOS.theme.css`][.theme.css]. -4. Edit the variable values. +#### Local +2. `Open Themes Folder` in `Settings` > `BetterDiscord` > `Themes` > `Local Themes` +3. Open `piOS.theme.css` with your favourite text editor. +4. Edit the variable values and save. +#### Online +1. `Enable Custom CSS` in `Settings` > `Vencord` > `Vencord` and click `Open QuickCSS File`. +2. Copy and paste lines 15-20 of [`piOS.theme.css`][.theme.css]. +3. Edit the variable values. ## License [GNU General Public License v3.0][license] - TL;DR;NAL: Do whatever you want with this theme, as long as you allow others to do the same with your version. +### [RadialStatus](https://github.com/DiscordStyles/RadialStatus) +[MIT License](https://github.com/DiscordStyles/RadialStatus/blob/master/LICENSE.md) ## Questions or suggestions? - Post [an issue][issues] on GitHub. -- Post in `#theme-support` on [my support server][discord]. +- Post in `#theme-support` on [my support server][discord]. \ No newline at end of file diff --git a/manifest.json b/manifest.json index d0d9666..29e91eb 100644 --- a/manifest.json +++ b/manifest.json @@ -15,11 +15,11 @@ "license": "GPL-3.0", "type": "replugged-theme", "main": "scss/pios.scss", + "source": "https://github.com/Saltssaumure/pios-discord-theme", "image": [ "https://cdn.discordapp.com/attachments/946226984005025835/1129611060094177352/pios1.png", "https://cdn.discordapp.com/attachments/946226984005025835/1129611060454891561/pios2.png", "https://cdn.discordapp.com/attachments/946226984005025835/1129611060748484608/pios3.png", "https://cdn.discordapp.com/attachments/946226984005025835/1129611059829932052/pios4.png" - ], - "source": "https://github.com/Saltssaumure/pios-discord-theme" + ] } diff --git a/package.json b/package.json index e3f92c5..425f88a 100644 --- a/package.json +++ b/package.json @@ -9,9 +9,10 @@ "scripts": { "dev": "bd-scss dev", "bd": "bd-scss build", + "dev:rp": "replugged build theme --watch", "rp": "replugged bundle theme", "lint": "prettier ./scss --check", - "lint:fix": "prettier ./scss --write" + "lint:fix": "prettier ./scss --write --log-level warn" }, "type": "module", "dependencies": {