Red-DiscordBot Cog

Red-DiscordBot Cog metadata file

Type object
File match info.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/red-discordbot-cog/latest.json
Source https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/V3/develop/schema/red_cog.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

author string[]

List of names of authors of the cog

description string

A long description of the cog or repo. For cogs, this is displayed when a user executes [p]cog info.

install_msg string

The message that gets displayed when a cog is installed or a repo is added

short string

A short description of the cog or repo. For cogs, this info is displayed when a user executes [p]cog list

end_user_data_statement string

A statement explaining what end user data the cog is storing. This is displayed when a user executes [p]cog info. If the statement has changed since last update, user will be informed during the update.

min_bot_version string

Min version number of Red in the format MAJOR.MINOR.MICRO

pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)((a|b|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?$
max_bot_version string

Max version number of Red in the format MAJOR.MINOR.MICRO, if min_bot_version is newer than max_bot_version, max_bot_version will be ignored

pattern=^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)((a|b|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?$
min_python_version integer[]

Min version number of Python in the format [MAJOR, MINOR, PATCH]

minItems=3maxItems=3
hidden boolean

Determines if a cog is visible in the cog list for a repo.

disabled boolean

Determines if a cog is available for install.

required_cogs object
requirements string[]

List of required libraries that are passed to pip on cog install.

tags string[]

A list of strings that are related to the functionality of the cog. Used to aid in searching.

uniqueItems=true
type string

Optional, defaults to COG. Must be either COG or SHARED_LIBRARY. If SHARED_LIBRARY then hidden will be True.

Values: "COG" "SHARED_LIBRARY"

Definitions

required_cog object