discord.py Project 4: ✍🏽Partnership Bot!

mikeywastaken

terabyte.

Posted on May 5, 2021

discord.py Project 4: 
 ✍🏽Partnership Bot!

In this article, we're going to create a Discord bot that can guide users through an automatic partnership process!

What's a Discord server partnership?

A discord server partnership is when two servers will send the other's invite link in a designated channel, to share members.

Our end product will look something like this:

The staff of your server will see this:
image

And will be able to click the checkmark or cross to accept or deny the request!

When it is accepted, it will automatically post the ad in a designated channel!
image


Installing discord.ext.forms 🔧

Discord.ext.forms is a module designed specifically to assist bot developers with making forms and surveys! To install it, you need to open a shell and type:

pip install discord-ext-forms
Enter fullscreen mode Exit fullscreen mode

Once that's done, you're ready to start coding!


Coding the bot ⚙

To start this off, we will need to start our commands.Bot instance.

from discord.ext import commands
import discord

bot = commands.Bot(command_prefix="!")

bot.run(TOKEN_HERE)
Enter fullscreen mode Exit fullscreen mode

Now that we have our bot, let's make our partner command!

from discord.ext import commands
import discord

bot = commands.Bot(command_prefix="!")

@bot.command()
async def partner(ctx):
    ...

bot.run(TOKEN)
Enter fullscreen mode Exit fullscreen mode

We need to import the Form class from discord.ext.forms to make our form for the partnership command!

from discord.ext.forms import Form
Enter fullscreen mode Exit fullscreen mode

Now, let's start on our form! We likely want to ask for an invite link, a description, and an advertising server, but you can add or remove any of these questions!

In our command, let's make our form:

form = Form(ctx, "Partnership Request")
Enter fullscreen mode Exit fullscreen mode

To add a question, we use the .add_question method of the form.

form.add_question(
        "What's the invite link to your server?", # The question which it will ask
        "invitelink", # What the form will call the result of this question
        "invite" # The type the response should be
    )
Enter fullscreen mode Exit fullscreen mode

Because we have invite as the type, discord.ext.forms will check that the response is an invite and return an invite object.

Now, let's add our other two questions!

@bot.command()
async def partner(ctx):
    form = Form(ctx, "Partnership Request")
    form.add_question(
        "What's the invite link to your server?", # The question which it will ask
        "invitelink", # What the form will call the result of this question
        "invite" # The type the response should be
    )
    form.add_question(
        "What's a description of your server?",
        "description"
    )
    form.add_question(
        "What's your server's advertisement?",
        "advertisement"
    )
Enter fullscreen mode Exit fullscreen mode

The final two don't have a type, because we just want the message's content.

Now, we'll want to begin the form!

results = await form.start()
Enter fullscreen mode Exit fullscreen mode

results will have 3 attributes:

  • invitelink
  • description
  • advertisement

These are the keys that we set these values to earlier!

Now, let's make our embed that shows the staff the submission:

embed = discord.Embed(
        title=f"Partnership Request from {results.invitelink.guild.name}",
        description=f"**Description:** {results.description}",
    )
    embed.set_thumbnail(url=results.invitelink.guild.icon_url)
    embed.set_author(name=ctx.author, icon_url=ctx.author.avatar_url)
Enter fullscreen mode Exit fullscreen mode

Now, let's get our partnerships channel so that we can send our embed there!

partnershipreq = bot.get_channel(partnership_request_channel_id_here)
Enter fullscreen mode Exit fullscreen mode

Lastly, let's send it!

prompt = await partnershipreq.send(embed=embed)
Enter fullscreen mode Exit fullscreen mode

For staff members to be able to accept and deny, we're going to need another form from discord.ext.forms: ReactConfirm.

from discord.ext.forms import Form, ReactConfirm
Enter fullscreen mode Exit fullscreen mode

The reason we saved prompt earlier is because we're going to need it for the accept/deny process. Use ReactConfirm to create a new form called confirm, like this:

confirm = ReactConfirm(user=ctx.author, message=prompt, bot=bot)
accepted = await confirm.start()
Enter fullscreen mode Exit fullscreen mode

Now, the bot, after sending the message, will react with the ✔ and ❌ emoji, and wait for a staff member to choose one.

We're nearly there! Now we just have to send the ad, in an embed of course, into the partnership channel if it gets accepted.

if accepted:
    partners = bot.get_channel(partners_channel_id_here)
    em = discord.Embed(title=results.invitelink.guild.name, 
    description=results.advertisement, color=0x2F3136)
    em.set_author(name=ctx.author, icon_url=ctx.author.avatar_url)
    em.set_thumbnail(url=results.invitelink.guild.icon_url)
    await partners.send(embed=em)
Enter fullscreen mode Exit fullscreen mode

Now we're done! Our final code looks something like this:

from discord.ext import commands
import discord
from discord.ext.forms import Form, ReactConfirm

bot = commands.Bot(command_prefix="!")

@bot.command()
async def partner(ctx):
    form = Form(ctx, "Partnership Request")
    form.add_question(
        "What's the invite link to your server?", # The question which it will ask
        "invitelink", # What the form will call the result of this question
        "invite" # The type the response should be
    )
    form.add_question(
        "What's a description of your server?",
        "description"
    )
    form.add_question(
        "What's your server's advertisement?",
        "advertisement"
    )
    results = await form.start()
    embed = discord.Embed(
        title=f"Partnership Request from {results.invitelink.guild.name}",
        description=f"**Description:** {results.description}",
    )
    embed.set_thumbnail(url=results.invitelink.guild.icon_url)
    embed.set_author(name=ctx.author, icon_url=ctx.author.avatar_url)
    partnershipreq = bot.get_channel(partnership_request_channel_id_here)
    prompt = await partnershipreq.send(embed=embed)
    confirm = ReactConfirm(user=ctx.author, message=prompt,bot=bot)
    accepted = await confirm.start()
    partners = bot.get_channel(partners_channel_id_here)
    em = discord.Embed(title=results.invitelink.guild.name, description=results.advertisement, color=0x2F3136)
    em.set_author(name=ctx.author, icon_url=ctx.author.avatar_url)
    em.set_thumbnail(url=results.invitelink.guild.icon_url)
    await partners.send(embed=em)


bot.run(TOKEN)
Enter fullscreen mode Exit fullscreen mode

If you want to see other use cases for this module, check it out here:

GitHub logo thrzl / discord-ext-forms

❓ a simpler way to make forms, surveys, and reaction input using discord.py.

💖 💪 🙅 🚩
mikeywastaken
terabyte.

Posted on May 5, 2021

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related