0
Files
meow-irc-bot/README.md
2022-11-01 01:02:53 +03:00

39 lines
2.4 KiB
Markdown

# Meow-IRC-bot - Простой ассистивный IRC бот
## About
Бот основан Perl модуле [AnyEvent::IRC][1].
Конфиг должен находиться в **data/config.json**, пример конфига расположен в **data/sample_config.json**.
Бота можно запустить через команду **bin/meow-irc-bot**.
Этого бота можно считать экспериментальным из-за отсутсвия всестороннего тестирования. Он сделан по принципу "works for
me". Он проверялся на работоспособность на MacOS "Big Sur" и Slackware Linux 15.0.
## Installation
Чтобы запустить бота, надо вначале его забутстрапить - загрузить и установить все нужные перловые модули.
Для MacOS нам понадобится xcode console tools. (Их предлагают установить при установке VS Code, например).
Для Linux нам понадобится "Development Tools" или похожий набор пакетов и дополнительно perl, perl-devel,
perl-local-lib, perl-app-cpanm, sqlite-devel, zlib-devel, openssl-devel, libdb4-devel (Berkeley DB devel), make.
После установки указанных пакетов, можно смело запускать:
```sh
bash bootstrap.sh
```
и всё необходимое будет скачано из интернетов, протестировано и установлено в локальный каталог vendor_perl.
Для воспроизведения desktop notifications на MacOS используется afplay для звукового оповещения и osascript для
визуального, это стандартные средства MacOS.
Для воспроизведения desktop notifications под Linux используется mpg123, mpg321, madplay, mp3blaster, что первое
найдётся по этому списку, чтобы воспроизвеcти звук уведомления и send-notify для отсылки команды в нотификатор для
отображения уведомления на рабочем столе.
[1]: https://metacpan.org/pod/AnyEvent::IRC