Welcomer
Give your members a custom welcome, a stylish kick, and a deserved ban!
The 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. You can configure the module on the dashboard by heading to the modules section and finding the 'Welcomer' module.
Note: The Welcome Card section is only available to users with a Premium Subscription.
Welcome Card
Customise the card, message, and reaction settings, from sending the message to a channel or the user, to enabling both or disabling them completely.
Welcome Card: Select a variety of options, whether you wish to disable the welcome card, send to a channel, message the user, or send to a channel and message the user.
Channel: Define the channel in which the welcome card should be sent to.
Background Image: Set the image URL for the background of the welcome banner. The recommended size is 1024x500 pixels. If no image URL is provided, the background will be set to the color selected in 'Background Color'.
Background Color: Change the background color of the banner. Note that this will not show if you selected a banner image to be displayed.
Title Color: Set the color that 'Banner Title' will appear as in the welcome banner.
Description Color: Set the color that 'Banner Description' will appear as in the welcome banner.
Avatar Border Color: Change the color of the border that is around the user's avatar in the welcome banner.
Banner Title: Choose how the first line on the banner should look like. All variables can be used.
Banner Description: Choose how the second line of text should look like. All variables can be used.
Channel Reactions: In the channel you specified, select up to five (5) emojis that will be added to the welcome card message.
DM Reactions: When sending a DM, select up to five (5) emojis that will be added to the welcome card message.
Message on Join
Configure the channel, message, and reaction settings, from switching the message type to an embed or plain text, to disabling it completely.
Message on Join: Toggle whether the message on join should be enabled or disabled.
Channel: Define the channel in which the message should be sent to.
Welcome Message: Customise the message that is sent to the welcome channel once a user joins the server. All variables can be used.
Reactions: Select up to five (5) emojis that will be added to the welcome message.
Pro tip: If you have a Welcome Card, you may use the {card} variable in the Image URL field to display the custom banner.
Direct Message on Join
Configure the message and reaction settings, whether you wish to send a DM to the user that joins the server or not.
Direct Message on Join: Toggle whether the direct message on join should be enabled or disabled.
Welcome Direct Message: Customize the direct message that is sent to the welcome channel once a user joins the server.
Pro tip: If you have a Welcome Card, you may use the {card} variable in the Image URL field to display the custom banner.
Add Role on Join
Add one or more server roles to the user that joins the server, with the ability to enable and disable this feature.
Add Role on Join: Toggle whether you wish to enable or disable the roles addition to the user that joins the server.
Roles to add on join: Select one or more roles to add to the user upon joining the server.
Message on Leave
Define whether you wish to enable or disable the message on leave, the channel where the message should be sent to, the leave message type and content, or add reactions to the leave message.
Message on Leave: Toggle whether the message on leave should be enabled or disabled.
Channel: Define the channel in which the message should be sent to.
Leave Message: Customise the message that is sent to the selected channel once a user leaves the server. All variables can be used.
Reactions: Select up to five (5) emojis that will be added to the leave message.
Message on Kick
Configure the channel and message settings, from switching the message type to an embed or plain text, to disabling it completely.
Message on Kick: Toggle whether the message on kick should be enabled or disabled.
Channel: Define the channel in which the message should be sent to.
Kick Message: Customise the message that is sent to the selected channel once the user is kicked. All variables can be used.
Reactions: Select up to five (5) emojis that will be added to the kick message.
Message on Ban
Configure the channel and message settings, from switching the message type to an embed or plain text, to disabling it completely.
Message on Ban: Toggle whether the message on ban should be enabled or disabled.
Channel: Define the channel in which the message should be sent to.
Ban Message: Customise the message that is sent to the selected channel once the user is banned. All variables can be used.
Reactions: Select up to five (5) emojis that will be added to the ban message.
Events
Find the events for the Welcomer module and modify them. This will allow you to fine-tune the events to your liking and expand existing functions included in the module.
Joins Handler: This event contains the welcoming card, the message on join, and the role addition.
Leaves and Kicks Handler: These events contain the message on leave and the message on kick.
Bans Handler: This event contains the message on ban.
Warning: It's advised that you do not edit the event unless you have a good understanding of BotGhost and the Custom Event Builder. You can always reset the module to default if you should happen to make a mistake while editing the event.
Last updated
