Find a file

Victor Mignot 6df9437531 Add log4rs config and fix main to use exit codes		2022-10-21 19:59:52 -04:00
.github/workflows	Remove useless flags for clippy on pipeline	2022-10-17 14:07:20 -04:00
src	Add log4rs config and fix main to use exit codes	2022-10-21 19:59:52 -04:00
.env.example	Add MONGODB_URI to needed environment variable	2022-10-18 23:21:59 -04:00
.gitignore	Add logs folder to gitignore	2022-10-21 19:58:06 -04:00
Cargo.lock	Add log4rs and log crates to dependencies	2022-10-21 19:59:01 -04:00
Cargo.toml	Add log4rs and log crates to dependencies	2022-10-21 19:59:01 -04:00
compose.yaml	Provide Docker Compose for running a local Mongo database	2022-10-18 23:21:16 -04:00
flake.lock	Init flake	2022-09-21 23:10:56 -04:00
flake.nix	Add .env file handling for secrets	2022-10-17 00:12:54 -04:00
LICENSE	Add AGPL license	2022-10-17 14:06:07 +00:00
log4rs_config.yaml	Add log4rs config and fix main to use exit codes	2022-10-21 19:59:52 -04:00
README.md	Init README	2022-09-21 22:47:51 -04:00

README.md

YorokoBot

This bot is a remake of the original HokuBot using Rust with Serenity and the Nix package manager.

It is made for the Archetype:Moon Discord server exclusively and won't work elsewhere.

What is YorokoBot ?

YorokoBot is a Discord bot allowing users to subscribe to tags. Tags represent someone's center of interest. If something related to this topic is post on Discord, the sender can use the bot to ping each users that subscribed to this topic.

Why using YorokoBot when Discord roles exist ?

To keep it simple, to prevent a Discord server to create a ton of roles. Moreover, the goal is to keep it simple for Moderators with simple commands.

Can everyone can add new tags ?

No, only server's admins can create new tags for their own server.

Is everyone able to ping a tag (and possibly spam with it) ?

Well, this is something that is server dependant. By default, only Discord admins will be able to ping a tag. But they can change this behaviour with a simple command that will allow each server member to ping someone.

What if I want to block someone to use the bot on my server specifically ?

Each server will have a ban list at its disposition. Server admins will be able to block someone for using the bot on their server.

Is there a global banlist ?

No, at least for now. But it could be a future feature.

Why is it designed to handle multiple servers ?

Because as a student, I can't afford a big infrastructure. This bot will first be limited to a single server. I will see to make it available for everyone later.