Find a file
2023-05-01 13:54:32 +02:00
src Config logging from code instead of yaml 2023-05-01 13:54:27 +02:00
.build.yml Add clippy to dependencies 2022-11-21 00:56:06 -05:00
.env.example Simplify bot structure 2023-01-28 21:50:46 +01:00
.gitignore Add flake result folder to gitignore 2023-05-01 13:54:29 +02:00
Cargo.lock Update crate dependencies 2023-05-01 13:54:32 +02:00
Cargo.toml Implementing core functionnalities of the bot 2023-04-16 19:07:14 +02: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 Update crate dependencies 2023-05-01 13:54:32 +02:00
LICENSE Add AGPL license 2022-10-17 14:06:07 +00:00
README.md Complete README to be more precise 2023-04-16 22:01:19 +02:00

YorokoBot

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

The main instance of this bot was made specifically for the Archetype:Moon server and is not public. If you want to add the bot to your own server (or host a public version), you can run your own instance of Yorokobot as long as the license terms are respected.

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.

How Yorokobot permissions are managed ?

Yorokobot has no permission management system. Discord provides for each server a way to handle who can use a specific command and on which channel. Once the bot in on your server, you can do a right click on the bot user and select "Manage integration".

Is there a global banlist ?

No, at least for now.

Why is not the main bot instance public ?

I'm currently a student and this is just a project I did because it would be useful for the Archetype-Moon Discord server. However, it was important for me to make it available to everyone who wanted to use it as long as they are ready to run it themselves.