Update 'README_RU.md'

This commit is contained in:
lnkr 2022-04-18 04:44:32 +03:00
parent 761a8a5125
commit 6ad43fb223
1 changed files with 62 additions and 12 deletions

View File

@ -55,23 +55,73 @@ python3 modbot.py
## Команды
Вводить команды можно в чате стрима, если у вас есть права модератора в комнате, а так же в терминале с запущеным ботом.
**Внимание** - USERID в командах - не jid и не ник пользователя, это выданный ему ботом числовой порядковый номер. Подробнее - дальше.
**Внимание** - USERID в командах - не jid и не ник пользователя, это выданный ему ботом числовой порядковый номер. Подробнее об USERID - в описании команд и вывода в окне терминала.
`!help` - вывод короткой справки по командам.
`!users` - вывести список пользователей
`!users` - вывести список пользователей.
Список пользователей выводится в следующем формате:
Список пользователей выводится в следующем формате:
**USERID**) [**name**] (**jid**, **role**, **affiliation**)
**USERID**) [name] (jid, role, affiliation)
Например:
Например:
`13) [lnkr] (lnkr@xxivproduction.video, moderator, owner)`
13) [lnkr] (lnkr@xxivproduction.video, moderator, owner)
Здесь:
- USERID: 13
- Ник: lnkr
- jid: lnkr@xxivproduction.video
- роль: moderator
- принадлежность: owner
Здесь:
- USERID: 13
- Ник: lnkr
- jid: lnkr@xxivproduction.video
- роль: moderator
- принадлежность: owner
`!usersall` - вывести список всех замеченных пользователей, включая ушедших.
`!mute USERID` - замьютить юзера по его USERID
`!unmute USERID` - размьютить юзера
`!timeout USERID X` - замьютить юзера на X секунд
`!wipe USERID` - удалить сообщения юзера
`!ban USERID` - забанить юзера и удалить его сообщения
`!ratelimits M W S` - переписать рейтлимиты: разрешить одному пользователю до M сообщений за W секунд, иначе замьютить его на S секунд
### Команды переключения режимов "осады"
`!mode 0` - снять со всех мьют
`!mode 1` - автоматически мьютить незарегистрированных пользователей, которые зашли после этой команды
`!mode 2` - замьютить всех существующих и будущих незарегистрированных пользователей
`!mode 3` - мьютить всех, кроме модераторов (также известна как `!shutup`)
## Что выводится в консоли и где ещё мне быстро брать USERID?
Отличный вопрос! Рассмотрим демонстрационное содержимое окна консоли с ботом:
```
[04:32:47] (2|Собеседник|sobjisnvbudwdt1c@anon.xxivproduction.video|x1) Я веду общение
[04:32:55] (2|Собеседник|sobjisnvbudwdt1c@anon.xxivproduction.video|x2) Продолжаю вести общение, проверяй.
[04:33:30] (3|Собутыльник|xwvlahsevyq-73x-@anon.xxivproduction.video|x1) И я!
[04:33:32] (3|Собутыльник|xwvlahsevyq-73x-@anon.xxivproduction.video|x2) Я тоже веду общение!
[04:33:43] (2|Собеседник|sobjisnvbudwdt1c@anon.xxivproduction.video|x1) Мудак ты, Петя, а не общение ведёшь!
```
В окне с ботом выводится чат: информация о пользователе, и фрагмент его сообщения, в формате
`[ВРЕМЯ] (USERID|USERNAME|JID|xCMN) ТЕКСТ`
Присмотримся повнимательнее, что тут где:
`[04:32:47] (2|Собеседник|sobjisnvbudwdt1c@anon.xxivproduction.video|x1) Я веду общение`
- `[04:32:47]` - время
- `2` - USERID
- `Собеседник` - никнейм
- `sobjisnvbudwdt1c@anon.xxivproduction.video` - jid
- `x1` - количество отправленных друг за другом сообщений пользователя
- `Я веду общение` - Сообщение или его фрагмент
Глядя на такие логи, можно быстро прикинуть, что одному абоненту можно прописать `!ban 2` за оскорбления (что заодно вычистит его сообщения), а второму - `!timeout 3 30` просто так, чтоб не расслаблялся