Davte/bic_bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Instructions

Browse Source
This commit is contained in:
Davte 2021-06-20 01:01:34 +02:00
parent 3dea282f59
commit 2663f44339
Signed by: Davte
GPG Key ID: 209AE674A0007425
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -12,19 +12,25 @@ Breaking Italy Club bot
``` ```
* Add the bot to the BIC chat as administrator * Add the bot to the BIC chat as administrator
* Write `/set_chat` in the chat * Write `/set_chat` in the chat
* Send a csv file to the bot named "patrons.csv" with patreons emails * Send the bot a csv file named "patrons.csv" with patrons' emails
``` ```
person@example.com, person@example.com,
someone@gmail.com, someone@gmail.com,
[...] [...]
``` ```
The csv file must be sent periodically.
* [NOT YET IMPLEMENTED] Using Patreon's API, the patrons list will be automatically downloaded from the server * [NOT YET IMPLEMENTED] Using Patreon's API, the patrons list will be automatically downloaded from the server
* [NOT YET IMPLEMENTED] Users will be able to link their email to their Telegram account automatically. A confirmation email will help to verify the association * Users can link their email to their Telegram account automatically. A confirmation email will help to verify the association. When their email gets whitelisted, users are sent an invite link.
## Functioning ## Functioning
* Whenever a person joins the chat, the bot will check whether their Telegram account is linked to an email listed in the patrons list. If not, the user will be kicked out. * Whenever a person joins the chat, the bot will check whether their Telegram account is linked to an email listed in the patrons list. If not, the user will be kicked out.
* Whenever an email is removed from the white list, the linked Telegram account will be kicked out. * Whenever an email is removed from the white list, the linked Telegram account will be kicked out.
* [NOT YET IMPLEMENTED] Any user can automatically link their email to their Telegram account. If their email is white-listed, they can join the chat. * Any user can automatically link their email to their Telegram account. If their email is white-listed, they can join the chat.
## User manual
* Start the bot and write `/email your_email@example.com`
* Click the verification link in the mail (also check the SPAM folder!)
* Wait for the invitation link. It will be available as soon as your patron status is verified by the staff
## Credits ## Credits
This [davtelepot-based](https://gogs.davte.it/davte/davtelepot) bot has been developed by [@Davte](https://www.davte.it). This [davtelepot-based](https://gogs.davte.it/davte/davtelepot) bot has been developed by [@Davte](https://www.davte.it).