Skip to content

Trigger Type: EMBED

Jump to bottom
Amy edited this page Aug 15, 2024 · 2 revisions

An EMBED type response is the most flexible and customizable response. It uses Discords Embed system to create a message with formatting, images, footers and authors.

Can use all Common Options

Example:

ExampleEmbed:
  Type: EMBED
  Embed:
    Image: "https://padawanamy.com/assets/img/martin.jpg"
    Thumbnail: "{author-avatar}"
    Description: "Hello there {author-mention}\nThank you for using Helper Bot!"
    Title: "Embed Response Test"
    Footer: 
      Text: "This test message was triggered by {author-username}"
      Icon: "{author-avatar}"
    Colour: "FFFFFF"
    Author:
      Name: "{author-username}"
      Icon: "{author-avatar}" 
      Url:  "https://padawanamy.com/"
    Fields:
      Field1:
        Name: "Field 1"
        Text: "This is the first field"
        Inline: false
  Triggers:
  - "Embed Test"
  Strict: true

Fields

Embed types can have any of the following fields and require at least 1 trigger. All the fields go under an extra Embed section of the triggers config.

Title

The title of the embed. Supports most placeholders.

ExampleEmbed:
  Type: EMBED
  Embed:
    Title: "Embed Response Test"
  Triggers:
  - "Embed Test"
  Strict: true

Description

The description of the embed. Supports all placeholders.

ExampleEmbed:
  Type: EMBED
  Embed:
    Description: "Hello there {author-mention}\nThank you for using Helper Bot!"
  Triggers:
  - "Embed Test"
  Strict: true

Colour

The HEX colour code to use for the embed, do not include a #.

ExampleEmbed:
  Type: EMBED
  Embed:
    Colour: "FFFFFF"
  Triggers:
  - "Embed Test"
  Strict: true

Image

a URL for an image to use in the embed, supports {author-avatar} placeholder.

ExampleEmbed:
  Type: EMBED
  Embed:
    Image: "https://padawanamy.com/assets/img/favicon.png"
  Triggers:
  - "Embed Test"
  Strict: true

Thumbnail

a URL for an image to use in the embeds thumbnail, supports {author-avatar} placeholder.

ExampleEmbed:
  Type: EMBED
  Embed:
    Thumbnail: "https://padawanamy.com/assets/img/favicon.png"
  Triggers:
  - "Embed Test"
  Strict: true

Footer

Text

The text to use in the embeds footer. Supports all placeholders.

ExampleEmbed:
  Type: EMBED
  Embed:
    Footer:
      Text: "This is the embed footer."
  Triggers:
  - "Embed Test"
  Strict: true

Icon

A URL to an image to use in the footers icon. Supports {author-avatar} placeholder.

ExampleEmbed:
  Type: EMBED
  Embed:
    Footer:
      Text: "This is the embed footer."
      Icon: "https://padawanamy.com/assets/img/favicon.png"
  Triggers:
  - "Embed Test"
  Strict: true

Author

Name

The name to use in the author field, supports most placeholders.

ExampleEmbed:
  Type: EMBED
  Embed:
    Author:
      Name: "{author-username}"
  Triggers:
  - "Embed Test"
  Strict: true

Icon

A URL to an Image to use for the author icon. Supports {author-avatar} placeholder.

ExampleEmbed:
  Type: EMBED
  Embed:
    Author:
      Name: "{author-username}"
      Icon: "{author-avatar}"
  Triggers:
  - "Embed Test"
  Strict: true

URL

A URL to use for the author link.

ExampleEmbed:
  Type: EMBED
  Embed:
    Author:
      Name: "{author-username}"
      Icon: "{author-avatar}"
      Url: "https://padawanamy.com/"
  Triggers:
  - "Embed Test"
  Strict: true

Fields

You can add up to 25 fields per embed, each fields name must contain a number in ascending order, such as Field1 Field2 Field3 Field4 and so on.

Name

The fields name. Supports most placeholders.

ExampleEmbed:
  Type: EMBED
  Embed:
    Fields:
      Field1:
        Name: "Field 1"
  Triggers:
  - "Embed Test"
  Strict: true

Text

The text displayed in the field. Supports all placeholders.

ExampleEmbed:
  Type: EMBED
  Embed:
    Fields:
      Field1:
        Name: "Field Title"
        Text: "This is the first fields text."
  Triggers:
  - "Embed Test"
  Strict: true

Inline (True/False)

Defaults to false, whether or not the field should be inline (next to eachother) or not (vertical list)

ExampleEmbed:
  Type: EMBED
  Embed:
    Fields:
      Field1:
        Name: "Field Title"
        Text: "This is the first fields text."
        Inline: true
  Triggers:
  - "Embed Test"
  Strict: true

Example

This example has all options and multiple fields set on it.

ExampleEmbed:
  Type: EMBED
  Embed:
    Image: "https://padawanamy.com/assets/img/martin.jpg"
    Thumbnail: "{author-avatar}"
    Description: "Hello there {author-mention}\nThank you for using Helper Bot!"
    Title: "Embed Response Test"
    Colour: "FFFFFF"
    Footer: 
      Text: "This test message was triggered by {author-username}"
      Icon: "{author-avatar}"
    Author:
      Name: "{author-username}"
      Icon: "{author-avatar}" 
      Url:  "https://padawanamy.com/"
    Fields:
      Field1:
        Name: "Field Title"
        Text: "This is the first field"
        Inline: false
      Field2:
        Name: "Another Field"
        Text: "This is the 2nd field"
        Inline: true
      Field3:
        Name: "And yet another field"
        Text: "This is the 3rd field"
        Inline: true
  Triggers:
  - "Embed Test"
  Strict: true
Clone this wiki locally