# bd-scss

> Simple package to create themes using SCSS for BetterDiscord.

Latest version **3.0.8** (published 2026-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install bd-scss
pnpm add bd-scss
yarn add bd-scss
bun add bd-scss
```

Provides the command `bd-scss`.

## Health

**Score 50/100 (C)** — status: stable.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 3.0.8 |
| Published | 2026-01-26 |
| First published | 2022-01-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 6 |
| Unpacked size | 59.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Gibbu |
| Maintainers | gibbu |
| Keywords | bd-scss, betterdiscord, sass, scss |

## Links

- npm: https://www.npmjs.com/package/bd-scss
- Repository: https://github.com/Gibbu/bd-scss
- Homepage: https://github.com/Gibbu/bd-scss#readme
- Issues: https://github.com/Gibbu/bd-scss/issues
- npm.io page: https://npm.io/package/bd-scss

## Dependencies (6)

- [sade](https://npm.io/package/sade.md) ^1.8.1
- [sass](https://npm.io/package/sass.md) ^1.85.1
- [kleur](https://npm.io/package/kleur.md) ^4.1.5
- [postcss](https://npm.io/package/postcss.md) ^8.5.3
- [chokidar](https://npm.io/package/chokidar.md) ^4.0.3
- [autoprefixer](https://npm.io/package/autoprefixer.md) ^10.4.20

## Recent versions

- 3.0.8 (latest) — 2026-01-26
- 3.0.7 — 2025-09-15
- 3.0.6 — 2025-09-15
- 3.0.5 — 2025-03-26
- 3.0.4 — 2025-03-26
- 3.0.3 — 2025-03-26
- 3.0.2 — 2025-03-26
- 3.0.1 — 2025-03-26
- 3.0.0 — 2025-03-26
- 2.1.0 — 2025-03-05
- 2.0.15 — 2024-06-18
- 2.0.14 — 2023-06-11
- 2.0.13 — 2023-06-09
- 2.0.12 — 2022-11-13
- 2.0.11 — 2022-09-26
- … 22 more at https://npm.io/package/bd-scss/versions

## README

# bd-scss

Simple package to create themes for BetterDiscord using SCSS.

> I highly recommend using the CLI I built has it does all the instructions for you: [gibbu/create-bd-theme](https://github.com/Gibbu/create-bd-theme)

<br>

## Usage

Install the package with:

```bash
npm install bd-scss
# or
yarn add bd-scss
# or
pnpm add bd-scss
# or
bun add bd-scss
```

Then create a `bd-scss.config.js` file in the root of your project folder with the following:

```js
/** @type {import('bd-scss/lib/config').Config} */
export default {
	meta: {
		name: 'Cooltheme',
		author: 'Gibbu',
		version: '1.0.0',
		description: 'My cool theme',
		source: 'https://github.com/Gibbu/Cooltheme'
	}
};
```

And then use the `bd-scss` command followed by the script you wish to use.

```bash
bd-scss dev # will build to your BetterDiscord themes folder or if you've provided a path in the `betterdiscord.themeFolder` option.

bd-scss build # will build the necessary files to distribute your theme.
```

> **NOTE**: Make sure you have `"type": "module"` set in your `package.json`.

<br>

## Compiler API

| Property        | Type                 | Required | Description                                                                                                                                    |
| --------------- | -------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `meta`          | Object               | true     | The BetterDiscord theme/plugin META. View all avaiable meta [HERE](https://github.com/BetterDiscord/BetterDiscord/wiki/Plugin-and-Theme-METAs) |
| `main`          | string               | false    | The entry point to the theme.                                                                                                                  |
| `root`          | string               | false    | the root file that contains all your public facing variables.                                                                                  |
| `github`        | string \| Object     | false    | The github profile to point to when building.                                                                                                  |
| `imports`       | (string \| Object)[] | false    | Any **external** imports that should be imported with the theme.                                                                               |
| `addons`        | (string \| Object)[] | false    | Any files that should be compiled with your theme.                                                                                             |
| `betterdiscord` | Object               | false    | Settings for the BetterDiscord client mod                                                                                                      |
| `vencord`       | Object               | false    | Settings for the Vencord client mod                                                                                                            |

<br>

## Examples

- [DiscordStyles/SoftX](https://github.com/DiscordStyles/SoftX)
- [DiscordStyles/Slate](https://github.com/DiscordStyles/Slate)

<br>

## License

See the [LICENSE](https://github.com/Gibbu/bd-scss/blob/main/LICENSE) file for license rights and limitations (MIT).

---
_Source: https://npm.io/package/bd-scss · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
