Struct DiscordBotPlugin 

pub struct DiscordBotPlugin(/* private fields */);

Available on crate feature bot only.

A plugin that integrates Discord bot functionality into a Bevy application.

Functionality

This plugin handles:

• Discord client initialization and lifecycle management
• Event system integration between Discord and Bevy
• Bot presence and status management
• Gateway connection and communication

Usage

use bevy::prelude::*;
use bevy_discord::bot::{DiscordBotPlugin, DiscordBotConfig};
use bevy_discord::serenity::all::{GatewayIntents, ActivityData, ActivityType};

// Configure your bot
let config = DiscordBotConfig::default()
    .token("your-bot-token".to_string())
    .gateway_intents(GatewayIntents::non_privileged())
    .activity(ActivityData::playing("with Bevy!"));

App::new()
    .add_plugins(DiscordBotPlugin::new(config))
    .run();

Features

• Automatically makes available DiscordHttpResource
• Registers all Discord events as Bevy events
• Manages bot configuration and presence
• Provides asynchronous event handling

Note

This plugin requires a valid Discord bot token and appropriate gateway intents to function correctly. Make sure to configure the necessary intents based on your bot’s requirements.

Implementations

impl DiscordBotPlugin

pub fn new(configuration: DiscordBotConfig) -> Self

Creates a new instance of DiscordBotPlugin with the specified configuration.

Arguments

• configuration - Bot configuration including token, intents, and presence settings

Examples found in repository

examples/slash_commands.rs (line 22)

fn main() {
    let config = DiscordBotConfig::default()
        .token("YOUR_BOT_TOKEN_HERE".to_string())
        .gateway_intents(GatewayIntents::GUILDS);

    App::new()
        .add_plugins(MinimalPlugins)
        .add_plugins(DiscordBotPlugin::new(config))
        .add_systems(Update, (handle_ready, handle_interactions))
        .run();
}

examples/reactions.rs (line 23)

fn main() {
    let config = DiscordBotConfig::default()
        .token("YOUR_BOT_TOKEN_HERE".to_string())
        .gateway_intents(
            GatewayIntents::GUILD_MESSAGES
                | GatewayIntents::MESSAGE_CONTENT
                | GatewayIntents::GUILDS
                | GatewayIntents::GUILD_MESSAGE_REACTIONS,
        );

    App::new()
        .add_plugins(MinimalPlugins)
        .add_plugins(DiscordBotPlugin::new(config))
        .add_systems(Update, (handle_discord_messages, handle_discord_reactions))
        .run();
}

examples/basic_bot.rs (line 28)

fn main() {
    // Configure the bot with necessary intents
    let config = DiscordBotConfig::default()
        .token("YOUR_BOT_TOKEN_HERE".to_string())
        .gateway_intents(
            GatewayIntents::GUILD_MESSAGES
                | GatewayIntents::MESSAGE_CONTENT
                | GatewayIntents::GUILDS,
        );

    App::new()
        .add_plugins(MinimalPlugins)
        .add_plugins(bevy::log::LogPlugin {
            ..Default::default()
        })
        .add_plugins(DiscordBotPlugin::new(config))
        .add_systems(Update, handle_discord_message)
        .run();
}

Trait Implementations

impl Clone for DiscordBotPlugin

fn clone(&self) -> DiscordBotPlugin

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DiscordBotPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Plugin for DiscordBotPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.