discomposer for discord.py

Validate, fetch and send Discord message templates as Components V2.
Design the message in the visual editor, send it from your bot with a code.

discomposer only builds messages. What a button or selection does (open a ticket, hand out a role) stays in your bot.

Install

pip install discomposer

Requires Python 3.11+ and discord.py 2.6+.

Fetch a template and send it

import discord
from discomposer import EditorClient, MediaStore, render_message, select_rows

editor = EditorClient(media=MediaStore("data/media"))

async def send(channel, code):
    design = await editor.fetch(code)  # validates and keeps a copy of every image
    view = discord.ui.LayoutView(timeout=None)
    for item in render_message(
        design,
        guild=channel.guild,
        buttons={"ticket": lambda b: discord.ui.Button(label=b["label"], custom_id="mybot:ticket")},
        slots={"online": "12 members online"},
        selects=lambda menu, guild: select_rows(menu, f"mybot:{menu['id']}"),
    ):
        view.add_item(item)
    await channel.send(view=view, files=editor.media.files_for(design))

render_message returns the text outside the box (if any) and the filled container. Use render to fill a container you created yourself.

Offer your bot's features in the editor

from discomposer import guild_context

link = await editor.open({
    "title": "Ticket panel",
    "context": {
        **guild_context(guild),
        "buttons": [{"id": "ticket", "label": "Open ticket"}],
        "selects": [{"purpose": "ticket_categories", "label": "Ticket categories", "roles": "optional"}],
    },
    "design": {"blocks": [{"text": "## Support"}]},
})

The person designs the message at link and gives your bot the new code.

Handle a selection

Values and roles only ever come from the stored template, never from the interaction:

from discomposer import category_roles, chosen_category, ticket_overwrites

option = chosen_category(saved_design, "tickets", interaction.data["values"][0])
if option:
    roles = category_roles(guild, option)
    channel = await guild.create_text_channel(
        f"ticket-{interaction.user.name}",
        overwrites=ticket_overwrites(guild, interaction.user, roles),
    )

API overview

Errors: TemplateError (format), EditorError (editor, network), MediaError (images). Messages are written for end users.

The template format is specified in spec/FORMAT.md. A JavaScript version for discord.js is available as discomposer on npm.

discomposer is not affiliated with or endorsed by Discord Inc.