Update README.md, Design.txt and some comments here and there

This commit is contained in:
eleksir
2023-11-24 02:29:56 +03:00
parent 9a9516e80d
commit c803682b8b
6 changed files with 34 additions and 28 deletions

View File

@@ -1,9 +1,17 @@
# Buny Jabber Bot
Простой бот, работающий по протоколу xmpp. Его задача - банить абьюзеров чата.
Этот бот автоматизирует уборку человеческой грязи. Самый важный вопрос, который следует себе задать перед его
использованием - а не забаню ли я кого-то лишнего?
<table style="border-collapse: collapse; border: none;">
<tr style="border: none;">
<td rowspan=2 style="border: none;"><img src="assets/avatar.png" alt="Бани"></td>
<td style="border: none;">Простой бот, работающий по протоколу xmpp. Его задача - банить абьюзеров чата. При его
создании не стояло задачи сделать что-то красивое в архитектурном или каком-то другм плане.</td>
</tr>
<tr style="border: none;">
<td style="border: none;">Этот бот автоматизирует уборку человеческой грязи. Самый важный вопрос, который следует себе
задать перед его использованием - а не забаню ли я кого-то лишнего?
</td>
</tr>
</table>
## Что он может?
@@ -11,12 +19,12 @@
работает по классическим механикам (шифрованный канал связи, без возможности коммуникации в незашифрованном виде),
без поддержки механизма start tls. (Что-то в гошке или на стороне сервера при выборе StartTLS не работает.)
* Имеет возможность заносить пользователей в бан-лист, согласно заданным в чёрном списке правилам:
- по совпадению с регулярными выражениями в nick-е или jid-е злодея
- по регулярным выражениям характерных фраз.
- По совпадению с регулярными выражениями в nick-е или jid-е злодея
- По регулярным выражениям характерных фраз.
- Правила можно настроить как глобально, для всех комнат, где присутствует бот, так и для каждой комнаты отдельно.
- При изменении списка правил бота не надо перезапускать, достаточно отдать ему команду rehash либо в приват, либо
прям в чатике.
* Есть настройка заходить в разные комнаты под разными никами
* Есть настройка заходить в разные комнаты под разными никами.
## Что он не может?
@@ -48,7 +56,7 @@ make
Почему нельзя оставить комнату анонимной? А тут всё просто, в банлист заносится реальный jid пользователя, а не его ник.
Соответственно, бот должен видеть этот самый реальный jid. В анонимной комнате бот не сможет увидеть реальный jid.
А автокик - это конечно хорошо, но есть нюанс: можно, например, гадить ником, поэтому бот в автокик не умеет.
А автокик - это, конечно, хорошо, но есть нюанс: можно, например, гадить ником, поэтому бот в автокик не умеет.
## Как работает бан?