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

add link to meta page

Zack 2018-08-27 20:44:40 -04:00
parent 63a89fc3c6
commit 203ffb10b1
1 changed files with 2 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Creating-Plugins.md

@ -2,7 +2,7 @@
1. BandagedBD 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 below](#plugins-require-a-special-header)).
3. Plugin files require a special header ([see this page](Plugin and Theme METAs)).
4. The name defined in the header must match the variable/classname
5. Plugins must implement the [following functions](#required-functions): `getName`, `getDescription`, `getVersion`, `getAuthor`, `start` and `stop`.
Optionally, you may implement `load` and `observer`. More details on each function below.
@ -15,19 +15,7 @@ Take a look at this [Example](https://gist.github.com/rauenzi/e5f4d02fc3085a5387
## Plugins require a special header
BandagedBD requires one line at the beginning of a plugin file to identify it:
```js
//META{"name":"testPlugin"}*//
```
Be sure that `testPlugin` matches the variable name defined in the file. Without this, your plugin will not be identified by BD properly and will not show up in the list.
Optionally you can also include a website and source field in the meta like this example from ImageToClipboard:
```js
//META{"name":"ImageToClipboard","website":"https://github.com/rauenzi/BetterDiscordAddons","source":"https://github.com/rauenzi/BetterDiscordAddons/tree/master/Plugins/ImageToClipboard"}*//
```
BandagedBD requires one line 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