Flutter Discord交互插件 discord_interactions 的使用

Features

Supported APIs

全量支持所有 Discord API 端点的计划正在进行中。

Getting Started

这个包是为了在无服务器平台上运行一个 Discord bot。下面是一个基于 Google Cloud Run 的示例，但其他支持运行 Dart 代码的提供商也可以工作。

示例项目结构

my_discord_bot/
├── lib/
│   ├── main.dart
│   └── credentials.dart
└── script/
    └── create_commands.dart

创建应用和机器人

1. 在 Discord Developer Portal 上创建一个应用。
2. 为你的应用创建一个机器人。
3. 使用 OAuth2 URL 生成器为机器人生成邀请链接，并将机器人邀请到一个服务器（Guild）。
   • 对于基本交互机器人，只需 applications.commands 权限即可管理并响应应用程序命令。
   • 如果需要进行权限管理和服务器管理等操作，则需要 bot 权限。
   • 只有 applications.commands 权限的机器人不会显示在用户列表中。

配置凭据

在 lib/credentials.dart 中配置你的凭据：

class Credentials {
  static const applicationPublicKey = 'your-application-public-key';
  static const applicationId = 'your-application-id';
  static const botToken = 'your-bot-token';
  static const userAgentUrl = 'your-user-agent-url';
  static const guildId = 'your-guild-id';
}

部署

按照 Google Cloud Run 快速入门指南中的 Prerequisites 和 Build and deploy with a single command 步骤进行部署。

Usage

请求验证

首先，你需要验证所有发送给机器人的请求。你必须拒绝无效的请求。InteractionValidator 类可以帮助你完成这个任务。applicationPublicKey 来自你在 Discord 开发者门户上的应用页面。

import 'package:discord_interactions/discord_interactions.dart';

final validator = InteractionValidator(applicationPublicKey: Credentials.applicationPublicKey);

final valid = validator.validate(headers: request.headers, body: body);
if (!valid) {
    return Response(401, body: 'invalid request signature');
}

响应 Ping 请求

其次，你必须用 pong 响应来回应 ping 请求。

final interaction = Interaction.fromJson(jsonDecode(body));

if (interaction.type == InteractionType.ping) {
    return Response.ok(jsonEncode(InteractionResponse.pong()));
}

响应 Application Commands

现在你可以响应应用程序命令了。

final api = DiscordApi(
  applicationId: Credentials.applicationId,
  userAgent: DiscordUserAgent(
    url: Credentials.userAgentUrl,
    versionNumber: '1.0.0',
  ),
  botToken: Credentials.botToken,
);

await api.interactions.createInteractionResponse(
    interaction.id,
    token: interaction.token,
    response:
        InteractionResponse.message(content: 'Hello, Discord Interactions!'),
);

创建命令

你可以通过运行 dart run script/create_commands.dart 来创建命令。

// script/create_commands.dart
import 'package:discord_interactions/discord_interactions.dart';
import '../lib/credentials.dart';

void main() async {
  final api = DiscordApi(
    applicationId: Credentials.applicationId,
    userAgent: DiscordUserAgent(
      url: Credentials.userAgentUrl,
      versionNumber: '1.0.0',
    ),
    botToken: Credentials.botToken,
  );

  await api.applications.commands.createGlobalCommand(
    Command(
      name: 'hello',
      description: 'Say hello!',
      options: [
        Option(
          type: OptionType.string,
          name: 'name',
          description: 'Your name',
          required: true,
        ),
      ],
    ),
  );
}

Additional Information

此包仍在开发中。如果你有任何建议或反馈，请在 GitHub 上提交问题。

更多关于如何本地测试 webhook bots 的信息可以参考 discord_interactions_test。

以上就是使用 discord_interactions 插件的基本指南，希望对你有所帮助！