UtilitiesDocs

Embeds

Design embeds, save them by name, and use them in any message the bot sends.

#Overview

An embed is a message card with a coloured bar, a title, fields and pictures. You build one in Discord, save it under a name, and then drop it into welcome messages, autoresponders, sticky messages and button replies by writing {embed:name}.

You can also design one in the embed builder on the website and paste its code into the bot.

#Getting started

  1. Create it. Run /embed create with a name. The bot opens the editor straight away, showing the embed as it will look.

  2. Fill it in. Use the buttons under the preview to set the title, description, colour, fields, author, footer and pictures. Every change redraws the preview.

  3. Use it. Write {embed:name} in any message the bot sends for you, like a welcome message.

/embed create rules
/welcome message Welcome {user.mention}! {embed:rules}

#Names

A name can be up to 16 characters. It is saved in lower case, and anything other than letters, numbers and underscores is taken out, so My Rules is saved as myrules. {embed:My Rules} still finds it, because the name you write is cleaned up the same way.

In a prefix command, ,embed rules opens the editor for the embed called rules.

#The editor

/embed create and /embed edit open the same editor. Each button opens a box for one part of the embed:

  • Edit basic information: the title, the description and the colour, as a hex code like #5865F2.
  • Edit fields: a second screen where you add, edit and remove fields. An embed can have up to 25.
  • Edit author: the small line above the title, with an optional image and link.
  • Edit footer: the line at the bottom, with an optional image, and a tick box to show the time.
  • Edit images: the large image and the small thumbnail in the corner.
  • Embed code: the whole embed as code, which you can copy, or replace by pasting new code in.

Leaving a box empty removes that part. The preview fills in variables the way a real message would, so {user.mention} shows as a mention.

Only the person who opened an editor can use its buttons. You can edit and delete the embeds you made, and anyone with Manage Server can edit and delete all of them.

#Using embeds in other features

Write {embed:name} anywhere the bot sends a message you wrote:

You can put text around it, and use more than one. A message can carry up to 10 embeds.

Welcome {user.mention}! {embed:rules} {embed:roles}

You can also write an embed straight into the message as code instead of saving it first. See the code format below.

#Embed code

Embed code is one line of text that describes a whole embed. It starts with {embed}, and each part is written as {part: value}, with $v between them:

{embed}$v{title: Welcome to {guild.name}}$v{description: Read the rules and say hi.}$v{color: #5865F2}$v{footer: You are member {guild.member_count}}

The parts you can use:

PartWhat it does
{content: text}Normal message text sent with the embed. Put it before {embed}.
{title: text}The title.
{url: link}Makes the title a link.
{description: text}The main text.
{color: #hex}The bar on the left.
{author: name && image && link}The line above the title. The image and link are optional.
{field: name && value && inline}A field. Add inline to put it beside the others. Repeat for more fields.
{thumbnail: link}The small picture in the corner.
{image: link}The large picture at the bottom.
{footer: text && image}The bottom line. The image is optional.
{timestamp: true}Shows the time the message was sent.
{button: blurple && Label}A button under the embed. See Buttons.

Parts that have more than one piece split them with &&, and the order matters: to give an author a link but no image, leave the image empty, like {author: Utilities && && https://utilities.best}. Write {newline} to start a new line inside a value.

#Moving embeds around

  • /embed code gives you an embed's code. Give it a saved embed's name, or a link to a message in your server, and it gives you the code for every embed on that message.
  • To load code into a saved embed, open it with /embed edit, press Embed code, and paste over what is there.
  • The embed builder speaks the same code. Press Copy Code there and paste it into the bot, or press Import to load code from the bot into the builder.

#Good to know

  • Embed code cannot contain a saved button like {button:name}, because code is meant to work in any server. Write the button out in full instead.
  • If an embed's code is longer than 4,000 characters, the Embed code button shows it in a message instead of a box, since Discord's boxes cannot hold more.
  • If your server has more embeds than its plan allows, for example after Premium ends, only the oldest ones up to your limit keep working in messages. Nothing is deleted, and they come back when you upgrade.
  • To delete every embed you made at once, run /embed delete and pick [WARNING] Reset your embeds! from the list. The bot asks before deleting anything.

#Limits

A server can keep 10 embeds on Free, 150 on Tier 1 and as many as it wants on Tier 2. See Premium.

#Commands

/embed create (name)Manage Messages

Create a new embed

/embed edit (name)Manage Messages

Edit an existing embed

/embed delete (name)Manage Messages

Delete an embed

/embed listManage Messages

List all embeds

/embed raw (name)Manage Messages

Get an embed's raw JSON

/embed code (name)Manage Messages

Get an embed's code