Theme template for Replugged
Go to file
delta 8d42ec624f init 2023-01-24 04:35:59 +01:00
.github/workflows Theme template woo! [WIP] 2022-12-16 12:29:34 -06:00
.vscode Theme template woo! [WIP] 2022-12-16 12:29:34 -06:00
scripts init 2023-01-24 04:35:59 +01:00
src init 2023-01-24 04:35:59 +01:00
.gitignore Theme template woo! [WIP] 2022-12-16 12:29:34 -06:00
.prettierrc.json Theme template woo! [WIP] 2022-12-16 12:29:34 -06:00
README.md await >>> 2023-01-09 22:28:24 -06:00
manifest.json init 2023-01-24 04:35:59 +01:00
package.json Use flag for --no-install 2022-12-18 13:31:37 -06:00
pnpm-lock.yaml Add tsx 2022-12-16 13:29:35 -06:00

README.md

Replugged theme template

Use this template

Prerequisites

Install

  1. Create a copy of this template
  2. Clone your new repository and cd into it
  3. Install dependencies: pnpm i
  4. Build the theme: pnpm run build
  5. Reload Discord to load the theme

The unmodified theme replaces the Discord font with the old Whitney font. Credit to @overimagine1 for the snippet!

Development

The code must be rebuilt after every change. You can use pnpm run watch to automatically rebuild the theme when you save a file.

Building using the script above will automatically install the updated version of the theme in Replugged. You can find the theme folder directories for your OS here.
If you don't want to install the updated version, append the --no-install flag: pnpm run build --no-install.

You can format the code by running pnpm run lint:fix. The repository includes VSCode settings to automatically format on save.

API docs coming soon(tm)

Distribution

For theme distribution, Replugged uses bundled .asar files. Bundled themes can be installed to the same theme folder as listed above.

This repository includes a GitHub workflow to compile and publish a release with the asar file. To trigger it, create a tag with the version number preceded by a v (e.g. v1.0.0) and push it to GitHub:

git tag v1.0.0
git push --tags

The Replugged updater (coming soon™) will automatically check for updates on the repository specified in the manifest. Make sure to update it to point to the correct repository!

You can manually compile the asar file with pnpm run build-and-bundle.

Troubleshooting

Make sure Replugged is installed and running.

Open Discord settings and make sure the Replugged tab is there. If not, follow these instructions to install Replugged.

Make sure the theme is installed.

Check the theme folder for your OS and make sure the theme is there. If not, make sure you have built the theme and that the NO_INSTALL environment variable is not set.
You can run await replugged.themes.list() in the console to see a list of themes in the theme folder.