Welcome screen

This page covers the welcome screen: the card a community guild shows to new members, with a description and up to five recommended channels. You're assumed to have a bot named "my-bot" logged in, a guild with Community enabled, and Manage Server for the bot if it edits the screen.

Reading the welcome screen

welcome screen of %guild% asks Discord for the current screen, so it requires await. What comes back is a snapshot: it does not change when the screen is edited, read it again for that.

on message received seen by "my-bot":
    if discord content of event-message is "!welcome":
        await set {_screen} to the welcome screen of event-guild
        reply with "%description of {_screen}%"
        loop welcome channels of {_screen}:
            reply with "%welcome channel of loop-value%: %description of loop-value% %emoji of loop-value%"

Each entry of welcome channels is a welcomechannel with three properties: welcome channel (the channel itself, none if the bot cannot see it), description and emoji, the emoji as it renders in a message.

Editing the welcome screen

Editing goes through a builder, but not the usual one: the welcome screen already exists, so there is nothing to build. Create it with a new welcome screen builder for %guild%, set what you want to change, then send it with update the welcome screen using %welcomescreenbuilder%. That effect waits for Discord, so the next line already sees the new screen.

on message received seen by "my-bot":
    if discord content of event-message is "!set-welcome":
        set {_rules} to a new welcome channel for event-channel with description "Read the rules" with emoji "📜"
        set {_b} to a new welcome screen builder for event-guild
        set welcome screen enabled of {_b} to true
        set description of {_b} to "Welcome to the guild!"
        set welcome channels of {_b} to {_rules}
        update the welcome screen using {_b}

Only the properties you set are sent; the others keep their value on Discord.

Options

a new welcome channel for %guildchannel% with description %string% [with emoji %emote/string%] creates one entry. The description is 42 characters at most, the emoji is optional (a unicode emoji, an emote, or the <:name:id> form of a custom one), and the channel must be a text, voice, stage, news or forum channel: a category or a thread is refused. An entry never changes once created; make a new one to change it.

on message received seen by "my-bot":
    if discord content of event-message is "!add-welcome":
        await set {_screen} to the welcome screen of event-guild
        set {_b} to a new welcome screen builder for event-guild
        set welcome channels of {_b} to welcome channels of {_screen}
        add (a new welcome channel for event-channel with description "Say hi") to welcome channels of {_b}
        update the welcome screen using {_b}

remove takes an entry and drops every entry pointing to the same channel, whatever its description. delete welcome channels of {_b} empties the list, which clears it on Discord once the builder is sent.

Errors you may see