Embeds Module
The Embeds Module is used to create and manage embeds within the server. In a Discord context, an "embed" is a special type of message that is formatted to look like a card. Embeds are used to create rich, interactive messages that can be used to display information in a visually appealing manner.
This page is intended to provide a comprehensive guide to the Embeds Module and its various features. If you want to follow a step-by-step guide on how to create and manage embeds, please refer to the following tutorials:
Overview
Each embed object contains the following major data groups that may be edited. Each group is explained further in depth below.
- Details - Things like title, description, and color.
- Header - This is typically used to display the author of the message.
- Footer - This is typically used to display the source of the information.
- Images - These are used to display graphics in the embed.
- Fields - These are used to display information in a tabular format.
Main Embed Details
The details of the embed contain the following fields explained here in detail:
Title
Optional Field
This field is optional and will be assigned a default value if omitted.
The main title for the embed. This appears at the top, under the header, but above the main body of text.
Default Value: Unnamed Embed.
Max Length: 95 characters.
Description
Optional Field
This field is optional and will be collapsed if omitted.
The main body text of the embed. Appears below the title and above the fields.
Max Length: 2,000 characters.
Color
Optional Field
This field is optional and will be assigned a default value if omitted.
The accent color to be used for the small bar on the left of the embed.
Default Value: #2B2D31.
Color Picker
This must be a valid HEX color code. Please consult the Google Color Picker for assistance.
URL
Optional Field
This field is optional and may be omitted.
The underlying URL to be used for the title. This causes the title to be clickable.
Max Length: 500 characters.
This must be a valid URL string beginning with http:// or https://.
Timestamp
Optional Field
This field is optional and will be collapsed if omitted.
The timestamp to be displayed at the bottom of the embed, after the footer. This is useful for displaying the time the message was created or last updated.
This must be a valid date and time string in the format MM-DD-YY HH:MM AM/PM.
Embed Header
The header of the embed is located at the top of the message, above the title, and is typically used to display the author of the message. The header contains the following fields explained here in detail:
Optional Section
The header is optional and will be collapsed if omitted.
Header Text
The text to be displayed in the header above the main title.
Max Length: 250 characters.
Header Icon
The icon to be displayed in the header, next to the header text. This field is optional.
Restrictions
This must be a valid image file of type PNG/APNG, JPG/JPEG, WEBP, or GIF.
Header URL
The URL to be used when the header is clicked.
Max Length: 500 characters.
This must be a valid URL string beginning with http:// or https://.
Embed Footer
The footer of the embed is located at the bottom of the message, below the fields, and is typically used to display the source of the information. The footer contains the following fields explained here in detail:
Optional Section
The footer is optional and will be collapsed if omitted.
Footer Text
The text to be displayed in the footer, below the fields (if present).
Max Length: 2000 characters.
Footer Icon
The icon to be displayed in the footer, next to the footer text.
Restrictions
This must be a valid image file of type PNG/APNG, JPG/JPEG, WEBP, or GIF.
Embed Images
The images of the embed contain the following fields explained here in detail:
Optional Section
The images are optional and will be collapsed if omitted.
Thumbnail
The thumbnail (upper-right) image to be displayed in the embed.
Restrictions
This must be a valid image file of type PNG/APNG, JPG/JPEG, WEBP, or GIF.
We suggest this image is portrait-oriented or a 1:1 square ratio for best results.
Main Image
The main image (bottom-center) to be displayed in the embed.
Restrictions
This must be a valid image file of type PNG/APNG, JPG/JPEG, WEBP, or GIF.
We suggest this image is landscape-oriented or a 16:9 wide ratio for best results.
Embed Fields
The fields of the embed are used to break data down into a tabular format and contain the following data points, explained here in detail:
Field Name
The name of the field.
Max Length: 250 characters.
Field Value
The data value of the field.
Max Length: 1000 characters.
Field Inline
Whether the field should be displayed inline next to other inlined fields. This defaults to False.