A Discord bot designed to integrate with Norppalive services, involving real-time data streams via Kafka and interactions through the Discord API.
- Discord Integration: Connects to Discord, listens to commands, and interacts with users/channels. (Powered by
poiseandserenity) - Kafka Consumer: Processes messages from Kafka topics. (Powered by
rdkafka) - Actor-based Concurrency: Utilizes the Actix framework for managing concurrent tasks and state.
- Configuration Management: Loads configuration from
.envfiles. (Powered bydotenvy) - Asynchronous Operations: Built with
tokiofor efficient asynchronous I/O. - Structured Logging: Uses
tracingfor application logging. - Error Handling: Employs
thiserrorandmiettefor robust error management.
The project is organized as follows:
src/main.rs: Main application entry point, initializes the bot, Kafka client, and actors.src/models.rs: Defines data structures and models used throughout the application.src/error.rs: Contains custom error types and error handling utilities.src/actors/: Houses the Actix actors responsible for various parts of the business logic.Cargo.toml: Rust package manifest, defines dependencies and project metadata.Dockerfile: Defines the Docker image for building and running the application.
graph TD
subgraph ExternalServices
DiscordAPI[Discord API]
KafkaBroker[Kafka Broker]
end
subgraph ApplicationCore
MainLogic["main.rs (Orchestration, Setup)"]
Config["dotenvy (Configuration)"]
Models["models.rs (Data Structures)"]
ErrorHandling["error.rs (Error Types)"]
end
subgraph Actors
DiscordActor["actors/discord.rs (Discord Logic)"]
KafkaActor["actors/kafka.rs (Kafka Logic)"]
ActorsMod["actors/mod.rs (Actor Module)"]
end
DiscordAPI --> DiscordActor;
KafkaBroker --> KafkaActor;
MainLogic --> DiscordActor;
MainLogic --> KafkaActor;
MainLogic --> ActorsMod;
Config --> MainLogic;
DiscordActor --> Models;
KafkaActor --> Models;
ErrorHandling -.-> MainLogic;
ErrorHandling -.-> DiscordActor;
ErrorHandling -.-> KafkaActor;
class DiscordAPI,KafkaBroker external;
class MainLogic,Config,Models,ErrorHandling appcore;
class DiscordActor,KafkaActor,ActorsMod actors;
- Rust (latest stable version recommended, see
rust-toolchain.tomlif present, orDockerfilefor version used in build) - Cargo (Rust's package manager)
- Access to a Kafka instance (if running services that depend on it)
- A Discord Bot Token
-
Clone the repository (if you haven't already):
git clone https://github.com/dilaz/norppalive-discord cd norppalive-discord -
Build the project:
cargo build --release
The compiled binary will be located in
target/release/norppalive-discord.
The application uses a .env file for configuration. Create a .env file in the root of the project with the necessary environment variables. Refer to the source code or required configurations for specific variables needed (e.g., DISCORD_TOKEN, KAFKA_BROKERS).
Example .env file:
DISCORD_TOKEN="your_discord_bot_token"
KAFKA_BROKERS="localhost:9092"
# Add other necessary configuration variablesOnce built and configured, you can run the application using:
./target/release/norppalive-discordAlternatively, if you have Docker, you can build and run the application using the provided Dockerfile:
-
Build the Docker image:
docker build -t norppalive-discord:latest . -
Run the Docker container:
docker run -d --env-file .env --name norppalive-bot norppalive-discord
(Ensure your
.envfile is correctly populated and accessible)
MIT