From 53f74882f31567662ef24c12a77c109b3c00f318 Mon Sep 17 00:00:00 2001 From: Zack Date: Tue, 9 Aug 2022 13:56:08 -0400 Subject: [PATCH] Updated Plugin and Theme METAs (markdown) --- Plugin-and-Theme-METAs.md | 80 +-------------------------------------- 1 file changed, 1 insertion(+), 79 deletions(-) diff --git a/Plugin-and-Theme-METAs.md b/Plugin-and-Theme-METAs.md index 9a28982..0579a05 100644 --- a/Plugin-and-Theme-METAs.md +++ b/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 - */ -``` \ No newline at end of file +# Documentation has moved to https://docs.betterdiscord.app/plugins/introduction/structure#meta \ No newline at end of file