> 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/welcome.md).

# Welcome

### Basic Command

Run this command in the channel where you want the welcome message to appear:

```
;setup_welcome #channel {embed}$v{title: Welcome {user.name}!}$v{description: Glad to have you here!}$v{color: green}$v{thumbnail: {member.avatar}}
```

### Available Variables for Welcome Messages

| Variable          | Description                                      |
| ----------------- | ------------------------------------------------ |
| `{user.name}`     | Name of the new member                           |
| `{member.avatar}` | Avatar URL of the member                         |
| `{guild.name}`    | Name of your server                              |
| `{guild.count}`   | Current member count (after join)                |
| `{user.mention}`  | Mentions the member (e.g., `Hey {user.mention}`) |

> **Important:** These variables only work when the message is triggered automatically by a **member join event**. If you run `;setup_welcome` manually, the variables will not be replaced – they are used to configure the *template*.

***

### Examples

#### 1. Simple Friendly Welcome Template

```
;setup_welcome {embed}$v{title: 🌟 Welcome {user.name}!}$v{description: We're happy to have you on **{guild.name}**!}$v{color: #57F287}$v{thumbnail: {member.avatar}}
```

#### 2. Welcome with Server Info & Button

```
;setup_welcome {embed}$v{title: 🎉 New Member!}$v{description: **{user.name}** just joined! We now have **{guild.count} members**. Please read the rules in <#rules-channel-id>.}$v{field: Date && {timestamp} && true}$v{button: link && 📖 Server Rules && https://your-rules-page.com}$v{color: #FEE75C}
```

#### 3. Full Welcome Embed with Footer & Ping

```
;setup_welcome {embed}$v{title: 👋 Hello {user.name}!}$v{description: Welcome to our community! 😊\nFeel free to introduce yourself and check out our events.}$v{thumbnail: {member.avatar}}$v{color: #E67E22}$v{footer: {guild.name}}{timestamp}$v{ping: @here}
```

> `$v{ping: @here}` will ping all currently online members (optional).

***

### How It Works

1. You run `;setup_welcome` with your embed template in the channel where new members should be welcomed.
2. The bot saves that template.
3. Whenever a new member joins, the bot automatically sends the saved template in that channel, replacing variables like `{user.name}` with real values.

To update the welcome message, simply run `;setup_welcome` again with a new embed.

***

### Tips & Best Practices

* **Test first** – use a private test channel to design your embed, then move it to your real welcome channel.
* **Line breaks** – use `\n` inside the `description` or field values.
* **Colors** – use color names (`green`, `red`, `blue`, etc.) or hex codes like `#57F287`.
* **Button URLs** – must start with `https://` or `http://`.
* **Multiple buttons** – add more `$v{button: ...}` blocks.

***

### Interactive Builder (Recommended)

Use the visual embed builder at:\
\> [**arklynn.xyz/embed**](https://arklynn.xyz/embed)

Design your welcome embed, then copy the generated command – but replace `;ann #channel` with `;setup_welcome`.

***

### Troubleshooting

| Issue                                           | Solution                                                                                                                                                            |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Variables like `{user.name}` appear as raw text | This is normal when running `;setup_welcome` – the command stores the *template*. The variables will be replaced automatically when a real member joins.            |
| Button doesn’t appear                           | Ensure the URL starts with `https://` and the button type is `link`.                                                                                                |
| No welcome message is sent when a member joins  | Make sure you ran `;setup_welcome` at least once in the desired channel. Also check that the bot has `Send Messages` and `Embed Links` permissions in that channel. |


---

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