> For the complete documentation index, see [llms.txt](https://docs.mongenscave.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mongenscave.com/premium-products/discordlink/feature-help/embed-builder.md).

# Embed Builder

### ✏️ Available Embed Options

| Key               | Description                                              |
| ----------------- | -------------------------------------------------------- |
| `title`           | The main title of the embed.                             |
| `description`     | The main text. Use  for line breaks.                     |
| `color`           | Embed color in HEX format (example: `#00FFFF`).          |
| `url`             | Makes the title clickable, linking to the specified URL. |
| `timestamp`       | If `true`, adds the current timestamp.                   |
| `author.name`     | Displays an author name at the top of the embed.         |
| `author.url`      | (Optional) URL linked to the author name.                |
| `author.icon_url` | (Optional) Icon shown next to the author name.           |
| `thumbnail`       | Small image displayed on the right side.                 |
| `image`           | Large image displayed under the description.             |
| `footer.text`     | Footer text displayed at the bottom.                     |
| `footer.icon_url` | (Optional) Icon next to the footer text.                 |
| `fields`          | Adds multiple custom name/value fields.                  |

### 🔹 How to Use Author, Footer, and Fields

**Author example:**

```yaml
author:
  name: "Server Name"
  url: "https://yourserver.com"
  icon_url: "https://yourserver.com/icon.png"
```

* `author.name` is **required** if you want to show an author.
* `url` and `icon_url` are **optional**.

**Footer example:**

```yaml
footer:
  text: "MonGen's Cave"
  icon_url: "https://yourserver.com/footer-icon.png"
```

* `footer.text` is **required** for a footer to appear.
* `icon_url` is optional.

**Fields example (optional):**

```yaml
fields:
  - name: "First Field"
    value: "This is a value."
    inline: true
  - name: "Second Field"
    value: "Another value."
    inline: false
```

* `name`: Title of the field.
* `value`: Text inside the field.
* `inline`: Whether the field should be shown next to others (`true`) or on a new line (`false`).

### 🎨 Notes and Tips

* **Color must start with `#`**, otherwise the embed will use a default color.
* **Line breaks** inside description: use `\n`.
* If a field or option is missing, it will simply not be shown — no errors.
* Always check that URLs and image links are valid.

### ✅ Minimal Working Example

```yaml
title: "Welcome!"
description: "Thank you for joining our server!\nEnjoy your stay!"
color: "#00FFFF"
timestamp: true

author:
  name: "MonGen's Cave"
  icon_url: "https://yourserver.com/author-icon.png"

thumbnail: "https://yourserver.com/thumbnail.png"

footer:
  text: "MonGen's Cave - 2025"

fields:
  - name: "Getting Started"
    value: "Visit our website for guides!"
    inline: false
```