dala/yorokobot
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Complete README to be more precise

Browse source
This commit is contained in:
Victor Mignot 2023-04-16 21:55:47 +02:00
parent 14be0e93b4
commit 7c7d25df2a
No known key found for this signature in database
GPG key ID: FFE4EF056FB5E0D0
1 changed files with 12 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,10 +1,12 @@
# YorokoBot
This bot is a remake of the original HokuBot
using Rust with Serenity and the Nix package manager.
using Rust with the Serenity crate and the Nix package manager.
It is made for the [Archetype:Moon](https://archetype-moon.fr/) Discord server
exclusively and won't work elsewhere.
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 ?
@ -16,31 +18,18 @@ 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 ?
## How Yorokobot permissions are managed ?
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 ban someone to use the bot on their server.
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.
But it could be a future feature.
## Why is it designed to handle multiple servers ?
## Why is not the main bot instance public ?
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.
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.