Skip to content

Commit

Permalink
Update readme and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Saltssaumure committed May 7, 2023
1 parent 53f135c commit e4ce6ae
Show file tree
Hide file tree
Showing 17 changed files with 170 additions and 134 deletions.
64 changes: 26 additions & 38 deletions Exponent.theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,55 +3,43 @@
* @author Saltssaumure
* @authorLink https://github.com/Saltssaumure
* @description A Windows XP style theme built for BetterDiscord.
* @license GPL-3.0
* @version 1.3
* @invite uy8nKQVatp
* @source https://github.com/Saltssaumure/xp-discord-theme
* @donate https://ko-fi.com/saltssaumure
*/

/*
Made by:
_______ _______ _ _________ _______ _______ _______ __ __ _______ _______
( ____ \( ___ )( \ \__ __/( ____ \( ____ \( ___ )|\ /|( \ / )|\ /|( ____ )( ____ \
| (____\/| (___) || | | | | (____\/| (____\/| (___) || | | || || || || | | || (____)|| (__ \/
(_____ )| ___ || | | | (_____ )(_____ )| ___ || | | || |(_)| || | | || __ __)| __)
/\____) || ) ( || (____/\| | /\____) |/\____) || ) ( || (___) || ) ( || (___) || ) \ \__| (____/\
\_______)|/ \|(_______/)_( \_______)\_______)|/ \|(_______)|/ \|(_______)|/ \__/(_______/
Licensed under GPL-3.0
Discord: Saltssaumure#7557
GitHub: https://github.com/Saltssaumure/xp-discord-theme
Join Salt's Discord Themes server: https://discord.gg/uy8nKQVatp
*/

@import url("https://saltssaumure.github.io/xp-discord-theme/xp.min.css");

