ErisPulse Discord Adapter

English | 中文

English

A Discord Bot adapter for the ErisPulse framework, implementing multi-account support, diverse message types, and platform-specific event handling via Discord Gateway (WebSocket) and REST API v10.

Features

• Multi-Account: Run multiple Discord Bots simultaneously
• Gateway WebSocket: Full HELLO / IDENTIFY / Heartbeat / RESUME flow
• Auto-Reconnect: RESUME session recovery, no message loss
• REST API v10: Complete Discord HTTP API access
• Embed Support: Send and receive rich embed messages
• File Upload: multipart/form-data attachment uploads
• DM: Auto-create DM channels for private messaging
• Thread Support: Track and interact with Discord threads

Installation

epsdk install Discord

Configuration

Add to config/config.toml:

[DiscordAdapter.accounts.default]
token = "YOUR_BOT_TOKEN"
intents = 33281
enabled = true

# Multi-account example
[DiscordAdapter.accounts.bot2]
token = "ANOTHER_BOT_TOKEN"
intents = 33281
enabled = true

Configuration Fields

bot_id is discovered automatically at runtime from the Gateway READY event — no need to configure it.

Intents

Intents is a bitmask, default 33281 = GUILDS | GUILD_MESSAGES | MESSAGE_CONTENT:

Note: MESSAGE_CONTENT and GUILD_MEMBERS are Privileged Intents. Enable them in the Discord Developer Portal → Bot → Privileged Gateway Intents.

Inviting the Bot

The bot must be invited to a server before it can send/receive messages. Construct an OAuth2 URL:

https://discord.com/api/oauth2/authorize?client_id=YOUR_BOT_ID&permissions=8&scope=bot

• client_id = your Bot's Application ID (the bot_id shown in logs after READY)
• permissions=8 = Administrator (adjust as needed via Discord Permission Calculator)
• Add applications.commands to scope if using slash commands

Quick Start

from ErisPulse import sdk
from ErisPulse.Core.Event import message

discord = sdk.adapter.get("discord")

@message.on_message()
async def handle_message(event):
    if event.get_platform() != "discord":
        return

    text = event.get_text()
    channel_id = event.get_channel_id()  # Discord channel ID

    if text == "hello":
        # Reply to the channel where the message was received
        await event.reply("Hello from Discord!")

async def main():
    await sdk.run(keep_running=True)

Sending Messages

Text

# Guild channel message
await discord.Send.To("channel", channel_id).Text("Hello World!")

# Private message (auto-creates DM channel)
await discord.Send.To("user", user_id).Text("DM content")

Embed

embed = {
    "title": "Title",
    "description": "Description",
    "color": 5814783,
    "fields": [
        {"name": "Field", "value": "Value", "inline": False}
    ],
    "footer": {"text": "Footer text"},
}
await discord.Send.To("channel", channel_id).Embed(embed)

Media

# Image (URL)
await discord.Send.To("channel", channel_id).Image("https://example.com/image.png")

# Image (binary)
with open("image.png", "rb") as f:
    image_data = f.read()
await discord.Send.To("channel", channel_id).Image(image_data, filename="photo.png")

# File
await discord.Send.To("channel", channel_id).File("https://example.com/doc.pdf")
await discord.Send.To("channel", channel_id).File(file_bytes, filename="report.pdf")

Reply

# Chain modifier
await discord.Send.To("channel", channel_id).Reply(msg_id).Text("Reply content")

# One-shot
await discord.Send.To("channel", channel_id).Reply("Reply content", msg_id)

Mentions

# @single user
await discord.Send.To("channel", channel_id).At("user_id").Text("Hello")

# @multiple users
await discord.Send.To("channel", channel_id).At("user1").At("user2").Text("Hi everyone")

# @everyone
await discord.Send.To("channel", channel_id).AtAll().Text("Announcement")

Message Operations

# Delete (recall) a message
await discord.Send.To("channel", channel_id).Recall(msg_id)

OneBot12 Format

ob12_msg = [{"type": "text", "data": {"text": "Hello"}}]
await discord.Send.To("channel", channel_id).Raw_ob12(ob12_msg)

Multi-Account

# By bot_id (recommended)
await discord.Send.Using(event.get("self", {}).get("user_id")).To("channel", channel_id).Text("Hello")

# By account name
await discord.Send.Using("bot2").To("channel", channel_id).Text("Hello")

Discord-Specific Event Methods

The event object provides Discord-specific methods (requires platform == "discord"):

@message.on_message()
async def handle(event):
    if event.get_platform() != "discord":
        return

    channel_id = event.get_channel_id()    # Discord channel ID
    guild_id = event.get_guild_id()        # Guild ID (empty for DMs)
    username = event.get_username()         # Sender username
    global_name = event.get_global_name()   # Display name
    is_dm = event.is_dm()                   # Is a DM?
    embeds = event.get_embeds()             # Embed list
    attachments = event.get_attachments()   # Attachment list

Event Types

Message Events

Notice Events

Request Events

Message Segment Types

Session Types

Contributing

Issues and Pull Requests are welcome.

License

MIT

中文

