Discord 机器人是在 Discord 平台上运行的自动化程序。机器人可以做各种各样的事情，从播放音乐、发送自动消息、管理角色，到踢掉违反规则的用户，以及许多其他任务。
Discord 机器人的核心功能是基于事件构建的。例如，当发生新消息事件时，机器人可以发回消息，本质上允许其响应。
在本教程中，我们将创建一个简单的 Python Discord 机器人。我们将使用 discord.py 库，它简化了在 Python 中创建机器人的过程。让我们深入 Discord 机器人的世界！
在开始构建机器人之前，我们需要了解 Discord 的结构：
创建 Discord 机器人是一个简单、直接的过程，可以通过开发人员门户或任何代码编辑器完成。
在添加代码之前，需要创建一个机器人帐户。
转至 Discord 开发者门户：https://discord.com/developers/applications，登录，然后单击“新应用程序”。
命名该应用程序，然后单击左侧列表中的选项机器人。
现在，添加一个机器人并复制令牌，以便在命名后进一步使用。
Discord 机器人可能需要访问 Discord 本质上属于“敏感”的数据。
要让您的机器人访问特权意图，您需要在开发者门户的机器人部分下启用“特权网关意图”。
这仅适用于属于少于 100 个服务器的未经验证的机器人。
对于经过验证的机器人，需要请求特权意图。
Discord API 允许与其他服务进行更简单、更深入的集成，使用户能够获得更流畅的用户体验。
该 API 是一个开放 API，可用于服务机器人和 OAuth2 集成的请求。
目前正在使用各种版本的 API，您可以通过将其添加到请求路径（例如 https://discord.com/api/v{version_number}）来使用首选版本。
如果未提及版本，则使用默认版本进行后续操作。
要开始用 Python 创建 Discord 机器人，我们将使用“discord.py”库，它广泛实现了 Discord 的 API。您将需要 pip 命令来安装discord.py。
pip install -U discord.py 我们现在可以开始与 API 建立连接。
import discord
TOKEN = "Insert Your Token here"
discord_client = discord.Client()
@discord_client.event
async def on_ready():
print(f'{discord_client.user} Welcome to Discord!')
discord_client.run(TOKEN)
此代码用于建立与 Discord 的初始连接。我们首先导入需要的库discord.
代币值可以从开发者门户获取。您可以将令牌放置在程序中上面提供的占位符字符串中。
为了更安全的方法，您可以将其放置在 .env 文件中并在程序中引用该文件。
在程序中硬编码安全密钥并不是一个很好的开发人员实践。我们在这里这样做是为了演示目的。
The discord_clientobject 是 Client 类的实例，它是与 Discord 的连接。@client.event用于注册事件，当发生某些事件时（即触发某个事件）时调用它。
The on_ready当连接建立并且机器人准备好采取进一步步骤时，将调用该函数。
最后一步使用上面指定的登录令牌运行机器人。
现在运行代码以查看已建立的连接。
Output:
要在新用户加入服务器时打印欢迎消息，让我们添加一个新功能on_member_join到 Python 文件。
import discord
from discord.ext import commands
TOKEN ="Insert Your token here"
intents=discord.Intents.all()
client = commands.Bot(command_prefix=',', intents=intents)
@client.event
async def on_member_join(member):
await member.create_dm()
await member.dm_channel.send(f'Hi {member.name}, welcome to the test Discord server!')
client.run(TOKEN)
Output:
welcome_member 函数使用create.dm方法在加入时将欢迎消息作为直接消息发送给用户。
意图是根据运行机器人所需的功能启用的机器人权限。跑步on_member_join我们需要确保启用意图。
命令是执行特定操作或特定任务的简短指示。
机器人商店中提供的许多 Discord 机器人都有多个预先配置的命令，可以通过访问仪表板来启用或禁用这些命令。
除了该命令之外，在 Discord 中运行该命令所需的前缀也将可用。这些前缀可以有多种类型，例如感叹号等等。
Discord 具有多种类型的命令，例如聊天命令、文本命令和斜杠命令。斜杠类型命令始终使用斜杠作为前缀来执行。
文本命令需要根据命令的语法在文本框中输入，而聊天命令则直接在文本框中输入命令来使用。
import discord
import random
from discord.ext import commands
TOKEN ="Insert Your token here"
discord_bot = commands.Bot(command_prefix='!')
@discord_bot.command(name='morningquote')
async def msg(ctx):
quotes = [
"It's a new day",
(
"Be positive"
),
]
response = random.choice(quotes)
await ctx.send(response)
discord_bot.run(TOKEN)
在使用命令时，我们使用discord_bot.command将命令的前缀设置为 !并将命令名称传递为“morningquote”。
当用户键入时，机器人将执行该命令!morningquote在聊天中。
Output:
有时，您可能希望单个命令有多个名称。例如，您可能想要一个!hello命令也响应!hi.
这可以通过命令别名来完成。以下是向命令添加别名的方法：
@bot.command(aliases=['hi'])
async def hello(ctx):
await ctx.send('Hello!')
通过这段代码，两者!hello and !hi将触发命令并使机器人响应“Hello！”。您可以添加任意多个别名：
@bot.command(aliases=['hi', 'hola', 'bonjour', 'hallo'])
async def hello(ctx):
await ctx.send('Hello!')
Now !hello, !hi, !hola, !bonjour, and !hallo都会触发相同的命令。
为机器人创建帮助命令可以为用户提供有关如何使用机器人命令的信息。
幸运的是，discord.py 提供了一个可以轻松自定义的内置帮助命令。这是一个基本示例：
bot = commands.Bot(command_prefix='!', help_command=commands.DefaultHelpCommand()) 对于这行代码，如果您输入!help在机器人所在的频道中，它将响应机器人可以处理的命令列表以及每个命令的简短描述。
您可以通过子类化来自定义帮助命令commands.DefaultHelpCommand并重写它的方法。但是，对于大多数用例，默认的帮助命令就足够了。
带有选项的命令可以为您的discord 机器人添加更多功能。当您想让用户在多个选项之间进行选择时，这些类型的命令非常有用。
让我们创建一个基本的投票系统，用户可以在其中创建具有多个选项的投票，其他用户可以通过对机器人的消息做出反应来投票。
from collections import defaultdict
votes = defaultdict(int)
@bot.command()
async def vote(ctx, *options):
global votes
votes = defaultdict(int) # Reset previous votes
embed = discord.Embed(title="Vote", description="\n".join(f"{i}: {option}" for i, option in enumerate(options, start=1)))
message = await ctx.send(embed=embed)
# Add reactions
for i in range(1, len(options) + 1):
await message.add_reaction(f'{i}\N{COMBINING ENCLOSING KEYCAP}')
def check(reaction, user):
return user != bot.user and reaction.message.id == message.id and reaction.emoji.endswith('\N{COMBINING ENCLOSING KEYCAP}')
while True:
reaction, user = await bot.wait_for('reaction_add', check=check)
option = int(reaction.emoji[0]) - 1
votes[option] += 1
await reaction.remove(user) # Optional: remove the user's reaction
@bot.command()
async def results(ctx):
global votes
max_votes = max(votes.values())
winners = [option for option, vote in votes.items() if vote == max_votes]
await ctx.send(f"The winner(s) is/are option(s) {', '.join(map(str, winners))}!")
在这个例子中，vote是一个接受任意数量参数的命令，这些参数是要投票的选项。机器人发送一个列出选项的嵌入，并添加与每个选项相对应的反应。
当用户对数字做出反应时，votesdict 已更新为相应的选项。
The results然后命令确定得票最多的选项，并发送包含结果的消息。
具有多个参数的命令使您的 Discord 机器人能够一次接受多个输入。
这些命令可用于各种任务，例如计算总和、解析复杂的用户输入或处理多个选择。
让我们创建一个接受两个参数并将它们加在一起的命令：
@bot.command()
async def add(ctx, num1: int, num2: int):
result = num1 + num2
await ctx.send(f'The sum is {result}.')
在这个例子中，add是一个接受两个整数作为参数的命令。机器人计算两个数字的总和并发送包含结果的消息。
The num1: int and num2: int命令定义中的语法告诉discord.py 自动将参数转换为整数。
如果用户输入无法转换为整数的内容，discord.py 将自动发送错误消息。
对于具有多个参数的更复杂的命令，您可以使用*args or **kwargs接受任意数量的参数。下面是一个将任意数量的数字相加的命令示例：
@bot.command()
async def add(ctx, *nums: int):
result = sum(nums)
await ctx.send(f'The sum is {result}.')
在这个例子中，nums是一个包含传递给命令的所有参数的元组。这sum()函数将它们全部加在一起。
该命令可以处理任意数量的参数 - 例如，“!add 1 2 3”与“!add 1 2”一样有效。
Discord.py 提供了一个简单的机制来处理这些错误：@command.error装饰师。该装饰器允许您指定在运行命令时发生错误时要调用的函数。
以下是如何使用此装饰器处理错误的示例：
@bot.command()
async def add(ctx, num1: int, num2: int):
result = num1 + num2
await ctx.send(f'The sum is {result}.')
@add.error
async def add_error(ctx, error):
if isinstance(error, commands.BadArgument):
await ctx.send('Please make sure to provide two numbers.')
elif isinstance(error, commands.MissingRequiredArgument):
await ctx.send('You forgot to provide one or both numbers.')
else:
await ctx.send('An unknown error occurred.')
在此代码片段中，add_error函数被定义为错误处理程序add命令。
如果错误是BadArgument错误，当参数无法转换为所需类型时会发生这种情况，机器人会发送一条消息，要求提供两个数字。
如果错误是MissingRequiredArgument错误，当用户忘记提供一个或两个号码时会发生这种情况，机器人会发送一条消息通知用户。
如果错误是其他原因，机器人只会通知用户发生了错误。
在繁忙的服务器中，某些用户可能会向您的机器人发送垃圾命令，这可能会导致速率限制或性能问题。
为了防止这种情况，您可以对机器人的命令应用冷却时间。冷却时间意味着每个用户在使用命令之间必须等待一定的时间。
Discord.py 提供了一个装饰器，@commands.cooldown()，它允许您轻松设置命令的冷却时间。该装饰器采用三个参数：
这是如何使用的示例@commands.cooldown()装饰器对命令应用冷却时间：
@bot.command()
@commands.cooldown(1, 5, commands.BucketType.user)
async def echo(ctx, *, message: str):
await ctx.send(message)
在此示例中，echo每个用户命令的冷却时间为 5 秒。这意味着每个用户每 5 秒只能使用该命令一次。
如果用户尝试在冷却时使用该命令，discord.py 将自动发送错误消息。
您还可以处理CommandOnCooldown发送自定义消息时出错：
@echo.error
async def echo_error(ctx, error):
if isinstance(error, commands.CommandOnCooldown):
await ctx.send(f'This command is on cooldown, please try again in {error.retry_after:.2f} seconds.')
else:
await ctx.send('An unknown error occurred.')
在此代码片段中，当CommandOnCooldown引发错误时，机器人会发送一条消息，通知用户需要等待多长时间才能再次使用该命令。
要使用 Python 发送任何数据，我们使用send() method.
要发送文本，请将内容添加到方法中，如下所示：
import discord
from discord.ext import commands
TOKEN = "Insert Your token here"
discord_bot = commands.Bot(command_prefix='!')
@discord_bot.command(name='senddata')
async def send_data(ctx):
await ctx.send("hello there")
discord_bot.run(TOKEN)
Output:
要发送图像，请将图像文件添加到方法中，如下所示。当在聊天中使用命令 !sendimg 时，将发送文件 my_file.png。
import discord
from discord.ext import commands
import os
os.chdir("Your file path")
TOKEN = "Insert Your token here"
discord_bot = commands.Bot(command_prefix='!')
@discord_bot.command(name='senddata')
async def send_img(ctx):
await ctx.send("image",file=discord.File('Your file name'))
discord_bot.run(TOKEN)
Output:
要发送文件或类似文件的对象，您需要首先使用以下命令打开文件open()方法，然后使用send发送数据的方法。
在 Discord 中，可以通过代码标记发送 8 种不同颜色的文本。它用Highlight.js和晒黑主题来达到这种效果。
import discord
from discord.ext import commands
TOKEN = "Insert Your token here"
discord_bot = commands.Bot(command_prefix='!')
@discord_bot.command(name='coloured_text')
async def test(ctx):
retStr = str("""```yaml\nThis is some colored Text```""")
await ctx.send(retStr)
discord_bot.run(TOKEN)
Output:
```yaml是用于指示晒青色的标记。下面是转义序列或标记及其颜色代码的列表，可用于为文本着色。
在提到的地方使用特殊字符，例如“#”、“[”等，以获得所需的颜色。请注意，彩色文本在 Web 应用程序中可见，但在移动应用程序中不可见。
Default: #839496
```
Your text
```
Quote: #586e75
```bash
#Your text
```
Solarized Green: #859900
```diff
+ Your text
```
Solarized Cyan: #2aa198
```yaml
Your text
```
or
```cs
"Your text"
```
Solarized Blue: #268bd2
```ini
[Your text]
```
Solarized Yellow: #b58900
```fix
Your text
```
Solarized Orange: #cb4b16
```css
[Your text]
```
Solarized Red: #dc322f
```diff
-Your text
```
Simply replace the markup with markup for the desired color. The image below shows what the colors look like.
要根据用户 ID 获取用户名，我们将使用fetch_user方法。如果需要用户的完整个人资料，那么我们可以使用fetch_user_profile method.
import discord
from discord.ext import commands
TOKEN = "Insert Your token here"
discord_bot = commands.Bot(command_prefix='!')
@discord_bot.command(name='username')
async def user_name(ctx,user_id):
user=await discord_bot.fetch_user(user_id)
await ctx.send(user)
discord_bot.run(TOKEN)
Output:
角色用于将权限委托给服务器内的用户以帮助管理。
角色可以在大型公共服务器中实现，例如在基于学习的服务器中，可以将“学生级别 1”、“学生级别 2”、“教师”和“主持人”等角色分配给用户。
如果有需要，它们也可以与朋友一起在私人服务器上实现。
每个角色都有不同的颜色和与其关联的不同权限。
用户继承分配给他们的每个角色的最大权限。
颜色的工作方式也类似，成员的名称继承层次结构中最高位置或最大权限的角色。
这些角色在 Discord 中具有线性层次结构，可以通过“角色”选项卡中的“管理角色”选项进行管理。
还可以建立具有独立管理权限的多个角色，以便一个用户的职责不会干扰另一用户。
import discord
from discord import Member
from discord.ext.commands import has_permissions, MissingPermissions
from discord.ext import commands
TOKEN = "Insert Your token here"
intents=discord.Intents.all()
intents.members=True
bot = commands.Bot(command_prefix="!",intents=intents)
#code to add role
@bot.command()
@commands.has_permissions(manage_roles = True)
async def addRole(ctx, user : discord.Member, role:discord.Role):
await user.add_roles(role)
await ctx.send(f" Added {role} to {user.ention}")
@addRole.error
async def role_error(self,ctx,error):
if isinstance(error, commands.MissingPermissions):
await ctx.send("You are not authorized for this action")
bot.run(TOKEN)
要添加角色，首先，我们使用命令确保尝试添加角色的用户有权执行此操作。
然后我们使用add_roles方法向用户添加功能。
根据需要，您可以允许为一个用户分配多个角色，也可以使用 if-else 语句仅允许一个角色。
role_error 函数用于在未经授权的用户尝试将角色分配给其他用户的情况下打印错误消息。
Output:
用户被分配“testoo”角色。
许多 Discord 服务器被配置为在用户加入服务器时通过直接消息发送欢迎消息，或者在用户违反任何服务器规则时发送警告。
让我们看一下在使用指定命令时发送 DM 的代码。
import discord
from discord.ext import commands
TOKEN ="Insert Your token here"
intents=discord.Intents.all()
client = commands.Bot(command_prefix='!', intents=intents)
@client.command()
async def drtmsg(ctx, user:discord.Member, *, message=None):
message = "welcome"
embed=discord.Embed(title=message)
await user.send(embed=embed)
client.run(TOKEN)
该函数将接受诸如以下的输入!drtmsg @User然后通过私人消息发送消息“欢迎”给所选用户。
Output:
我们首先导入asyncio包进行并发编程。我们可以用ctx.guild.roles访问服务器中声明的角色。
角色列表被提取到user.roles然后我们可以遍历它以找到成员的正确角色并向他们发送所需的消息。
import asyncio
import discord
from discord.ext import commands, tasks
Token ="Insert Your token here"
prefix="!"
intents=discord.Intents.all()
bot = commands.Bot(command_prefix=prefix,intents=intents)
@bot.command(name='dm')
async def msg(ctx):
for guild in bot.guilds: # all servers of the bot
role = discord.utils.find(lambda r: r.name == 'Your role name', guild.roles)
for member in guild.members:
if role in member.roles:
await member.send("Dm to role member")
bot.run(Token)
Output:
要从服务器中删除成员，您需要将以下代码添加到 Python 文件中。
import discord
from discord import Member
from discord.ext import commands
from discord.ext.commands import has_permissions, MissingPermissions
TOKEN = "Insert Your token here"
intents=discord.Intents.all()
discord_client = commands.Bot(command_prefix='!',intents=intents)
@discord_client.command()
@has_permissions(kick_members=True)
async def kick(ctx, member:discord.Member,*,reason=None):
await member.kick(reason=reason)
await ctx.send(f'The User {member} has been kicked from the server')
@kick.error
async def kick_error(ctx,error):
if isinstance(error,commands.MissingPermissions):
await ctx.send("You do not have required permission for the action performed")
discord_client.run(TOKEN)
首先，从不和谐库中导入成员和所需的权限方法，以便我们能够管理权限并解决用户问题。
We use @discord_client.command()使用机器人的客户端对象并通知它前面编写的代码是一个命令。@has_permissions用于检查执行操作的用户是否有权这样做。kick是执行从服务器中删除给定用户的操作的函数。
也可以给出动态原因，但我们简单地将原因表述为“测试”。
第二个功能kick_error是一个异常函数，如果用户无权踢出另一个用户，则执行该函数并打印错误消息。
被踢出的用户并不会被永久禁止使用服务器。
为了确保将用户添加到服务器的禁止成员列表中，请添加下面定义的函数。
这将确保用户只要存在于列表中就无法重新加入服务器。
import discord
from discord import Member
from discord.ext import commands
from discord.ext.commands import has_permissions, MissingPermissions
TOKEN = "Insert Your token here"
intents=discord.Intents.all()
discord_client = commands.Bot(command_prefix='!',intents=intents)
@discord_client.command()
@has_permissions(ban_members=True)
async def ban(ctx, member:discord.Member,*,reason=None):
await member.ban(reason=reason)
await ctx.send(f'The User {member} has been banned from the server')
@ban.error
async def ban_error(ctx,error):
if isinstance(error,commands.MissingPermissions):
await ctx.send("You do not have required permission for the action performed")
discord_client.run(TOKEN)
Output:
要在特定时间发送消息，datetime除了库之外还需要discord到目前为止一直在使用的库。
import discord
from datetime import datetime
client = discord.Client()
token = "Insert Your token here"
channel_id=Insert Your channel id without quotes
def time_required():
while True:
current_time = datetime.now().strftime("%H:%M")
if current_time == "Insert required time":
print("time reached")
break
time_required()
@client.event
async def on_ready():
print("bot:user ready == {0.user}".format(client))
channel = client.get_channel(channel_id)
await channel.send("timed message")
client.run(token)
The time_required创建函数来确定何时发送消息。在达到所需时间之前，机器人将处于睡眠模式。
一旦到了发送消息的时间，on_ready 事件将被执行，消息“定时消息”将在代码中提到的通道 id 中发送。
Output:
有时，您可能希望机器人定期执行某些操作，例如每小时发送一条消息。
这可以通过任务来完成，任务是 discord.py 的一项功能，允许您安排以特定时间间隔调用异步函数。
这是一个例子：
from discord.ext import tasks
@tasks.loop(hours=1)
async def every_hour():
channel = bot.get_channel(123456) # Replace with your channel's ID
await channel.send("It's a new hour!")
every_hour.start()
此任务将发送一条消息说“这是新的一小时了！”每小时到指定频道。
有时，用户可能会使用不适当的语言，服务器管理员可能希望删除这些语言，以维持服务器的礼仪。
为了避免逐条分析每条消息，可以编写一个函数来自动过滤并删除包含预定义禁用单词列表中的单词的消息。
确保您的机器人具有运行此代码的管理功能。
In the on_message函数，如果用户发送的消息包含列表中的单词bannedWords，该消息将被删除并向用户发送警告，以防止他们再次使用此类词语发送。
然后我们使用process_commands确保机器人继续处理分配给它的其他命令。
import discord
from discord.ext import commands, tasks
import re
Token ="Insert Your token here"
prefix="!"
bot = commands.Bot(command_prefix=prefix)
def msg_contains_word(msg, word):
return re.search(fr'\b({word})\b', msg) is not None
@bot.command()
async def loadcog(ctx, cog):
bot.load_extension(f"cogs.{cog}")
@bot.command()
async def unloadcog(ctx, cog):
bot.unload_extension(f"cogs.{cog}")
bannedWords={"ret"}
@bot.event
async def on_message(message):
messageAuthor = message.author
if bannedWords != None and (isinstance(message.channel, discord.channel.DMChannel) == False):
for bannedWord in bannedWords:
if msg_contains_word(message.content.lower(), bannedWord):
await message.delete()
await message.channel.send(f"{messageAuthor.mention} Message contains a banned word.")
await bot.process_commands(message)
bot.run(Token)
Output:
Discord 是一款功能强大的社交媒体工具，具有广泛的功能。机器人的用途也非常广泛，能够做很多事情，其中一些已经在本教程中介绍了。
通过使用正确的命令和事件组合，我们可以让我们的机器人做更多的事情。
https://discordpy.readthedocs.io/en/latest/index.html