> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bleh.rest/llms.txt
> Use this file to discover all available pages before exploring further.

# Embeds

> ## Documentation Index
>
> Fetch the complete documentation index at: [https://docs.bleh.bot/llms.txt](https://docs.bleh.bot/llms.txt)
> Use this file to discover all available pages before exploring further.

# Embeds

> Guide to understand the fundamentals of scripting embeds.

## 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](/resources/scripting/variables) which will be filled in with the user's display name.

* `{` begins a parameter.
* `:` separates parameter from content.
* `$v` separates the parameters.
* `}` ends a parameter.

### 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 `&&`.

<AccordionGroup>
  <Accordion title="Author">
    * `name` - The author's name.
    * `icon` - The author's icon. **Optional**
    * `url` - The author's URL. **Optional**

    <CodeGroup>
      ```javascript Syntax theme={null} theme={null}
      {author: name && icon && url}
      ```

      ```javascript Example theme={null} theme={null}
      {author: {user} && {user.avatar}}
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Field">
    * `name` - The field name.
    * `value` - The field value.

    <Info>Include **inline** at the end of the field to make it inline.</Info>

    <CodeGroup>
      ```javascript Syntax theme={null} theme={null}
      {field: name && value}
      ```

      ```javascript Example theme={null} theme={null}
      {field: {user} && this is the value}
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Footer">
    * `text` - The footer text.
    * `icon` - The footer icon. **Optional**

    <CodeGroup>
      ```javascript Syntax theme={null} theme={null}
      {footer: text && icon}
      ```

      ```javascript Example theme={null} theme={null}
      {footer: {user}}
      {footer: {user} && {user.avatar}}
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Button">
    * `type` - `Link`, `Blurple`, `Green`, `Grey` or `Red`.
    * `label` - The button label.
    * `url` - The button URL or emoji.

    <CodeGroup>
      ```javascript Syntax theme={null} theme={null}
      {button: type && label && url && enabled|disabled}
      ```

      ```javascript Example theme={null} theme={null}
      {button: blurple && heyy && disabled}
      {button: https://example.com && click this}
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>

### Variables

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.

<Info>You can view the available variables by clicking [here](/resources/scripting/variables).</Info>

```
{description: {guild.name}}$v{message: Hello! {user.mention}}
```

<Frame type="glass" />

## Frequently Asked Questions

### How can I add a new line to my description parameter?

If you want to add a new line to your description parameter, you can press `SHIFT` + `ENTER` to create a new line.

### Why isn't my embed code working for some commands?

Some commands allow both raw text and embed code. Because of this, you'll need to specify if you're entering an embed. To do this, you'll need to begin your embed code with `{embed}$v` then proceed to write your embed code after as normal.

```
 welcome add #channel {embed}$v{message: Welcome to /{guild.name} {user.mention}}$v{description: Welcome}
```