# Welcome System

Our welcome module features clean image generation along with customisation and parameters to improve your user experience!

#### OBJECTIVES

* [Setup the Welcome System](#setup-the-welcome-system)

<figure><img src="/files/DqVTeTScDu2Nrca2FCq9" alt=""><figcaption></figcaption></figure>

## Setup the Welcome System

The welcome system is designed with customisation and ease of use in mind. To set it up, simply run the [`/welcome setup`](/commands/welcome/setup.md) command, specifying just the channel.

Once you have run this command, you will be shown a popup with the customisable parameters for the module. The default configuration will be shown. For many, this will be enough, and you can submit this by just pressing the Submit button.

The existing parameters are listed below.&#x20;

{% code lineNumbers="true" %}

```
{member.mention} - Mention the user who joined the server
{member.username}- The username of the member in format @username
{member.id}      - The user id who changed their status
{guild.name}     - The server name where the event was triggered
{guild.id}       - The server id where the event was triggered
{generateImage}  - A flag for the image generation to be displayed
{memberCount}    - Displays the membercount of the server
```

{% endcode %}

{% hint style="info" %}
The `{generateImage}` parameter can only be used in the embed image field or in the message content.
{% endhint %}

<figure><img src="/files/JbB7PsCppxjPWLOIEbrT" alt=""><figcaption><p>The default configuration is shown as default.</p></figcaption></figure>

<figure><img src="/files/flJp412NqPnPeQvzcgiC" alt=""><figcaption><p><a href="https://zap-hosting.com/deluxe"><strong>Click here to be redirected to our affiliate link!</strong></a></p></figcaption></figure>


---

# Agent Instructions: 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://docs.elyxir.dev/features/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.