Module aethersprite.extensions.base.greet

Greet extension; sends a pre-defined greeting to a specified channel when new users join the guild.

Functions

async def on_member_join(member: discord.member.Member)

Expand source code

async def on_member_join(member: Member):
    """Greet members when they join."""

    chan_setting = settings["greet.channel"].get(member)
    msg_setting = settings["greet.message"].get(member)

    if chan_setting is None or msg_setting is None:
        return

    channel = [c for c in member.guild.channels if c.name == chan_setting][0]
    log.info(
        f"Greeting new member {member} in {member.guild.name} #{channel.name}"
    )
    await channel.send(  # type: ignore
        msg_setting.format(
            mention=member.mention,
            name=member.display_name,
            nl="\n",
        )
    )

Greet members when they join.

async def setup(bot: discord.ext.commands.bot.Bot)

Expand source code

async def setup(bot: Bot):
    # settings
    register(
        "greet.channel",
        None,
        lambda x: True,
        False,
        "The channel where greetings should be sent.",
        filter=channel_filter,
    )
    register(
        "greet.message",
        None,
        lambda x: True,
        False,
        "The message new members will be greeted with. You may use "
        "the `{name}` token in your message and it will be replaced "
        "automatically with the member's username. The `{nl}` token "
        "will be replaced with a line break (new line).",
    )

    bot.add_listener(on_member_join)