Skip to content

Latest commit

 

History

History
107 lines (74 loc) · 4.64 KB

README.md

File metadata and controls

107 lines (74 loc) · 4.64 KB

Version Github Last commit

CheckStudents

Installation

To add this bot to your Discord Server : Click here

Please accept all permissions, or the bot will not respond on your server. Please refer to this issue.

Note : You need the corresponding privileges to add the bot on a server.

Read CHANGELOG here.

How it works ?

For make a call, a teacher (or any other user with an authorized role): call @class.

By default, if you did not change bot prefix, the command will be .Check call @class. Please refer to prefix page for more information.

startcall

Emojis will appear below your message, the students belonging to the @class role would be able to click on the ✅ to notify their presence. The teacher, or anyone with privileges, can end the call by clicking 🆗 or cancel with 🛑.

cantnotify

Note : Users can only notify their presence if they are part of the group (External students will not be counted) Also, someone who does not have privileges cannot close the call.

noright

Once the call is finished, the bot will return the list of present and missing students and send the list to the teacher in private message.

finishcall

The teacher who started the call will get a copy of the call in private message:

CallSumarry

Every absent student will get an absence notification in private message, like this:

absence

Add/Remove Admin privileges to a role

Only a user with privileges can add/remove roles.

  • Add : add @role1 @role2,...
  • Remove : remove @role1 @role2,...

Note: You can add / remove as many roles as you want at the same time.

Note that the admin rights will not be checked if no admin has been registered beforehand.

To see the list of admins, use command list or roles (same command)

Other commands

Change bot prefix

If you want to change bot prefix, use command prefix followed by the new prefix. Default prefix is ".Check "

You must be an admin in order to execute this command

Translation

You can also use the bot in different languages (French, English and German only for the moment) The language is applied to the whole server. If you want to add another language, please check the json prototype and pull-request your translation!

You must be an admin in order to execute this command

Command : language fr|en|de

Activate/Deactivate bot system messages

If you have a system messages on your server and wants the bot to send a message when someone has changed bot settings, you can activate this functionality. This functionality is activated by default.

You must be an admin in order to execute this command

Command : sys or sysMessages

Activate/Deactivate bot private messages

When a student is marked absent, he will receive This functionality is activated by default.

You must be an admin in order to execute this command

Command : DeactivateMP

Reset the bot

Reset command will reset admin list, put default prefix (.Check), activate bot private and system messages, and set language to english.

You must be an admin, or the server owner in order to execute this command

Command : reset

Get current settings

Return language, and private and system messages status values.

Command : settings

Common Errors

The bot doesn't respond to any command

If the bot doesn't respond to any command, it might be because you did not accept all permissions. In that case, remove the bot from the server, and invite him again.

Any other issue

Please read CHANGELOG or create an issue.

Data privacy

The bot communicates with the server every time you use it. We only keep IDs guilds, roles with privileges, and just during a call, guilds usernames and their users IDs.

We also analyse every discord reaction on every servers to see if it corresponds to a call message.

This repository use Discord.py library from Rapptz
Icons made by Freepik from Flaticon