Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 2.93 KB

README.md

File metadata and controls

92 lines (63 loc) · 2.93 KB

BetterDiscordPlugins

A collection of plugins for the @BetterDiscord client modification.

Overview

BiggerStreamPreview (download | more details)

Allows you see to see bigger previews of streams via the context menu.

WhoReacted (download | more details)

Shows the avatars of the users who reacted to a message.

SecretRingTone (download | more details)

Makes the discord Easter Egg ringtone the default one.

GuildProfile (download | more details)

Adds a modal that can be opened via any guild menu and contains various information about the guild, such as its owner, creation date, joined date, your friends and blocked users who are in it, and much more.

Development

This section is designed for people who are willing to contribute or want to modify the source code for personal use. Here you can find all the information for developing and building locally.

Prerequisites

Scripts

yarn dev

Watches for any changes and automatically builds the plugins directly to your plugins folder.

yarn build

Builds the plugins for distribution.

yarn lint

Lints your changes using ESLint.

yarn lint:fix

Same as above but also tries to fix any problems.

Getting started

Run these commands using any command line tool of your choice.

# Clone the repository and navigate to its directory.
git clone https://github.com/jaimeadf/BetterDiscordPlugins && cd BetterDiscordPlugins

# Install all dependencies.
yarn install

# Run the dev script.
yarn dev

# Happy coding 🎉!

Contributing

All contributions are welcome, whether they're a bug fix, a new feature, or even just a typo correction. Only make sure to always target the develop branch and don't commit your dist folder, GitHub Actions takes care of the entire building process for us.