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

# Embeds

> Build embeds with titles, descriptions, fields, images, and footers.

An embed is the boxed message with a coloured bar down the side. Start one with `{embed}`, then
add a node for each part you want.

```text Welcome embed theme={null}
{embed}
{color: #5865F2}
{title: Welcome to {server.name}!}
{description: Hey {member.mention}, you're the {member.join_position|ordinal} member.}
{thumbnail: {member.display_avatar}}
{footer: Joined {server.name} && {server.icon}}
{timestamp: now}
```

Order doesn't matter. Put the nodes in whatever order is easiest to read.

## Nodes

| Node               | Aliases          | Value                       | Description                                |
| ------------------ | ---------------- | --------------------------- | ------------------------------------------ |
| `{embed}`          | `{e}`            | none                        | Starts a new embed                         |
| `{color: …}`       | `{colour}`       | hex or number               | The colour of the side bar, like `#5865F2` |
| `{title: …}`       |                  | text                        | Title at the top                           |
| `{description: …}` | `{desc}`         | text                        | The main body                              |
| `{url: …}`         |                  | link                        | Makes the title clickable                  |
| `{thumbnail: …}`   | `{thumb}`        | link                        | Small image in the top right               |
| `{image: …}`       | `{img}`          | link                        | Large image under the description          |
| `{footer: …}`      |                  | `text [&& icon]`            | Footer text, with an optional icon         |
| `{author: …}`      |                  | `name [&& icon [&& link]]`  | Author line above the title                |
| `{field: …}`       |                  | `name && value [&& inline]` | Adds a field                               |
| `{timestamp: …}`   | `{time}`, `{ts}` | unix, ISO, or `now`         | Time shown in the footer                   |
| `{add_image: …}`   | `{img+}`         | link                        | Adds another image to the embed            |

## Fields

Fields are the small labelled blocks under the description. Each one needs a name and a value,
split with `&&`.

```text Two fields side by side theme={null}
{field: Scrobbles && {track.plays|comma} && inline}
{field: Artist plays && {artist.plays|comma} && inline}
```

Add `&& inline` to put fields next to each other. Leave it off and each one takes a full row.
Discord fits up to three inline fields per row.

## Footers and authors

Both take extra parts split with `&&`, and both work fine with just the first part.

```text Footer with an image theme={null}
{footer: {server.name} && {server.icon}}
```

```text Author with an image and a link theme={null}
{author: {lastfm.name} && {member.display_avatar} && {lastfm.url}}
```

## More than one embed

Every `{embed}` starts a fresh one, so anything after it belongs to the new embed rather than
the old one.

```text Two embeds theme={null}
{embed}
{title: First}

{embed}
{title: Second}
```

<Info>
  A message can hold up to **10 embeds**. Anything past that is dropped.
</Info>

<Tip>
  Mixing plain text with an embed is fine. Use `{content: …}` for the text that sits above the
  embed, where pings actually notify people.
</Tip>
