UtilitiesDocs

Welcome, Leave & Boost

Messages the bot sends when someone joins, leaves or boosts your server.

#Overview

Utilities can post a message when someone joins your server, when someone leaves, and when someone starts boosting it. Each of the three has its own channel and its own message, and they are set up the same way.

#Getting started

  1. Pick a channel. Run /welcome channel and choose a text channel.

  2. Write the message. Run /welcome message with what the bot should say. Use variables to name the new member.

  3. Test it. Run /welcome test. The bot posts the message in the welcome channel, with you standing in for the new member.

/welcome channel #welcome
/welcome message Welcome {user.mention} to {guild.name}! You are member {guild.member_count}.
/welcome test

Leave and boost messages work the same way with /leave and /boost.

#What a message can contain

A message can be up to 2,000 characters, and it is written in the same way as every other message the bot sends for you:

  • Variables like {user.mention}, {user.name} and {guild.name}, filled in for the member it is about. Run /variables to see them all.
  • Saved embeds with {embed:name}, or an embed written out as code. See Embeds.
  • Buttons with {button:name}. A button set to Author only can only be pressed by the member the message is about. See Buttons.
/welcome message Welcome {user.mention}! {embed:welcome} {button:rules}
/leave message Goodbye {user.name}, thanks for stopping by.
/boost message Thanks for boosting, {user.mention}! {embed:boost}

#When each one is sent

  • Welcome: when someone joins the server.
  • Leave: when someone leaves the server.
  • Boost: when someone starts boosting the server.

Bots are skipped. A bot you add to your server is not welcomed, and one you remove is not announced.

#Mentions

Mentions in these messages ping, including @everyone, @here and roles. Because of that, setting them up needs both Manage Server and Mention Everyone. Without the second, someone could make the bot ping everyone with a message they are not allowed to send themselves.

#Troubleshooting

  • Nothing is posted. A message is only sent when it has both a channel and a message. Run /welcome test: it tells you which one is missing.
  • The test says the bot is missing permissions. Utilities needs View Channel, Send Messages and Embed Links in the channel.
  • An embed is missing from the message. If an embed or button the message names has been deleted, the rest of the message is still sent without it. Check the names with /embed list and /button list.

A test posts a real message in the real channel, so a server can run up to 3 tests a minute.

#Turning one off

Run /welcome clear, /leave clear or /boost clear to remove that message and its channel. The bot asks before clearing anything.

#Commands

#Welcome

/welcome message (message)Manage ServerMention Everyone

Set the welcome message

/welcome channel (channel)Manage ServerMention Everyone

Set the welcome channel

/welcome clearManage ServerMention Everyone

Clear welcome message configuration Also: ,welcome reset

/welcome testManage ServerMention Everyone

Test welcome message

#Leave

/leave message (message)Manage ServerMention Everyone

Set the leave message

/leave channel (channel)Manage ServerMention Everyone

Set the leave channel

/leave clearManage ServerMention Everyone

Clear leave message configuration Also: ,leave reset

/leave testManage ServerMention Everyone

Test leave message

#Boost

/boost message (message)Manage ServerMention Everyone

Set the boost message

/boost channel (channel)Manage ServerMention Everyone

Set the boost channel

/boost clearManage ServerMention Everyone

Clear boost message configuration Also: ,boost reset

/boost testManage ServerMention Everyone

Test boost message