Skip to content

advanced.md

Latest commit

 

History

History
376 lines (286 loc) · 12.4 KB

advanced.md

File metadata and controls

376 lines (286 loc) · 12.4 KB

Advanced Python

DISCLAIMER: This Guide has been written by the community

Learn more about Discord-Bots written in python.

Note

Please first read the basic python tutorial!

Library set up

  • Please install ezcord as shown in the first tutorial.

Creating an new command: echo

This command let you send a message in the name of the bot.

  1. First create the command
@bot.slash_command(name='echo', description='Send a message in the name of the bot.')
async def echo():
  1. Now we need some parameters in the async def function.
@bot.slash_command(name='echo', description='Send a message in the name of the bot.')
async def echo(
        ctx,
        text: Option(str, "The text you want to send"),
        channel: Option(discord.TextChannel, "The channel, the message should be send to.")):
):
  1. Now we add the code to send the message. Also this shows you if the message was sent.
@bot.slash_command(name='echo', description='Send a message in the name of the bot.')
async def echo(
        ctx,
        text: Option(str, "The text you want to send"),
        channel: Option(discord.TextChannel, "The channel, the message should be send to.")):
    await channel.send(text)
    await ctx.respond("Message sent", ephemeral=True)
  1. We don't want that users that aren't an administrator on the Discord-Server can use this command
@bot.slash_command(name='echo', description='Send a message in the name of the bot.')
@discord.default_permissions(administrator=True)
@commands.has_permissions(administrator=True)
async def echo(
        ctx,
        text: Option(str, "The text you want to send"),
        channel: Option(discord.TextChannel, "The channel, the message should be send to.")):
    await channel.send(text)
    await ctx.respond("Message sent", ephemeral=True)
  1. We also don't want, that the command gets abused, so we add a limit to only allow every user to use that command once every 30 seconds.
@bot.slash_command(name='echo', description='Send a message in the name of the bot.')
@discord.default_permissions(administrator=True)
@commands.has_permissions(administrator=True)
@commands.cooldown(1, 30, commands.BucketType.member)
async def echo(
        ctx,
        text: Option(str, "The text you want to send"),
        channel: Option(discord.TextChannel, "The channel, the message should be send to.")):
    await channel.send(text)
    await ctx.respond("Message sent", ephemeral=True)

That command is now finished.

Insert into the code in the main.py file

  1. We first have to import ezcord at the top.
  2. Also we have to import Option from discord.commands and commands from discord.ext.
  3. Now we have to replace the discord.Bot with ezcord.Bot.
import discord
from discord.commands import Option
from discord.ext import commands
import ezcord

intents = discord.Intents.default()
# This sets the intents to the default intents of discord.
intents.message_content = True
# This allowes the bot to view the content of messages

bot = ezcord.Bot(intents=intents)
# Creates the bot with the intents

TOKEN = 'TOKEN'
# This sets the variable TOKEN with your token


@bot.event
# This calls the event listener of py-cord to listen to the on_ready event and when its executed to run the code
async def on_ready():
    print(f'{bot.user} has connected to Discord!')
    # This will be printed when the Bot has successfully connected to Discord


@bot.event
# This calls the event listener of py-cord to listen to the on_message event and when its executed to run the code
# This is an old method. Please use slash-commands if you can.
async def on_message(message):
    if message.content == 'ping':
        # This is checking if the message equals  "ping"
        channel = message.channel
        # This gets the channel from discord and puts it into a variable
        await channel.send('pong!')
        # This is responding "pong" to the message


@bot.slash_command(name='ping', description='Ping!')
# This calls the slash command manager of py-cord to create a new command with the name ping and description "Ping!"
# and when the command is executed to run the code
async def ping(ctx):
    latency = bot.latency * 1000
    await ctx.respond(f"Latency: {latency:.2f} ms!")
    # This is responding with the latency of the bot, to the command


bot.run(TOKEN)
# This will start the Bot
  1. Next we will insert the new command.
import discord
from discord.commands import Option
from discord.ext import commands
import ezcord

intents = discord.Intents.default()
# This sets the intents to the default intents of discord.
intents.message_content = True
# This allowes the bot to view the content of messages

bot = ezcord.Bot(intents=intents)
# Creates the bot with the intents

TOKEN = 'TOKEN'
# This sets the variable TOKEN with your token


@bot.event
# This calls the event listener of py-cord to listen to the on_ready event and when its executed to run the code
async def on_ready():
    print(f'{bot.user} has connected to Discord!')
    # This will be printed when the Bot has successfully connected to Discord


@bot.event
# This calls the event listener of py-cord to listen to the on_message event and when its executed to run the code
# This is an old method. Please use slash-commands if you can.
async def on_message(message):
    if message.content == 'ping':
        # This is checking if the message equals  "ping"
        channel = message.channel
        # This gets the channel from discord and puts it into a variable
        await channel.send('pong!')
        # This is responding "pong" to the message


@bot.slash_command(name='ping', description='Ping!')
# This calls the slash command manager of py-cord to create a new command with the name ping and description "Ping!"
# and when the command is executed to run the code
async def ping(ctx):
    latency = bot.latency * 1000
    await ctx.respond(f"Latency: {latency:.2f} ms!")
    # This is responding with the latency of the bot, to the command


