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

# Welcome Setup

> Configure welcome for your server

`recommended to use embed builder`

> The **Welcome Setup** system lets you configure an automated welcome message for new members 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 `welcome` subcommands, you need the (`manage_guild`) permission

***

## Command Overview

***

### Set Welcome Message

Set a new welcome message for your server

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

**Arguments:**

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

**Example:**

```plaintext theme={null}
;welcome set #welcome {message:{user.mention}$title:Welcome to {guild.name}$thumbnail:{user.pfp}}
```

<Frame>
  <img src="https://mintcdn.com/xvz/WiRNfq9ruINAqYOl/images/welcomeset.png?fit=max&auto=format&n=WiRNfq9ruINAqYOl&q=85&s=74463104402c6acf74d4ec594f03018c" width="1001" height="286" data-path="images/welcomeset.png" />
</Frame>

***

### Reset Welcome Message

Remove the current welcome configuration from your server

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

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

***

### View Welcome Message

See preview of the currently configured welcome message

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

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

<Frame>
  <img src="https://mintcdn.com/xvz/WiRNfq9ruINAqYOl/images/wview.png?fit=max&auto=format&n=WiRNfq9ruINAqYOl&q=85&s=e3664abd68a75fc072545ce99bf5490d" width="409" height="261" data-path="images/wview.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:Welcome {user.mention}!$title:Hello {user.name}$description:You are our {membercount}th member!$thumbnail:{user.pfp}$&color:#00FF00}
```

<Frame>
  <img src="https://mintcdn.com/xvz/WiRNfq9ruINAqYOl/images/embedeg.png?fit=max&auto=format&n=WiRNfq9ruINAqYOl&q=85&s=5efde6a665b5ac1ef60f642be88cb677" width="1230" height="242" data-path="images/embedeg.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}
button:Click Me#style#primary#emoji:👋
button:Visit Website#style#link#url:https://example.com
```

***