:root
{
--background-image: url(https://saltssaumure.github.io/xp-discord-theme/img/bliss.jpg); /* Background image. Values: any image link encased in url(). */
--bsod-color: navy; /* BSOD background colour. Values: any valid keyword/RGBA/hex etc. colour. */
--bsod-text: "A problem has been detected and Windows has been shut down to prevent damage to your computer. \A\A A clock interrupt was not received on a secondary processor within the allocated time interval. \A\A If this is the first time you've seen this stop error screen, restart your computer. If this screen appears again, follow these steps: \A\A Check to make sure any new hardware or software is properly installed. If this is a new installation, ask your hardware or software manufacturer for any Windows updates you might need. \A\A If problems continue, disable or remove any newly installed hardware or software. Disable BIOS memory options such as caching or shadowing. If you need to use Safe Mode to remove or disable components, restart your computer, press F8 to select Advanced Startup Options, and then throw away the whole computer. \A\A Technical information: \A\A *** STOP: USING_DISCORD \A\A *** discord.exe - Address DEADBEEF base at 8BADF00D, DateStamp 1337C0D3 \A\A\A\A\A\A\A\A\A\A Collecting data for crash dump ... \A Initializing disk for crash dump ... \A Beginning dump of all your belongings ... \A Dumping physical memory to disk: 100% \A Physical memory dump complete. \A Contact your system administrator or technical support group for further assistance.";
/* See https://github.com/Saltssaumure/xp-discord-theme#customisation for customisation settings. */
:root {
--xp-background-image: url(https://saltssaumure.github.io/xp-discord-theme/img/bliss.avif);
--xp-background-color: #0066CC;
--bsod-color: navy;
--bsod-text: "A problem has been detected and Windows has been shut down to prevent damage to your computer. \A\A A clock interrupt was not received on a secondary processor within the allocated time interval. \A\A If this is the first time you've seen this stop error screen, restart your computer. If this screen appears again, follow these steps: \A\A Check to make sure any new hardware or software is properly installed. If this is a new installation, ask your hardware or software manufacturer for any Windows updates you might need. \A\A If problems continue, disable or remove any newly installed hardware or software. Disable BIOS memory options such as caching or shadowing. If you need to use Safe Mode to remove or disable components, restart your computer, press F8 to select Advanced Startup Options, and then throw away the whole computer. \A\A Technical information: \A\A *** STOP: USING_DISCORD \A\A *** discord.exe - Address DEADBEEF base at 8BADF00D, DateStamp 1337C0D3 \A\A\A\A\A\A\A\A\A\A Collecting data for crash dump ... \A Initializing disk for crash dump ... \A Beginning dump of all your belongings ... \A Dumping physical memory to disk: 100% \A Physical memory dump complete. \A Contact your system administrator or technical support group for further assistance.";
}

.theme-dark {
--xp-bg-color: #000;
--xp-bg-bright-color: #234;
--xp-bg-tint-color: #222;
--xp-bg-shade-color: #111;
--xp-txt-color: #FFF;
--xp-border-color: #1665CA;
--xp-set-color: #FFFFFFB3;
--xp-hover-color: #123;
--xp-zing-color: #A50;
--xp-bg-color: #000;
--xp-set-color: #FFFFFFB3;
--xp-hover-color: #123;
--xp-zing-color: #A50;
--xp-txt-color: #FFF;
--xp-bg-bright-color: #234;
--xp-bg-tint-color: #222;
--xp-bg-shade-color: #111;
--xp-border-color: #1665CA;
}

.theme-light {
--xp-bg-color: #FFF;
--xp-bg-bright-color: #F0EFED;
--xp-bg-tint-color: #EBE8D7;
--xp-bg-shade-color: #808080;
--xp-txt-color: #000;
--xp-border-color: #000;
--xp-set-color: #000000B3;
--xp-hover-color: #D3D3D3;
--xp-zing-color: #FFA500;
--xp-bg-color: #FFF;
--xp-set-color: #000000B3;
--xp-hover-color: #D3D3D3;
--xp-zing-color: #FFA500;
--xp-txt-color: #000;
--xp-bg-bright-color: #F0EFED;
--xp-bg-tint-color: #EBE8D7;
--xp-bg-shade-color: #808080;
--xp-border-color: #000;
}
133 changes: 90 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,109 @@
[light]: https://user-images.githubusercontent.com/29710355/229367843-ad03f107-ad47-4c63-9692-89cd781d40f8.png
[dark]: https://user-images.githubusercontent.com/29710355/229367846-78bf3675-a091-4f60-8ff0-4427697a2ef2.png
[bsod-text]: https://github.com/Saltssaumure/xp-discord-theme/blob/main/scss/top/_vars-scss.scss
[addons]: https://github.com/Saltssaumure/xp-discord-theme/tree/main/addon

[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 "Any amount is much appreciated!"

[shield-total-dl]: https://img.shields.io/github/downloads/saltssaumure/xp-discord-theme/total?color=purple&label=Total%20GitHub%20downloads&style=flat-square
[shield-asar-dl]: https://img.shields.io/github/downloads/saltssaumure/xp-discord-theme/latest/net.saltssaumure.Exponent.asar?color=purple&label=Replugged%20installs&style=flat-square
[shield-repo-size]: https://img.shields.io/github/repo-size/saltssaumure/xp-discord-theme?style=flat-square "Total size"

[license]: https://github.com/Saltssaumure/xp-discord-theme/blob/main/LICENSE
[issues]: https://github.com/Saltssaumure/xp-discord-theme/issues
[.theme.css]: https://github.com/Saltssaumure/xp-discord-theme/blob/main/Exponent.theme.css

[release-gh]: https://github.com/Saltssaumure/xp-discord-theme/releases/latest "Latest release"
[release-bd]: https://betterdiscord.app/theme/?id=823 "BetterDiscord store page"
[release-rp]: https://replugged.dev/install?identifier=Saltssaumure/xp-discord-theme&source=github "Replugged addon installer"

# Exponent Discord Theme
[![GitHub downloads](https://img.shields.io/github/downloads/saltssaumure/xp-discord-theme/total?color=purple&label=GitHub%20downloads&style=flat-square)](https://github.com/Saltssaumure/xp-discord-theme/releases/latest "Latest release")
![Total size](https://img.shields.io/github/repo-size/saltssaumure/xp-discord-theme?style=flat-square "Total size")
[![Donate via ko-fi][shield-donate]][ko-fi]
[![Total downloads][shield-total-dl]][release-gh]
[![Replugged installs][shield-asar-dl]][release-gh]
![Total size][shield-repo-size]

***A Windows XP style Discord theme.***

| Light mode | Dark mode |
| ---------- | --------- |
| ![Screenshot of Exponent Discord Theme applied to Discord desktop client ](https://user-images.githubusercontent.com/29710355/229367843-ad03f107-ad47-4c63-9692-89cd781d40f8.png) | ![Screenshot of Exponent Discord Theme applied to Discord desktop client](https://user-images.githubusercontent.com/29710355/229367846-78bf3675-a091-4f60-8ff0-4427697a2ef2.png) |
| Light mode | Dark mode |
| --------------------------------------------------------------- | ------------------------------------------------------------ |
| ![Screenshot of Exponent light mode applied to Discord ][light] | ![Screenshot of Exponent dark mode applied to Discord][dark] |

## Installation

### BetterDiscord
1. Install [BetterDiscord](https://betterdiscord.app/).
1. Install [BetterDiscord][BetterDiscord].
2. Download the theme file:
- [GitHub](https://github.com/Saltssaumure/xp-discord-theme/releases/latest)
- [BD Store](https://betterdiscord.app/theme/?id=823)
3. Place theme file in BetterDiscord'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/xp-discord-theme/releases/latest)
- [Replugged.dev](https://replugged.dev/install?identifier=Saltssaumure/xp-discord-theme&source=github)

## Customisation (BetterDiscord only)

### Addons
- [ExponentBgImageAddon](https://raw.githubusercontent.com/Saltssaumure/xp-discord-theme/main/addon/ExponentBgImageAddon.theme.css) - enables custom background image in the main window.

### Settings
1. Open `Settings` > `Themes` menu in Discord.
2. Click pencil icon on this theme.
3. Customise the variable values. See table below for reference.
4. Save changes and enjoy.

| Description | Variable name | Valid values | Default value |
|-----------------------------|------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------|
| Wallpaper image | `--background-image` | Any image link wrapped encased in `url()`. | `url(https://saltssaumure.github.io/xp-discord-theme/img/bliss.jpg)` |
| BSOD background colour | `--bsod-color` | Any CSS-recognised colour. | `navy` |
| BSOD text | `--bsod-text` | Any quoted text. Use `\A` for new lines. | [Read here](https://github.com/Saltssaumure/xp-discord-theme/blob/main/scss/top/_vars-css.scss) |
| Panel background colour | `--xp-bg-color` | Any CSS-recognised colour. | `#000` (dark) / `#FFF` (light) |
| Button highlight colour | `--xp-bg-bright-color` | Any CSS-recognised colour. | `#203040` (dark) / `#F0EFED` (light) |
| Button background colour | `--xp-bg-tint-color` | Any CSS-recognised colour. | `#202020` (dark) / `#EBE8D7` (light) |
| Button shadow colour | `--xp-bg-shade-color` | Any CSS-recognised colour. | `#101010` (dark) / `#808080` (light) |
| Panel text colour | `--xp-txt-color` | Any CSS-recognised colour. | `#FFF` (dark) / `#000` (light) |
| Button/panel border colour | `--xp-border-color` | Any CSS-recognised colour. | `#1665CA` (dark) / `#000000` (light) |
| Panel settings icon colour | `--xp-set-color` | Any CSS-recognised colour. | `#FFFFFFB3` (dark) / `#000000B3` (light) |
| Panel hovered item colour | `--xp-hover-color` | Any CSS-recognised colour. | `#102030` (dark) / `#D3D3D3` (light) |
| Panel top decoration colour | `--xp-zing-color` | Any CSS-recognised colour. | `#A05000` (dark) / `#FFA500` (light) |
- [GitHub][release-gh]
- [Installer][release-rp]

### Vencord
1. Install [Vencord][Vencord].
2. Paste the following in `Settings` > `Vencord` > `Themes`:
- `https://saltssaumure.github.io/xp-discord-theme/Exponent.theme.css`

## Customisation

| Description | Variable name | Valid values | Default value |
| --------------------------- | ----------------------- | ------------------------------------------ | -------------------------------------------------------------------- |
| Background image | `--xp-background-image` | Any image link encased in `url()`. | `url(https://saltssaumure.github.io/xp-discord-theme/img/bliss.avif)` |
| Background colour | `--xp-background-color` | Any [colour][css-color]. | `#003300` |
| BSOD background colour | `--bsod-color` | Any [colour][css-color]. | `navy` |
| BSOD text | `--bsod-text` | Any quoted text. Use `\A` for new lines. | [Read here][bsod-text]. |
| Panel background colour | `--xp-bg-color` | Any [colour][css-color]. | `#000` (dark) / `#FFF` (light) |
| Panel settings icon colour | `--xp-set-color` | Any [colour][css-color]. | `#FFFFFFB3` (dark) / `#000000B3` (light) |
| Panel hovered item colour | `--xp-hover-color` | Any [colour][css-color]. | `#102030` (dark) / `#D3D3D3` (light) |
| Panel top decoration colour | `--xp-zing-color` | Any [colour][css-color]. | `#A05000` (dark) / `#FFA500` (light) |
| Panel text colour | `--xp-txt-color` | Any [colour][css-color]. | `#FFF` (dark) / `#000` (light) |
| Button highlight colour | `--xp-bg-bright-color` | Any [colour][css-color]. | `#203040` (dark) / `#F0EFED` (light) |
| Button background colour | `--xp-bg-tint-color` | Any [colour][css-color]. | `#202020` (dark) / `#EBE8D7` (light) |
| Button shadow colour | `--xp-bg-shade-color` | Any [colour][css-color]. | `#101010` (dark) / `#808080` (light) |
| Button/panel border colour | `--xp-border-color` | Any [colour][css-color]. | `#1665CA` (dark) / `#000000` (light) |

### BetterDiscord
1. Open `Settings` > `BetterDiscord` > `Themes`.
2. Click the pencil icon on this theme.
3. Edit the variable values and save changes.

### Replugged
1. Open `Settings` > `Replugged` > `Quick CSS`.
3. Copy and paste lines 15-45 of [`Exponent.theme.css`][.theme.css].
3. Edit the variable values and apply changes.

### 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-45 of [`Exponent.theme.css`][.theme.css].
4. Edit the variable values.

## Addons
See [Addons][addons] for mini-themes designed to be used alongside Exponent to add extra optional features.

## License
- **Whole theme:** [GNU General Public License v3.0](https://github.com/Saltssaumure/xp-discord-theme/blob/main/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.
- **[HorizontalServerList](https://github.com/DiscordStyles/HorizontalServerList):** [MIT License](https://github.com/DiscordStyles/HorizontalServerList/blob/master/LICENSE.md)
[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/xp-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].
27 changes: 4 additions & 23 deletions addon/ExponentBgImageAddon.theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,19 @@
* @name Exponent Background Image Addon
* @author Saltssaumure
* @authorLink https://github.com/Saltssaumure
* @description Customisable inner background image for Exponent theme: https://github.com/Saltssaumure/xp-discord-theme
* @description Customisable main inner window background image for Exponent: https://github.com/Saltssaumure/xp-discord-theme
* @license GPL-3.0
* @version 1.0
* @invite uy8nKQVatp
* @source https://github.com/Saltssaumure/xp-discord-theme
* @donate https://ko-fi.com/saltssaumure
*/

/*
Made by:
_______ _______ _ _________ _______ _______ _______ __ __ _______ _______
( ____ \( ___ )( \ \__ __/( ____ \( ____ \( ___ )|\ /|( \ / )|\ /|( ____ )( ____ \
| (____\/| (___) || | | | | (____\/| (____\/| (___) || | | || || || || | | || (____)|| (__ \/
(_____ )| ___ || | | | (_____ )(_____ )| ___ || | | || |(_)| || | | || __ __)| __)
/\____) || ) ( || (____/\| | /\____) |/\____) || ) ( || (___) || ) ( || (___) || ) \ \__| (____/\
\_______)|/ \|(_______/)_( \_______)\_______)|/ \|(_______)|/ \|(_______)|/ \__/(_______/
Licensed under GPL-3.0
Discord: Saltssaumure#7557
GitHub: https://github.com/Saltssaumure/xp-discord-theme
Join Salt's Discord Themes server: https://discord.gg/uy8nKQVatp
*/

@import url("https://saltssaumure.github.io/xp-discord-theme/addon/xp-bg-image.css");

/* USER EDITABLE VARIABLES
* --xp-bg-addon-image: Image URL, or `none` for transparent background.
* --xp-bg-addon-luminosity: 0-100% - 0 for black, 100% = white, in-between for greys. OPTIONAL.
* --xp-bg-addon-opacity: 0-1 - 0 for fully transparent, 1 for fully opaque. OPTIONAL.
*/

/* See https://github.com/Saltssaumure/xp-discord-theme/tree/main/addon#ExponentBgImageAddon for customisation settings. */
:root {
--xp-bg-addon-image: url(https://saltssaumure.github.io/xp-discord-theme/img/bliss.jpg);
--xp-bg-addon-image: url(https://saltssaumure.github.io/xp-discord-theme/img/bliss.avif);
/* --xp-bg-addon-luminosity: 0%; */
/* --xp-bg-addon-opacity: 0.4; */
}
Loading

0 comments on commit e4ce6ae

Please sign in to comment.