Embeds

Guide to understand the fundamentals of scripting embeds.

Understanding embed structure

Each parameter in the embed is represented by a key-value pair which is separated by a colon. For example, the title parameter will look like {title: hello {user}}. The {user} is a variable which will be filled in with the user’s display name.

  • { begins a parameter.
  • : separates parameter from content.
  • :: separates parameters.
  • } ends a parameter.

Available parameters

  • url - The embed URL. (https://..)
  • color - The embed color. (#FFFFFF)
  • title - The embed title. (hello {user})
  • description - The embed description. (hello {user})
  • image - The embed image URL. (https://..)
  • thumbnail - The embed thumbnail URL. (https://..)
  • timestamp - The embed timestamp. (NO ARGUMENTS)

The following parameters require additional arguments which are separated by &&.

Placeholders

You can use dynamic variables in your embeds to display user-specific information. For example, {user} will be replaced with the user’s display name.

{embed}::{description: {guild.name}}::{message: Hello! {user.mention}}