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 2020-11-07 17:09:32 -05:00
parent df52e55794
commit e77ac047b4
1 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
Plugin-and-Theme-METAs.md

@ -6,20 +6,6 @@ In order to be recognized theme and plugin files must have a META on the first l
# Format
## Traditional Format
The basic format of a META is as such:
```js
//META{"name":"Theme or Plugin Name"}*//
```
## New Format (Beta)
This is a new format developed jointly between Zerebos and Qwerasd with some input from square. Please note that there may be some unexpected issues that get solved as time goes on.
The new format of a META is as such:
```js
/**
* @name PluginOrThemeName
@ -39,31 +25,39 @@ 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.|
|`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.|
|`authorLink`|A link to use for clicking the author's name on the 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.|
## Plugins
The following fields can be defined in a META:
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 there's a module export.)|
|`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
//META{"name":"PluginName"}*//
/**
* @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 can be defined in a theme META:
The following fields are required for themes:
|Name|Description|
|-|:-|
@ -75,5 +69,10 @@ The following fields can be defined in a theme META:
A minimal META for themes would look like the following:
```js
//META{"name":"Theme Name","author":"me","version":"0.0.6","description":"This theme makes things look better."}*//
/**
* @name Theme Name
* @author myself
* @description A cool beginner theme
* @version 1.2.5
*/
```