> For the complete documentation index, see [llms.txt](https://mythicalbot.gitbook.io/arklynn-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mythicalbot.gitbook.io/arklynn-docs/resources/scripting/booster.md).

# Booster

### Basic Command

Run this command in the channel where booster announcements should appear:

```
;setup_booster {embed}$v{color: #a855f7}$v{description: Thank you **{user.mention}** for boosting {guild.name}!}$v{footer: Thanks for your support!}$v{timestamp}
```

### How It Works

1. You run `;setup_booster` with your embed template in the desired channel.
2. The bot saves that template.
3. Whenever a member boosts your server, the bot automatically sends the saved template in that channel, replacing variables with real data.

To update the booster message, simply run `;setup_booster` again with a new embed.

***

### Available Variables for Booster Messages

| Variable              | Description                                                |
| --------------------- | ---------------------------------------------------------- |
| `{user.name}`         | Username of the member who boosted (e.g., `Alex`)          |
| `{user.mention}`      | Mention of the member (pings them)                         |
| `{user.avatar}`       | Avatar URL of the member                                   |
| `{user.display}`      | Display name (nickname if set, otherwise username)         |
| `{user.id}`           | Discord user ID (can be used in links)                     |
| `{user.color}`        | Member’s role color (returns hex code, e.g., `#5865F2`)    |
| `{guild.name}`        | Name of your server                                        |
| `{guild.icon}`        | Server icon URL                                            |
| `{guild.boost_count}` | Total number of boosts the server has **after** this boost |
| `{timestamp}`         | Current time (automatically formatted)                     |

> All variables work automatically when a real boost occurs. During `;setup_booster` they appear as raw text – that is normal.

***

### Examples

Below are the two example templates you provided – each can be used as a single `;setup_booster` command.\
\&#xNAN;*(Only one embed per command – choose the style you like best.)*

#### 1. Purple Thank You with Footer

```
;setup_booster {embed}$v{color: #a855f7}$v{content: {user.mention}}$v{description: Thank you **{user.mention}** for boosting {guild.name}!\n\nWe now have **{guild.boost_count}** boosts!}$v{footer: Thanks for your support!}$v{timestamp}
```

{% hint style="info" %}
`$v{content: ...}` sends a separate plain text message **above** the embed (useful for a mention ping without putting it inside the embed).
{% endhint %}

#### 2. Author & Footer with Custom Link

```
;setup_booster {embed}$v{content: {user.mention}}$v{author: {guild.name} @ {guild.boost_count} boosts && {guild.icon}}$v{footer: {user.display}'s so cute for boosting && {user.avatar}}$v{description: Thx [**{user}**](https://discord.com/users/{user.id}), for boosting 🚀}$v{color: {user.color}}
```

{% hint style="info" %}
`{user}` inside the description may not resolve – use `{user.name}` or `{user.display}` instead.\
The example `[**{user}**]` should likely be `[**{user.name}**]` to work correctly.
{% endhint %}

***

### Important Notes on Syntax

* **`$v{content: ...}`** – This is **not** part of the standard embed syntax in the original docs, but based on your example it appears to be supported. It sends a plain text message **before** the embed. Use it for pings (`{user.mention}`) that work better outside the embed.
* **Multiple embeds?** – The bot only stores **one embed** per `;setup_booster` command. If you have two different designs, you must choose one or run the command again (overwriting the previous template).
* **`{user.color}`** – Returns the member’s highest role color as a hex code. Works well for dynamic embed colors.

***

### Tips & Best Practices

* **Use a visible ping** – Put `$v{content: {user.mention}}` at the top so the booster is notified immediately.
* **Show appreciation** – Include `{guild.boost_count}` to celebrate the growing support.
* **Dynamic colors** – Try `$v{color: {user.color}}` to match the embed color to the booster’s role.
* **Add a custom link** – You can link to the booster’s profile using `https://discord.com/users/{user.id}`.
* **Test first** – Use a private channel to design your embed, then move it to your public booster channel.

***

### Interactive Builder (Recommended)

Design your booster embed visually at:\
[**arklynn.xyz/embed**](https://arklynn.xyz/embed)

After designing, copy the generated command and **replace `;ann #channel` with `;setup_booster`** before sending.\
If you need the `$v{content: ...}` line, add it manually before the `{embed}` block.

***

### Troubleshooting

| Issue                                          | Solution                                                                                                                                 |
| ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `{user.color}` doesn’t change the embed colour | The variable works only after a real boost. During setup it shows raw text. Also ensure the member has a coloured role.                  |
| `$v{content: ...}` doesn’t send anything       | The bot may not support this field. If it fails, move the ping into the embed’s `description` instead.                                   |
| No booster message appears                     | Make sure you ran `;setup_booster` at least once in that channel. Also verify the bot has `Send Messages` and `Embed Links` permissions. |
| Variables show as raw text when testing        | That’s normal – the command stores the template. Real boosts will replace them correctly.                                                |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mythicalbot.gitbook.io/arklynn-docs/resources/scripting/booster.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.