# Welcomer

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FtZBcU2ZLLXaqRv7baPoD%2Fimage.png?alt=media&#x26;token=697190cb-47e8-4193-88e2-03116b6007f3" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Some of the features of this module require a [Premium Subscription](https://botghost.com/docs/premium/premium-and-priority-hosting-plans#premium-plans) to function. You can however use the module with a free subscription.
{% endhint %}

The [Welcomer](https://dashboard.botghost.com/dashboard/module/b65529b9-b196-4088-8fef-3eaff0b0c047/welcomer) module will allow you to send custom welcome banners, messages, reactions, and add roles to users when they join the server. This module will also allow you to send a message when a user is kicked or banned, all in one.

## Common Issues

Experiencing issues with the module? Check out the common issues below. If your issue is not listed in this page, make sure your module is updated to the latest version. If you are still experiencing issues with the module, join our [support server](https://discord.gg/botghost) to ask for further help.

### Message not sending

If your welcome message is not being sent, try the following steps:

{% stepper %}
{% step %}
Check the Discord server permissions of your bot: make sure your bot has the "Send messages" and "View Channel" permissions and that there are no overwrites for the selected channel, or just give your bot the "Administrator" permissions.
{% endstep %}

{% step %}
Check if your bot intents (message intent) are enabled on the [Discord Developer Portal](https://discord.com/developers/applications). Ensure the message intent is also enabled in the settings page. See [#privileged-intent-options](https://botghost.com/docs/general-settings-and-collaboration/settings#privileged-intent-options "mention") for more info.
{% endstep %}

{% step %}
If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help.
{% endstep %}
{% endstepper %}

### Welcome card not working

If the welcome card isn't working/sending you can try:

{% stepper %}
{% step %}
Check if the image URL is a valid file type (PNG, JPG, JPEG). A valid image url should end with `.png`, `.jpg` or `.jpeg`.
{% endstep %}

{% step %}
Don't use Discord attachment links: after some time, they expire and cannot be used outside of Discord (including BotGhost).
{% endstep %}

{% step %}
If you're still experiencing issues,  join our [support server](https://discord.gg/botghost) for further assistance.
{% endstep %}
{% endstepper %}

***

## Watch the Tutorial

{% embed url="<https://youtu.be/SlcS6_h6hXU?si=GQh3mgJzOFwHs0E4>" %}

***

## Settings

### **Welcome Card**

Customize the card to your liking. You can configure many different aspects of the card as below.

{% hint style="warning" %}
Features in this section are limited to [Premium](https://botghost.com/docs/premium/premium-and-priority-hosting-plans#premium-plans) users.
{% endhint %}

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FeMndv0VwNXFFyOSXhhVD%2Fimage.png?alt=media&#x26;token=7f44f329-6f53-42b1-b397-a7dbd9d4befe" alt=""><figcaption></figcaption></figure>

#### \[👑] Welcome Card

| Type                                   | Details                                                                                                 |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| Disabled                               | If the welcome cards are disabled then no cards will be sent when a user joins the server.              |
| Send to a channel                      | This selection type will send the welcome card to a specified channel when someone joins.               |
| Message the user                       | This dropdown type will send a direct message to the user.                                              |
| Send to a channel and message the user | If this option is selected it will send the message to both the channel and the user's direct messages. |

#### \[👑] Channel

Select a channel from your server to send the welcome card to.

#### \[👑] Background

Choose a custom background from your card. You have 3 options for this. Depending on the option chosen it will change the background color.

{% tabs %}
{% tab title="Plain Color background" %}
If "Plain Color" is chosen, you will simply choose from the default color panel.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FVRsUUMt0PfI2R5o8oyfz%2Fimage.png?alt=media&#x26;token=ad9fffa0-de6e-4ebb-8ee7-1568cd2570d0" alt=""><figcaption></figcaption></figure>

#### \[👑] Background - Color

This allows you to select the background color that will be used for the card.

### Example Card

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FYJIVpvOh5UQLhW1ZB1rG%2Fimage.png?alt=media&#x26;token=826d0475-deaa-454e-bebb-4ea0877ebdc8" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Default Background Image" %}
If "Default Background" is chosen you can pick one of the default background cards BotGhost provides, available in 8 colors including Red, Yellow, Blue, Purple and more.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FosPagjanF4QlcKbdOEbw%2Fimage.png?alt=media&#x26;token=eeca02d8-46f7-42ee-b4f1-cfe1c6ee3708" alt=""><figcaption></figcaption></figure>

#### \[👑] Background - Default Card Color

This setting allows you to pick your favorite color for the default background card.

### Example Cards

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2F1jDmoyTYKfGHEVGvWQOR%2Fimage.png?alt=media&#x26;token=e13ab161-2725-4c03-a273-b01bef395db8" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Custom Background Image" %}
If "Custom Background" is chosen then the card can be a color or any image you provide by entering it into the field below.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FfFZtRpkThLnkcQsM5pE9%2Fimage.png?alt=media&#x26;token=569af822-9b39-4215-b0a5-fa941170ae3f" alt=""><figcaption></figcaption></figure>

#### \[👑] Background - Image

Paste the URL of the image that will be used as a background. Make sure it's a valid image URL (ends with `.png`, `.jpg` or `.jpeg`). You should not use Discord attachment links as they expire after some time and cannot be used outside the platform. The recommended size of the image is 1024x500 pixels.

### Example Card

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2F1ctD1NXn7A2mKVP455lK%2FWelcome%20Card%20reference%20of%20the%20Welcomer%20Module.jpg?alt=media&#x26;token=e0bda508-1219-4c74-83c0-0eb5c985943a" alt="" width="563"><figcaption><p>Welcome Card reference</p></figcaption></figure>
{% endtab %}
{% endtabs %}

#### \[👑] Title Color

This section represents the color for the title of the welcome card.

#### \[👑] Description Color

This section represents the color for the description of the welcome card.

#### \[👑] Avatar Border Color

This section represents the color for the avatar border of the welcome card.

#### \[👑] Banner Title

This section is how you can edit the banner title for the welcome card. [Variables](https://botghost.com/docs/custom-commands-and-events/variables) can be used.

#### \[👑] Banner Description

This field is how you can edit the banner's description.[ Variables](https://botghost.com/docs/custom-commands-and-events/variables) can be used as well.

#### \[👑] Channel Reactions

Choose up to 5 reactions that can be added to the welcome card message.

### Message on Join

When enabled, this action allows for a message to be sent to a specific channel.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2F0OQD3qUcZMrWZK4aFqPt%2Fimage.png?alt=media&#x26;token=37c9434c-b06c-416d-82c6-3b4453aca86e" alt=""><figcaption></figcaption></figure>

#### Channel

Select the channel from this dropdown for the message to be sent to.

#### Welcome Message

This field is where you input the welcome message for when the user joins. You are able to pick from either [plain text](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response types. You are also able to use the `{card}` variable inside the image url section of the embed response type to show your welcome card in the same message. Some [variables](https://botghost.com/docs/custom-commands-and-events/variables) can also be used, such as `{user}`.

#### Reactions

Choose up to 5 reactions that can be added to the message.

### Direct message on Join

When enabled, this action allows for a message to be sent as a direct message to the user who joined.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FXKuv8gphqlcgR5tjoLHf%2Fimage.png?alt=media&#x26;token=fab4093f-385e-4ce2-9fac-2b572a213549" alt=""><figcaption></figcaption></figure>

#### Welcome Direct Message

This field is where you input the welcome message for when the user joins. You are able to pick from either [plain text](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response types. You are also able to use the `{card}` variable inside the image url section of the embed response type to show your welcome card in the same message. Some [variables](https://botghost.com/docs/custom-commands-and-events/variables) can also be used, such as `{user}`.

### Add Role on Join

When this switch is enabled, it acts as an auto-role feature for the server, adding any roles from the server to the user who joined.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FzDslxkIlGOeDDzA69uHW%2Fimage.png?alt=media&#x26;token=db1ff3cd-7f58-43a4-a4e8-b48ae278866d" alt=""><figcaption></figcaption></figure>

#### Roles to add on join

This section is where you can add any roles you wish from any server the bot is in. The roles will be added to the user from the respective server they joined.

#### Wait for rules acceptance

Enabling this switch will add the roles only after the user has accepted the server rules from the membership screening page. The server must have this setup for this to function correctly.

### Message on Leave

Define whether you wish to enable or disable the message that gets sent when a user leaves the server.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FBAZm3mzNXUYlmOzd9JW7%2Fimage.png?alt=media&#x26;token=ff062b4d-24c1-4d2c-b5ec-826bce2a956d" alt=""><figcaption></figcaption></figure>

#### Channel

Select the channel from the dropdown that the message will get sent to upon a user leaving.

#### Leave message

This field is where you will input the message that gets sent when the user leaves. [Variables](https://botghost.com/docs/custom-commands-and-events/variables) can be used. You can also choose from either a [plain text](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response type.

#### Reactions

Choose up to 5 reactions to be added to the message.

### Message on Kick

Define whether you wish to enable or disable the message that gets sent when a user is kicked from the server.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FbEtuvP2RSpWas3IwFLTb%2Fimage.png?alt=media&#x26;token=159c90f4-1ca5-4d3a-856a-e71c508f374e" alt=""><figcaption></figcaption></figure>

#### Channel

Select the channel from the dropdown that the message will get sent to upon a user that gets kicked.

#### Kick message

This field is where you will input the message that gets sent when the user is kicked. [Variables](https://botghost.com/docs/custom-commands-and-events/variables) can be used. You can also choose from either a [plain text](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response type.

#### Reactions

Choose up to 5 reactions to be added to the message.

### Message on Ban

Define whether you wish to enable or disable the message that gets sent when a user is banned from the server.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FFXUtbGwUJxlJulIGoz2D%2Fimage.png?alt=media&#x26;token=236322a8-8e9d-41a0-8f5e-80aacee37cbf" alt=""><figcaption></figcaption></figure>

#### Channel

Select the channel from the dropdown that the message will get sent to upon a user that gets banned.

#### Ban message

This field is where you will input the message that gets sent when the user is banned. [Variables](https://botghost.com/docs/custom-commands-and-events/variables) can be used. You can also choose from either a [plain text](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://botghost.com/docs/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response type.

#### Reactions

Choose up to 5 reactions to be added to the message.

***

## Events

In this area, you can view and modify the events of the Welcomer module. Below you may find some information on each event of the module.

<figure><img src="https://1937909199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lm_hW5MApY3J0lRhi0M%2Fuploads%2FIke7U5B3GXJjMUKXPQev%2Fimage.png?alt=media&#x26;token=62100a0d-061b-462b-a1e6-9be4ca51e26c" alt=""><figcaption></figcaption></figure>

<details>

<summary>Joins Handler</summary>

This event contains the welcoming card, the message on join, and the role addition.

</details>

<details>

<summary>Leaves and Kicks Handler</summary>

These events contain the message on leave and the message on kick.

</details>

<details>

<summary>Bans Handler</summary>

This event contains the message on ban.

</details>

***

{% hint style="danger" %}
It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended.

Additionally, a copy of the edited commands / events will be created if you update the module.
{% endhint %}