lightcordwarez
/
BetterDiscordApp-rauenzi
mirror of https://github.com/rauenzi/BetterDiscordApp.git
1
0
Fork 0
Code Issues 3 Releases Wiki Activity

BandagedBD -> BetterDiscord

Zack 2021-08-06 13:31:18 -04:00
parent f80d2234e3
commit b912d64d47
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Creating-Plugins.md

@ -1,6 +1,6 @@
# Overview
1. BandagedBD plugins are limited to a single file.
1. BetterDiscord plugins are limited to a single file.
2. The file must be named as `pluginname.plugin.js`, the plugin name can be whatever you want.
3. Plugin files require a special header ([[see this page for details|Plugin-and-Theme-METAs]])
4. The name defined in the header must match the variable/classname
@ -18,7 +18,7 @@ For those using TypeScript you can use [this](https://www.npmjs.com/package/@typ
## Plugins require a special header
BandagedBD requires information at the beginning of a plugin file to identify it. Please view the [[Plugin and Theme METAs|Plugin and Theme METAs]] page for information on that.
BetterDiscord requires information at the beginning of a plugin file to identify it. Please view the [[Plugin and Theme METAs|Plugin and Theme METAs]] page for information on that.
## Required Functions
@ -131,12 +131,12 @@ An instance of [AddonAPI](#addonapi) to access themes.
***
#### `settings`
Gives access to BBD's internal settings object and is therefore subject to change.
Gives access to BetterDiscord's internal settings object and is therefore subject to change.
***
#### `emotes`
Gives access to BBD's internal emotes object and is therefore subject to change.
Gives access to BetterDiscord's internal emotes object and is therefore subject to change.
***
@ -182,7 +182,7 @@ Deletes some saved data for plugin `pluginName` with key `key`.
***
#### `disableSetting([collection,] category, id)`
Disables a BBD setting by id.
Disables a BetterDiscord setting by id.
|Parameter|Type|Description|
|-|-|:-|
@ -193,7 +193,7 @@ Disables a BBD setting by id.
***
#### `enableSetting([collection,] category, id)`
Enables a BBD setting by id.
Enables a BetterDiscord setting by id.
|Parameter|Type|Description|
|-|-|:-|
@ -259,9 +259,9 @@ Searches for an internal Discord webpack module with a specific `displayName` va
***
#### `getCore()`
Returns BandagedBD's instance of the core module. Only use this if you know what you are doing.
Returns BetterDiscord's instance of the core module. Only use this if you know what you are doing.
**@Returns** `{Core}` - BBD's instantiated core module.
**@Returns** `{Core}` - BD's instantiated core module.
***
@ -448,7 +448,7 @@ Determines if the input is valid and parseable JSON.
***
#### `toggleSetting(id)`
Toggles a BBD setting by id.
Toggles a BetterDiscord setting by id.
|Parameter|Type|Description|
|-|-|:-|