Go to file

Qb 99ad2269ac Add Translations section to CONTRIBUTING.md (#1367 ) As was correctly pointed out in #1356 there is no documentation about how to submit translations in the contributing guide or the readme.		2022-08-31 11:59:53 -04:00
.github	Wrap with try..catch	2020-07-27 12:41:14 -04:00
assets	Remove autoreload option	2022-08-07 17:26:47 -04:00
common	Add devtools listener setting	2022-01-26 12:12:40 -05:00
injector	Small bugfixes	2022-06-27 17:12:47 -04:00
renderer	Documentation fixes & consistency improvements (#1378 )	2022-08-31 11:59:17 -04:00
scripts	Audit and fix inject	2022-06-25 02:59:23 -04:00
tests	Restructure BD into a small mono-repo	2021-03-06 03:30:16 -05:00
.eslintrc	Limit warning logs from webpack	2022-08-05 19:25:16 -04:00
.gitignore	Adds some final touches	2020-07-30 11:34:59 -04:00
.travis.yml	Removes gulp dependency	2020-10-24 20:10:46 -04:00
CHANGELOG.md	Update changelog and version	2022-08-16 20:37:03 -04:00
CONTRIBUTING.md	Add Translations section to CONTRIBUTING.md (#1367 )	2022-08-31 11:59:53 -04:00
LICENSE	Audit and fix inject	2022-06-25 02:59:23 -04:00
README.md	Update the README (#846 ) @dav1312	2022-06-25 02:39:23 -04:00
lgtm.yml	more devops/ci stuff	2020-07-24 00:07:50 -04:00
package-lock.json	Add JSDoc to plugin api	2022-08-02 18:51:43 -04:00
package.json	Update changelog and version	2022-08-16 20:37:03 -04:00

README.md

BetterDiscord

BetterDiscord is a client modification for Discord. This allows you to add plugins and themes to your personal copy of Discord. BetterDiscord also adds a number of other features out of the box.

Installation

Auto Installers

Manual Installation

For normal users, installing via the installers makes the most sense. However when wanting to either develop BetterDiscord, or when the installers do not work, this option can be used.

Prerequisites

Git
Node.js with npm.
Command line of your choice.

1: Clone the repository

git clone https://github.com/BetterDiscord/BetterDiscord.git

2: Install dependencies

npm install

3: Run Build Script

This will create a injector.js, preload.js, and renderer.js in the dist folder.

npm run build

4: Inject into your Discord client

Install to Stable

npm run inject

Install to PTB

npm run inject ptb

Install to Canary

npm run inject canary

Additional Scripts

Compiling & Distribution

This will create a betterdiscord.asar file in the dist folder.

npm run dist

FAQ

What is this?

This is a client modification for Discord. It allows you to add plugins and themes to your client. Plugins can add functionality and useful features. Themes can completely change the look and feel of Discord.

BD has some other built-in features such as Emotes from Twitch, FFZ, and BBTV, as well as an in-client server browser.

Where can I get plugins and themes?

The easiest way to find plugins and themes is to browse them on our website: https://betterdiscord.app/. Additionally, in our support servers we have channels with lists of official plugins and themes.