Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
add info to `/update` command docs (force rename or not)
  • Loading branch information
LucasPlacentino committed Apr 17, 2024
1 parent edc8307 commit 97cb6b9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This is a small discord bot written in python using the [disnake library](https://github.com/DisnakeDev/disnake) to make a registration system for ULB discord servers.

The bot checks that a user is a ULB student by verifying their ULB email adress using a one-time generated token sent to their email adress. It then gives them the role and adds their Discord user ID and ULB email adress to a database. The user will is then automatically verified on every server that the bot is running. The bot also has a rename functionality (optional, per server), names are extracted from the email adress.
**_[Version 1]_**: The bot checks that a user is a ULB student by verifying their ULB email adress using a one-time generated token sent to their email adress. It then gives them the role and adds their Discord user ID and ULB email adress to a database. The user will is then automatically verified on every server that the bot is running. The bot also has a rename functionality (optional, per server), names are extracted from the email adress.

# ➕ Add the bot to your server

Expand Down Expand Up @@ -196,11 +196,11 @@ To see the bot logs when running with docker in detached mode (`-d`), use the [d

* `/setup`

(Admin permission needed) When adding the bot to a new server, you need to set the @ULB role with the command `/setup`. This command also allows you to choose if you want to force the registered member to get renamed with their real name or not (yes by default).
**[Admin permission needed]** When adding the bot to a new server, you need to set the @ULB role with the command `/setup`. This command also allows you to choose if you want to force the registered member to get renamed with their real name or not (yes by default).

* `/info`

(Admin permission needed) Get current server information (@ULB role, if rename is enabled, and checks for permission conflicts).
**[Admin permission needed]** Get current server information (@ULB role, if rename is enabled, and checks for permission conflicts).

* `/ulb`

Expand Down Expand Up @@ -238,7 +238,7 @@ Get statistics about the bot usage (number of configured servers, number of regi

* `/update`

This forces a total update of the database and of all the servers. Since the bot already does this automatically at startup and after each reconnection, the only normal usecase for this would be if you manually add an entry (server or user) to the google sheet instead of using the `/user add` command above, we don't recommend manually editing the google sheet.
This forces a total update of the database and of all the servers. Since the bot already does this automatically at startup and after each reconnection, the only normal usecase for this would be if you manually add an entry (server or user) to the google sheet instead of using the `/user add` command above, we don't recommend manually editing the google sheet. It also includes an option (`/update Non`) to not rename users (on servers where it is enabled) when running this command (default: do **not** force rename on force update).

## 👤 Author

Expand Down

0 comments on commit 97cb6b9

Please sign in to comment.