A simple Discord logging bot.
Go to file
2024-01-18 23:22:31 +01:00
.sqlx feat: dockerize p4bl0t 2024-01-18 02:50:40 +01:00
assets initial commit 2023-11-23 00:59:55 +01:00
migrations feat: add listing logger channels in a guild 2023-11-23 22:15:47 +01:00
src chore: update bot framework 2024-01-18 20:47:37 +01:00
.dockerignore feat: dockerize p4bl0t 2024-01-18 02:50:40 +01:00
.env.example feat: dockerize p4bl0t 2024-01-18 02:50:40 +01:00
.gitignore feat: dockerize p4bl0t 2024-01-18 02:50:40 +01:00
build.rs feat: dockerize p4bl0t 2024-01-18 02:50:40 +01:00
Cargo.lock chore: bump to 1.0.1 2024-01-18 23:22:31 +01:00
Cargo.toml chore: bump to 1.0.1 2024-01-18 23:22:31 +01:00
docker-compose.example.yml feat: dockerize p4bl0t 2024-01-18 02:50:40 +01:00
Dockerfile feat: dockerize p4bl0t 2024-01-18 02:50:40 +01:00
LICENSE.md initial commit 2023-11-23 00:59:55 +01:00
README.md feat: dockerize p4bl0t 2024-01-18 02:50:40 +01:00

p4bl0t

p4bl0t is a simple logging bot for Discord written in Rust.

Usage

Preparation

In order to run p4bl0t, you will need a Discord token with which your bot will authenticate. Head over to your developer portal on Discords website, and create a bot there. You will be able to get the bots token there.

Docker

The easiest way to run p4bl0t is using Docker. Copy docker-compose.example.yml to docker-compose.yml and modify the DISCORD_TOKEN variable.

Then, you can simply run

docker compose up # or docker-compose on some machines

Building and running it yourself

Copy the .env.example file to a .env file and fill in the details.

cp .env.example .env
emacs .env
# or
vim .env
# or
nano .env
# or
code .env
# or whichever text editor you prefer

Install the sqlx CLI if you dont have it already.

cargo install sqlx-cli

Setup your SQLite database.

sqlx database create
sqlx migrate run

You can then run the project using cargo run

cargo run
# or
cargo run --release # if you dont want debug symbols

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

AGPL-3.0 or later