lpnf/modbot.py
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update 'README_RU.md'

Browse source
This commit is contained in:
lnkr 2022-04-18 05:02:09 +03:00
parent 80b5711737
commit 08e7dccb50
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README_RU.md
View file

@ -2,7 +2,7 @@
Питоновый бот для помощи с модерацией [Peertube Livechat](https://github.com/JohnXLivingston/peertube-plugin-livechat) Питоновый бот для помощи с модерацией [Peertube Livechat](https://github.com/JohnXLivingston/peertube-plugin-livechat)
В текущем виде предназначен для локального запуска. В текущем виде предназначен для локального запуска пользователем, желающим осуществлять модерацию. Один запущеный бот таргетит одну комнату чата.
## А что может? ## А что может?
- Мьютить(mute) юзера - Мьютить(mute) юзера
@ -20,12 +20,16 @@
- Списки запрещенных слов в сообщениях и никах. - Списки запрещенных слов в сообщениях и никах.
## Планы на будущее ## Планы на будущее
Скрипт на питоне - безусловно субоптимальное решение проблемы модерации. Хотелось бы развить это до бота, которого можно было бы держать как сервис на сервере, который автоматически заходил бы во все чаты и помогал поддерживать порядок, имел свои persistent-настройки на каждый чат, и, возможно, имел бы веб-интерфейс.
Проблема в том, что при таком масштабе **ГОРАЗДО** более вменяемым решением было бы уже написание своего плагина чата на Peertube, в котором всё было бы *как надо* с самого начала. На что лично у меня пока совершенно нет ни времени, ни сил, ни скилла, ни энтузиазма.
Посему бота не планируется развивать как-то капитально - правка багов, существующих и вызванных апдейтами, какой-то функциональный допил по мелочи, по заказу телезрителей, не более.
## Требования ## Требования
- Python 3 - Python 3
- Requests (python3 -m pip install requests) - Requests (`python3 -m pip install requests`)
Если вы на винде и у вас лапки, то питон [можно достать тут](https://www.python.org/downloads/), бота архивом [скачать здесь](https://inex.dev/lnkr/modbot.py/archive/master.zip), а в папке с ботом есть файл [start_modbot.bat](./modbot/start_modbot.bat), по даблклику на который установятся остальные зависимости и запустится бот. Если вы на винде и у вас лапки, то питон [можно достать тут](https://www.python.org/downloads/), бота архивом [скачать здесь](https://inex.dev/lnkr/modbot.py/archive/master.zip), а в папке с ботом есть файл [start_modbot.bat](./modbot/start_modbot.bat), по даблклику на который установятся остальные зависимости и запустится бот.
@ -59,7 +63,8 @@ python3 modbot.py
## Команды ## Команды
Вводить команды можно в чате стрима, если у вас есть права модератора в комнате, а так же в терминале с запущеным ботом. Вводить команды можно в чате стрима, если у вас есть права модератора в комнате, а так же в терминале с запущеным ботом. Ответ вернётся туда, где была введена команда.
**Внимание** - USERID в командах - не jid и не ник пользователя, это выданный ему ботом числовой порядковый номер. Подробнее об USERID - в описании команд и вывода в окне терминала. **Внимание** - USERID в командах - не jid и не ник пользователя, это выданный ему ботом числовой порядковый номер. Подробнее об USERID - в описании команд и вывода в окне терминала.
`!help` - вывод короткой справки по командам. `!help` - вывод короткой справки по командам.
@ -68,7 +73,7 @@ python3 modbot.py
Список пользователей выводится в следующем формате: Список пользователей выводится в следующем формате:
**USERID**) [name] (jid, role, affiliation) USERID) [name] (jid, role, affiliation)
Например: Например:
@ -129,4 +134,6 @@ python3 modbot.py
- `x1` - количество отправленных друг за другом сообщений пользователя - `x1` - количество отправленных друг за другом сообщений пользователя
- `Я веду общение` - Сообщение или его фрагмент - `Я веду общение` - Сообщение или его фрагмент
Глядя на такие логи, можно быстро прикинуть, что одному абоненту можно прописать `!ban 2` за оскорбления (что заодно вычистит его сообщения), а второму - `!timeout 3 30` просто так, чтоб не расслаблялся Глядя на такие логи, можно быстро прикинуть, что одному абоненту можно прописать `!ban 2` за оскорбления (что заодно вычистит его сообщения), а второму - `!timeout 3 30` просто так, чтоб не расслаблялся.
Удачных стримов!