Iris
Add to Discord

Welcome

Greet new members with custom messages and embeds.

Configure Welcome in the dashboard

Overview#

Welcome greets every member who joins. It can post in a channel, send a direct message, or do both, and either greeting can be plain text, an embed, or an embed with a generated image card carrying the member avatar.

Both messages accept variables, so one line of text covers every join. {user.mention} pings the member, {server} names the server, and {user.join_position} tells them they are the four hundredth person through the door.

Nothing is sent until you turn the module on and turn on at least one of the two greetings.

Setup#

  1. Open the dashboard and go to Community > Welcome.
  2. Turn on Enable Welcome System.
  3. Turn on Channel Welcome, pick the channel, and write the message.
  4. Choose Plain text or Embed under Message Style, and style the embed if you picked one.
  5. Save, then send a test message to see it in the channel.

Settings#

SettingTypeDefaultWhat it does
Enable Welcome SystemToggleOffThe master switch. Nothing is sent while it is off.
Welcome delay (seconds, 0-60)Number0How long Iris waits after the join before greeting. Useful when verification runs first.
Channel WelcomeToggleOffPost the greeting in a channel.
Welcome ChannelChannelNoneWhere the channel greeting is posted.
Welcome MessageTextWelcome {user.mention} to {server}!The greeting itself. Variables are substituted per member.
Message StyleChoiceEmbedSend the greeting as plain text or as an embed.
Embed ColorColour#105380The embed accent bar.
Embed TitleTextNoneHeading above the embed description.
Embed DescriptionTextNoneThe embed body. Left blank, the welcome message above is used.
Show Thumbnail (user avatar)ToggleOnPuts the member avatar in the top right of the embed.
Show timestamp in the footerToggleOnAdds the join time to the embed footer.
Embed Image URLTextNoneA large image under the text. The image card replaces it while that is on.
Image CardToggleOffAttach a generated banner with the member avatar drawn on it.
Card styleChoiceDarkOne of dark, gradient, accent, light or custom.
Card TitleText{user.name} just joined the serverThe large line drawn on the card.
Card SubtitleTextMember #{server.member_count}The smaller line under the title.
Accent ColorColour#5865f2The card accent.
Background Image URLTextNoneBackground for the custom card style.
DM WelcomeToggleOffSend the new member a direct message as well.
DM MessageTextNoneThe direct message. A good place for rules and a first step.
DM StylePlain text / EmbedPlain textThe direct message has the same options as the channel message: plain text or an embed with its own color, title, thumbnail, footer and image.
DM Image CardToggleOffAttach a generated card to the direct message, with its own style, title, subtitle and accent.

Variables#

Available in the welcome message, the embed description, the DM and the card text. The dashboard lists the full set beside each field.

VariableBecomes
{user.mention}A ping for the member
{user.name}Their username
{user.join_position}Their join number, for example 42
{user.account_age}How old the account is, for example 900 days
{server}The server name
{server.member_count}Members after this join
{server.boost_level}Current boost tier
{server.member_count.ordinal}The same count as a place, for example 11th

Any variable that holds a number also answers to .ordinal, which writes it as a place rather than a count. {server.member_count.ordinal} gives 11th, so "you are our {server.member_count.ordinal} member" reads the way you would say it aloud. {ordinal_member} is the same thing for the join count.

Commands#

Welcome is configured on the dashboard. The prefix fallback is kept for when the dashboard is not to hand.

CommandWhat it doesRequires
.welcome helpShow the prefix subcommands for the channel, message, DM and delay.Manage Server

Permissions#

PermissionWhy Iris needs it
View ChannelsSees the welcome channel it posts in.
Send MessagesPosts the greeting.
Embed LinksSends the embed. Without it, embed greetings never appear.
Attach FilesUploads the generated image card.

What it looks like#

I
Iris APP Today at 8:52 PM
Welcome!

Welcome @newmember to Iris HQ. You are member #1,240.

Read the rules in #rules to get started
An embed greeting with the avatar thumbnail on.

Tips and gotchas#

The greeting did not appear.

Check the module and Channel Welcome are both on, that a channel is picked, and that Iris can send and embed in it.

A variable printed as literal text.

The name is wrong or the braces are mismatched. Copy it from the variables list on the dashboard.

Can I greet bots differently?

Bots are not greeted at all. Only human joins trigger the module.