Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1git2clone/serenity-discord-bot
A discord bot built on top of the serenity-rs & poise-rs Rust frameworks using tokio.
https://github.com/1git2clone/serenity-discord-bot
discord-bot gitlab-ci poise-rs rust rust-discord serenity-rs sqlite sqlite3 sqlx tokio-rs
Last synced: 28 days ago
JSON representation
A discord bot built on top of the serenity-rs & poise-rs Rust frameworks using tokio.
- Host: GitHub
- URL: https://github.com/1git2clone/serenity-discord-bot
- Owner: 1Git2Clone
- License: apache-2.0
- Created: 2024-05-30T12:22:22.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-12T11:39:22.000Z (about 1 month ago)
- Last Synced: 2025-01-12T12:28:49.712Z (about 1 month ago)
- Topics: discord-bot, gitlab-ci, poise-rs, rust, rust-discord, serenity-rs, sqlite, sqlite3, sqlx, tokio-rs
- Language: Rust
- Homepage:
- Size: 501 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serenity Discord Bot
[![GH_Build Icon]][GH_Build Status] [![Build Icon]][Build Status] [![License Icon]][LICENSE]
[GH_Build Icon]: https://img.shields.io/github/actions/workflow/status/1git2clone/serenity-discord-bot/rust.yml?branch=main
[GH_Build Status]: https://github.com/1git2clone/serenity-discord-bot/actions?query=branch%3Amaster
[Build Icon]: https://gitlab.com/1k2s/serenity-discord-bot/badges/main/pipeline.svg
[Build Status]: https://gitlab.com/1k2s/serenity-discord-bot/-/pipelines
[License Icon]: https://img.shields.io/badge/license-Apache2.0-blue.svg
[License]: LICENSE
## Features overview
This is a list of some of the Bots available features. For a more comprehensive
list you can always check out the code with all the commands or use the `help`
command.
- A help command containing all the bot commands.
- A bunch of embed interaction commands (like pats, hugs and etc.)
- A levelling system (managed locally). Some people like it, others hate it and
say its a MEE6 clone (They kinda have a point there). Nevertheless, you can
always use the SQLite database for something else if you need to. There's also
a cooldown implementation and periodic cleaning up of the users which aren't
under cooldown (This was a bit tricky to do because of the Mutex locking and my
overall skill issue).
- The leveling system has a nice topranks command which gives a cool-looking embed!
- A bot uptime command.
## Setting up
**ALL THE RELATIVE PATHS IN THIS DESCRIPTION BASED ON THE ROOT OF THE REPOSITORY!**
In order to set up your bot token you can do it manually by creating and
modifying the .env file and adding the token in it like this:
```env
BOT_TOKEN=YOUR_DISCORD_BOT_TOKEN_HERE
```
Alternatively, there's also a script that does the exact same thing! To compile
and run it, enter in the following commands:
For Linux;
```sh
rustc extra_utils/generate_dotenv.rs -o bin/generate_dotenv
./bin/generate_dotenv
```
For Windows (Just change `/` to `\`);
```sh
rustc extra_utils\generate_dotenv.rs -o bin\generate_dotenv
.\bin\generate_dotenv
```
After you've configured your dotenv (.env) files, you can just run
```sh
cargo install sqlx-cli
sqlx database setup
sqlx migrate run
cargo sqlx prepare
cargo run --release
```
The database setting up is a ONE TIME ONLY thing. From your second run after
you just need to do:
```sh
cargo run --release
```
### Advanced setting up (Containerization)
I've also provided a Dockerfile in this repo for anyone who wants to build a
docker image and run the project like that.
Prerequisites:
- Docker engine [docker.com](https://docs.docker.com/engine/install/)
After you have the Docker engine you need to run these commands in your
terminal (Linux):
```sh
docker volume create --name database
docker build -t YOUR_DOCKER_IMAGE_NAME .
docker run -v database:/database -d --env-file .env YOUR_DOCKER_IMAGE_NAME
```
NOTE: The image building could take some time (this is compiling Rust code
after all) so be patient!
Checking your docker images is as simple as:
```sh
docker images
```
There's also a `docker-compose.yml` configuration if you wish to build the image by using Docker Compose.
```sh
docker-compose up -d
```
You need to install Docker Compose from [docker.com/compose/install](https://docs.docker.com/compose/install/) though.
For Windows installs removing the `sudo` prefix and using the PowerShell as an
administrator should work (according to Google Gemini). If you encounter
problems with setting it up on Windows or want to tell me more details on
setting it up on there then feel free to chat to me on Discord - `1kill2steal`
## Additional info
If you want to change your database location, make sure you also change the
.env file.
```env
# This line determines where the database is based on the root directory of the repository.
DATABASE_URL=sqlite:database/botdatabase.sqlite
```
NOTE: The database URL configuration is hard-coded in the
`extra_utils/generate_dotenv.rs` file.