Appearance

Overview ​

Plugins are a type of addon that focus on functionality by adding something new to the Discord client. This could be as simple as a button that says hello, or basic end-to-end ecryption. Plugins can also modify existing functionality in the client like altering exisiting buttons to perform different actions, or even remove functionality entirely. All of this is done using JavaScript with minimal requirements to allow for personal preference and style in programming.

TIP

This documentation and the accompanying guides assume you already know JavaScript and are familiar with the modern JavaScript constructs and concepts. If you're not, check out the resources section below!

These docs consist of this introduction which gives you an idea of what to expect, an overview on plugins and the development environment, a few guides, and an API reference.

The Introduction section gives a lot of background information on plugins requirements, the development environment, and the tools at your disposal.

The Tutorials section walks you through the basics of making plugins including code snippets and explanation. It also goes over most of what BdApi has to offer.

The Concepts guide goes more in depth with advanced concepts that are important to making good and complicated plugins that smoothly integrate into Discord.

The API Reference section is purely a reference to what APIs are available, the parameters and return types of any functions, and descriptions of their properties. If you've seen any code documentation before, this will look familiar.

Lastly the Discord Internals section is a reference that goes hand-in-hand with the advanced guide. It's an ever-changing reference point of what is available for use within Discord's code.

Resources ​

The following resources will be handy for learning and reference: