Skip to content

Latest commit

 

History

History
128 lines (99 loc) · 4.04 KB

README.md

File metadata and controls

128 lines (99 loc) · 4.04 KB

Bevy Discord Plugin

GitHub License Crates.io Version CI

Note

The main branch is ahead working for 0.6 release

A very simple, bevy plugin that let you send and receive messages through bevy events.

Installation

Add bevy-discord as your dependency:

$ cargo add bevy-discord --features full

Quick Start

// examples/basic_bot.rs
use bevy::prelude::*;
use bevy_discord::bot::{DiscordBotConfig, DiscordBotPlugin};
use bevy_discord::events::bot::BMessage;
use bevy_discord::serenity::all::*;
use serde_json::json;

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(DiscordBotPlugin::new(config))
        .add_systems(Update, handle_messages)
        .run();
}

fn handle_messages(
    mut messages: EventReader<BMessage>,
    http: Res<bevy_discord::http::DiscordHttpResource>,
) {
    for message in messages.read() {
        // Skip messages from bots (including our own)
        if message.new_message.author.bot {
            continue;
        }

        let content = &message.new_message.content;
        let channel_id = message.new_message.channel_id;

        // Simple ping-pong command
        if content == "!ping" {
            let http = http.client();

            bevy_discord::runtime::tokio_runtime().spawn(async move {
                let _ = http
                    .send_message(
                        channel_id,
                        vec![],
                        &json!({
                            "content": "Pong! 🏓"
                        }),
                    )
                    .await;
            });
        }
    }
}

Example taken from examples/basic_bot.rs

Examples

The examples/ directory contains several example implementations:

To run an example:

$ cargo run --example basic_bot

Note: Remember to replace YOUR_BOT_TOKEN with your actual Discord bot token.

Features

This crate using powerful cargo features.

Feature Information
bot (includes http) Discord bot integration for Bevy applications.
http HTTP Client functionality for Discord API interactions.
rich_presence Discord Rich Presence Integration with Bevy. (v0.6)

All features are comes under full feature.

Limitations

Currently, the following Discord/Serenity features are not supported:

Feature Module
voice bot

Versions

This crate aims to track bevy's versions. It also follows the semver standard. Below is a chart which versions of this crate are compatible with which bevy version:

Version Bevy Version
0.2.x 0.13.x
0.3.x 0.13.x
0.4.x 0.14.x
0.5.x 0.15.x
0.6.x 0.?.x