Rust Discord Bot

Description

This project is a Discord bot written in Rust, using the Serenity framework. It's designed to interact with users in a Discord server, managing user XP based on message activity, and handling role assignments based on XP levels.

Features

• XP Tracking: Automatically tracks and updates user XP when they send messages.
• Role Management: Assigns roles to users based on their XP level.
• Commands: Responds to specific commands such as !ping,!top, !help and more.

Installation

Prerequisites

• Rust Programming Language: Install Rust
• SQLx CLI: Used for handling database migrations.
• MySQL Database: The bot uses a MySQL/MariaDB to store user data.

Setup

1. Clone the Repository

   git clone https://github.com/gmifflen/rust-discord-bot.git
   cd rust-discord-bot

2. Install Crates

   cargo add serenity tokio rand sqlx dotenv regex chrono tracing tracing-subscriber

3. Environment Variables Create a .env file in the root directory with the following content:

   DISCORD_TOKEN=your_discord_bot_token
   DATABASE_URL=mysql://username:password@localhost/discord_bot
   XYZ_ROLE_ID=123456789
   XYZ_ROLE_ID=123456789
   XYZ_ROLE_ID=123456789
   XYZ_ROLE_ID=123456789
   XYZ_ROLE_ID=123456789
   XYZ_ROLE_ID=123456789
   XYZ_ROLE_ID=123456789
   

4. Database Setup Ensure your MySQL database is running and use SQLx CLI to set up the database schema.

    CREATE TABLE `user_xp` (
      `user_id` bigint unsigned NOT NULL,
      `xp` int unsigned DEFAULT NULL,
      `level` int unsigned DEFAULT NULL,
      PRIMARY KEY (`user_id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

    cargo sqlx prepare

5. Build the Project

   cargo build

Usage

To run the bot:

cargo run

or

cargo run --release

The bot will start on any server it has been added to Discord server. It will begin listening for messages and commands.

TODO

• Add function that pings a role if a game is updated on IOS or Andriod

Contributing

I'm not the best at Rust, this is my third public Rust project. Any suggestions on improvements or ways to write it in a better/safer way is much appreciated.

License

GPL-2.0