@bot.slash_command(name='echo', description='Send a message in the name of the bot.')
@discord.default_permissions(administrator=True)
@commands.has_permissions(administrator=True)
@commands.cooldown(1, 30, commands.BucketType.member)
async def echo(
        ctx,
        text: Option(str, "The text you want to send"),
        channel: Option(discord.TextChannel, "The channel, the message should be send to.")):
    await channel.send(text)
    await ctx.respond("Message sent", ephemeral=True)


bot.run(TOKEN)
# This will start the Bot

Activity and Status

  1. We will create an activity like playing discord and a status (online, idle, do not disturbe)
  2. First we will set a status.
status = discord.Status.online
# can be online, dnd, idle or offline
  1. Next we will set the activity.
activity = discord.Activity(type=discord.ActivityType.playing, name="Discord")
# the type can be playing, watching, listening, competing or streaming
# the name can be anything you want.
  1. Now we will insert this into our code.
import discord
from discord.commands import Option
from discord.ext import commands
import ezcord

intents = discord.Intents.default()
# This sets the intents to the default intents of discord.
intents.message_content = True
# This allowes the bot to view the content of messages

status = discord.Status.online
# can be online, dnd, idle or offline
activity = discord.Activity(type=discord.ActivityType.playing, name="Discord")
# the type can be playing, watching, listening, competing or streaming
# the name can be anything you want.

bot = ezcord.Bot(intents=intents, status=status, activity=activity)
# Creates the bot with the intents

TOKEN = 'TOKEN'
# This sets the variable TOKEN with your token


@bot.event
# This calls the event listener of py-cord to listen to the on_ready event and when its executed to run the code
async def on_ready():
    print(f'{bot.user} has connected to Discord!')
    # This will be printed when the Bot has successfully connected to Discord


@bot.event
# This calls the event listener of py-cord to listen to the on_message event and when its executed to run the code
# This is an old method. Please use slash-commands if you can.
async def on_message(message):
    if message.content == 'ping':
        # This is checking if the message equals  "ping"
        channel = message.channel
        # This gets the channel from discord and puts it into a variable
        await channel.send('pong!')
        # This is responding "pong" to the message


@bot.slash_command(name='ping', description='Ping!')
# This calls the slash command manager of py-cord to create a new command with the name ping and description "Ping!"
# and when the command is executed to run the code
async def ping(ctx):
    latency = bot.latency * 1000
    await ctx.respond(f"Latency: {latency:.2f} ms!")
    # This is responding with the latency of the bot, to the command


@bot.slash_command(name='echo', description='Send a message in the name of the bot.')
@discord.default_permissions(administrator=True)
@commands.has_permissions(administrator=True)
@commands.cooldown(1, 30, commands.BucketType.member)
async def echo(
        ctx,
        text: Option(str, "The text you want to send"),
        channel: Option(discord.TextChannel, "The channel, the message should be send to.")):
    await channel.send(text)
    await ctx.respond("Message sent", ephemeral=True)


bot.run(TOKEN)
# This will start the Bot

Storing your Bot Token more safe

Now we will store our Bot Token in an external File. For that, please install python-dotenv.

  1. After the installation of the package, we will create a file called .env. In this we will write:

TOKEN = and then your Bot Token.

  1. The next step is to adjust our main.py file. First, we have to add the text:
from dotenv import load_dotenv

at the top and at the bottom, replace the bot.run(TOKEN) with:

load_dotenv()
bot.run(os.getenv("TOKEN"))

Now in your main.py this should look like this

import discord
from discord.commands import Option
from discord.ext import commands
from dotenv import load_dotenv
import ezcord

intents = discord.Intents.default()
# This sets the intents to the default intents of discord.
intents.message_content = True
# This allowes the bot to view the content of messages

status = discord.Status.online
# can be online, dnd, idle or offline
activity = discord.Activity(type=discord.ActivityType.playing, name="Discord")
# the type can be playing, watching, listening, competing or streaming
# the name can be anything you want.

bot = ezcord.Bot(intents=intents, status=status, activity=activity)
# Creates the bot with the intents



@bot.event
# This calls the event listener of py-cord to listen to the on_ready event and when its executed to run the code
async def on_ready():
    print(f'{bot.user} has connected to Discord!')
    # This will be printed when the Bot has successfully connected to Discord


@bot.event
# This calls the event listener of py-cord to listen to the on_message event and when its executed to run the code
# This is an old method. Please use slash-commands if you can.
async def on_message(message):
    if message.content == 'ping':
        # This is checking if the message equals  "ping"
        channel = message.channel
        # This gets the channel from discord and puts it into a variable
        await channel.send('pong!')
        # This is responding "pong" to the message


@bot.slash_command(name='ping', description='Ping!')
# This calls the slash command manager of py-cord to create a new command with the name ping and description "Ping!"
# and when the command is executed to run the code
async def ping(ctx):
    latency = bot.latency * 1000
    await ctx.respond(f"Latency: {latency:.2f} ms!")
    # This is responding with the latency of the bot, to the command


@bot.slash_command(name='echo', description='Send a message in the name of the bot.')
@discord.default_permissions(administrator=True)
@commands.has_permissions(administrator=True)
@commands.cooldown(1, 30, commands.BucketType.member)
async def echo(
        ctx,
        text: Option(str, "The text you want to send"),
        channel: Option(discord.TextChannel, "The channel, the message should be send to.")):
    await channel.send(text)
    await ctx.respond("Message sent", ephemeral=True)


load_dotenv()
bot.run(os.getenv("TOKEN"))
# This will start the Bot

Final