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

Updated Plugin and Theme METAs (markdown)

Zack 2022-08-09 13:56:08 -04:00
parent cbec29ee42
commit 53f74882f3
1 changed files with 1 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
Plugin-and-Theme-METAs.md

@ -1,79 +1 @@
# Overview
Theme and plugin METAs are used to provide info about a theme or plugin to BandagedBD.
In order to be recognized theme and plugin files must have a META on the first line.
# Format
```js
/**
* @name PluginOrThemeName
* @version 0.0.1
* @description Just a simple description of the content that may
* end up being pretty long
*
* @website http://twitter.com/BandagedBD
*/
```
# Fields
## Common Fields
These fields are common between both plugins and themes.
|Name|Description|
|-|:-|
|`name`|The name of the plugin or theme.|
|`description`|A description of the plugin or theme.|
|`author`|The author of the plugin or theme.|
|`authorLink`|A link to use for clicking the author's name on the plugin or plugin or theme.|
|`authorId`|Snowflake ID for the author. **Note:** Setting this value will allow users to DM you by clicking your name on the plugin/theme card.|
|`version`|The version of the plugin or theme.|
|`updateUrl`|The url to check for addon updates (usually a github raw link).|
|`website`|A website URL leading to a website pertaining to the theme or plugin (e.g. The website of the author).|
|`source`|A URL leading to the source of the theme or plugin (on GitHub or hosted elsewhere).|
|`invite`|An invite code for your support server (just the code, not the full discord.gg link).|
|`donate`|Link to a donation page for the content author (often PayPal).|
|`patreon`|Patreon link to a creator's patreon page.|
## Plugins
The following fields are required for plugins:
|Name|Description|
|-|:-|
|`name`|The object name of the plugin. (This is **required** and must match the plugin's variable name. Note: "matching" is NOT REQUIRED if the plugin is exported via `module.exports`)|
A minimal META for plugins would look like the following:
```js
/**
* @name Plugin Name
*/
Fields like description, version, and author are recommended to be added here as well. However, you can also use the `getName`-type methods in plugins.
```
## Themes
The following fields are required for themes:
|Name|Description|
|-|:-|
|`name`|The name of the theme.|
|`description`|A description of the theme.|
|`author`|The author of the theme.|
|`version`|The version of the theme.|
A minimal META for themes would look like the following:
```js
/**
* @name Theme Name
* @author myself
* @description A cool beginner theme
* @version 1.2.5
*/
```
# Documentation has moved to https://docs.betterdiscord.app/plugins/introduction/structure#meta