基于 ErisPulse 框架的 Discord Bot 适配器，通过 Discord Gateway (WebSocket) 和 REST API v10 实现多账户支持、多种消息类型收发和平台特有事件处理。

特性

• 多账户支持：同时运行多个 Discord Bot
• Gateway WebSocket：完整实现 HELLO / IDENTIFY / 心跳 / RESUME 流程
• 自动断线重连：支持 RESUME 恢复会话，消息不丢失
• REST API v10：完整的 Discord HTTP API 调用
• Embed 支持：发送和接收富文本嵌入消息
• 文件上传：支持 multipart/form-data 上传附件
• DM 私信：自动创建 DM 频道，支持私信收发
• Thread 支持：跟踪和交互 Discord 话题

安装

epsdk install Discord

配置

在 config/config.toml 中添加：

[DiscordAdapter.accounts.default]
token = "YOUR_BOT_TOKEN"
intents = 33281
enabled = true

# 多账户示例
[DiscordAdapter.accounts.bot2]
token = "ANOTHER_BOT_TOKEN"
intents = 33281
enabled = true

配置字段

bot_id 运行时从 Gateway READY 事件自动发现，无需配置。

Intents 说明

Intents 是位掩码，默认 33281 = GUILDS | GUILD_MESSAGES | MESSAGE_CONTENT：

注意：MESSAGE_CONTENT 和 GUILD_MEMBERS 是 Privileged Intents，需在 Discord Developer Portal 的 Bot 设置页开启。

邀请机器人

机器人必须先被邀请加入服务器才能收发消息。构造 OAuth2 邀请链接：

https://discord.com/api/oauth2/authorize?client_id=你的BOT_ID&permissions=8&scope=bot

• client_id = 你的 Bot Application ID（READY 后日志中显示的 bot_id）
• permissions=8 = 管理员权限（可通过 Discord Permission Calculator 自行计算）
• 如需使用斜杠命令，在 scope 中添加 applications.commands

快速开始

from ErisPulse import sdk
from ErisPulse.Core.Event import message

discord = sdk.adapter.get("discord")

@message.on_message()
async def handle_message(event):
    if event.get_platform() != "discord":
        return

    text = event.get_text()
    channel_id = event.get_channel_id()  # Discord 频道 ID

    if text == "hello":
        # 回复到收到消息的频道
        await event.reply("Hello from Discord!")

async def main():
    await sdk.run(keep_running=True)

发送消息

文本消息

# 服务器频道消息
await discord.Send.To("channel", channel_id).Text("Hello World!")

# 私信（自动创建 DM 频道）
await discord.Send.To("user", user_id).Text("私信内容")

Embed 嵌入消息

embed = {
    "title": "标题",
    "description": "描述内容",
    "color": 5814783,
    "fields": [
        {"name": "字段名", "value": "字段值", "inline": False}
    ],
    "footer": {"text": "页脚文字"},
}
await discord.Send.To("channel", channel_id).Embed(embed)

媒体消息

# 发送图片（URL）
await discord.Send.To("channel", channel_id).Image("https://example.com/image.png")

# 发送图片（二进制数据）
with open("image.png", "rb") as f:
    image_data = f.read()
await discord.Send.To("channel", channel_id).Image(image_data, filename="photo.png")

# 发送文件
await discord.Send.To("channel", channel_id).File("https://example.com/doc.pdf")
await discord.Send.To("channel", channel_id).File(file_bytes, filename="report.pdf")

回复消息

# 链式修饰回复
await discord.Send.To("channel", channel_id).Reply(msg_id).Text("回复内容")

# 便捷方法（一步发送）
await discord.Send.To("channel", channel_id).Reply("回复内容", msg_id)

链式 @提及

# @单个用户
await discord.Send.To("channel", channel_id).At("user_id").Text("你好")

# @多个用户
await discord.Send.To("channel", channel_id).At("user1").At("user2").Text("大家好")

# @全体
await discord.Send.To("channel", channel_id).AtAll().Text("公告")

消息操作

# 撤回消息
await discord.Send.To("channel", channel_id).Recall(msg_id)

OneBot12 格式消息

ob12_msg = [{"type": "text", "data": {"text": "Hello"}}]
await discord.Send.To("channel", channel_id).Raw_ob12(ob12_msg)

多账户发送

# 通过 bot_id（推荐）
await discord.Send.Using(event.get("self", {}).get("user_id")).To("channel", channel_id).Text("Hello")

# 通过账户名
await discord.Send.Using("bot2").To("channel", channel_id).Text("Hello")

Discord 特有方法

事件对象提供以下 Discord 专属方法（需 platform == "discord"）：

@message.on_message()
async def handle(event):
    if event.get_platform() != "discord":
        return

    channel_id = event.get_channel_id()    # Discord 频道 ID
    guild_id = event.get_guild_id()        # 服务器 ID（私信为空）
    username = event.get_username()         # 发送者用户名
    global_name = event.get_global_name()   # 显示名
    is_dm = event.is_dm()                   # 是否私信
    embeds = event.get_embeds()             # Embed 列表
    attachments = event.get_attachments()   # 附件列表

事件类型

消息事件

通知事件

请求事件

消息段类型

会话类型

贡献

欢迎提交 Issue 和 Pull Request。

License

MIT