yorokobot/README.md

# 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](https://archetype-moon.fr/)
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.