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

# boost Setup

> Configure boost for your server

`recommended to use embed builder`

> The **boost Setup** system lets you configure an automated boost message for your guild, you can always use the [embed builder](https://xvz.wtf/embed-builder) to build embed to your own style!

***

## Permissions

To use any of the `boost` subcommands, you need the (`manage_guild`) permission

***

## Command Overview

***

### Set boost Message

Set a new boost message for your server

```plaintext theme={null}
boost set <#channel> <raw>
```

**Arguments:**

* `<#channel>` — The text channel where the boost message will be sent
* `<raw>` — The raw embed/message string that defines your boost message

**Example:**

```plaintext theme={null}
;boost set #boost  {message:{user.mention}$description:Ty for boosting our server 
https://discord.com/channels/1318933033855877131/1405160653202653244$thumbnail:{user.pfp}$#&color:#000000}
```

<Frame>
  <img src="https://mintcdn.com/xvz/WiRNfq9ruINAqYOl/images/bset.png?fit=max&auto=format&n=WiRNfq9ruINAqYOl&q=85&s=31a1b8f077ebb06cb9fa5278cfdf9e2e" width="689" height="331" data-path="images/bset.png" />
</Frame>

***

### Reset boost Message

Remove the current boost configuration from your server

```plaintext theme={null}
;boost reset
```

<Frame>
  <img src="https://mintcdn.com/xvz/WiRNfq9ruINAqYOl/images/breset.png?fit=max&auto=format&n=WiRNfq9ruINAqYOl&q=85&s=f862a53a73555b5f568f134ca25a0d05" width="424" height="155" data-path="images/breset.png" />
</Frame>

***

### View boost Message

See preview of the currently configured boost message

```plaintext theme={null}
;boost view
```

```plaintext theme={null}
;boost preview
```

<Frame>
  <img src="https://mintcdn.com/xvz/WiRNfq9ruINAqYOl/images/boostview.png?fit=max&auto=format&n=WiRNfq9ruINAqYOl&q=85&s=69cff426bd947a70a41d307670989848" width="456" height="248" data-path="images/boostview.png" />
</Frame>

***

## Variables

| Variable         | Description              |
| ---------------- | ------------------------ |
| `{user.mention}` | Mentions the new user    |
| `{user.name}`    | Username only            |
| `{user.tag}`     | Username + discriminator |
| `{user.id}`      | User's ID                |
| `{user.pfp}`     | URL to user's avatar     |
| `{guild.name}`   | Server name              |
| `{guild.icon}`   | Server icon URL          |
| `{membercount}`  | Current member count     |
| `{xvz.name}`     | Bot name                 |
| `{xvz.pfp}`      | Bot avatar URL           |

***

## Raw Embed Syntax

**Available Fields:**

* `message:` — Plain text message content
* `title:` — Embed title
* `description:` — Embed description
* `author:` — Embed author text (optionally with icon URL)
* `thumbnail:` — Embed thumbnail image URL
* `image:` — Embed image URL
* `footer:` — Embed footer text (optionally with icon URL)
* `&color:` — Embed color in HEX (e.g., `&color:#FF0000`)
* `button:` — Add interactive buttons (see below)

**Example Embed:**

```plaintext theme={null}
{message:{user.mention}$description:Ty for boosting our server$thumbnail:{user.pfp}$#&color:#000000} 
```

<Frame>
  <img src="https://mintcdn.com/xvz/WiRNfq9ruINAqYOl/images/embedeg3.png?fit=max&auto=format&n=WiRNfq9ruINAqYOl&q=85&s=d12903d4fdc48f895c8f883aa952627f" width="928" height="238" data-path="images/embedeg3.png" />
</Frame>

***

## Buttons Syntax

**Parameters:**

* `style#primary` / `style#secondary` / `style#success` / `style#danger` / `style#link`
* `emoji:EMOJI`
* `url:LINK` *(required for link buttons)*
* `disable:` *(disables the button)*

**Example Buttons:**

```plaintext theme={null}
{#&color:#000000$button:Ty for the boost!} 
{#&color:#000000$button:Ty for the boost!#stylelink#url:discord.gg/xvz} 
```

***