An open API service indexing awesome lists of open source software.

https://github.com/z0rr0/gobot

VkTeams messenger goBot.
https://github.com/z0rr0/gobot

bot messenger vk

Last synced: 5 months ago
JSON representation

VkTeams messenger goBot.

Awesome Lists containing this project

README

          

# GoBot

![Go](https://github.com/z0rr0/gobot/workflows/Go/badge.svg)
![Version](https://img.shields.io/github/tag/z0rr0/gobot.svg)
![License](https://img.shields.io/github/license/z0rr0/gobot.svg)

[Vk Teams](https://biz.mail.ru/myteam/) messenger goBot.
Common API [docs](https://myteam.mail.ru/botapi/).

## Build

```shell
make build
```

### Run

Config example file is [config.example.toml](https://github.com/z0rr0/gobot/blob/main/config.example.toml).

Local:

```shell
./gobot -config
```

Docker [container](https://hub.docker.com/repository/docker/z0rr0/gobot) (data directory contains configuration and database files):

```shell
# ls data
# config.toml db.sqlite
docker run --detach \
--name gobot \
--user $UID:$UID \
--volume $PWD/data:/data/gobot \
--log-opt max-size=10m \
--restart always \
z0rr0/gobot:latest
```

### Commands

```
Бот для автомазитации работы командных чатов

/help - show this help
/stop - prevent bot from writing messages
/start - allow bot to write messages

/go - вернет участников чата в случайном порядке (алиас "/shuffle")
/version - покажет текущую версию бота
/link - добавит ссылку на звонок для чата (без параметров вернет текущую ссылку)
/reset - удалит ссылку на звонок для чата
/exclude - добавит пользователей из чата в список исключений (без параметров вернет список исключений)
/include - удалит указанных пользователей из списка исключений (без параметров работает как "/go")
/vacation - добавит пользователя, отправившего команду, в список исключений, а если он там уже есть, то удалит
/skip - добавить пользователя, отправившего команду, в список исключений до завтрашнего дня (повторный вызов сделает отмену)
/nodays - список дней недели через пробел (от 0 до 6, от воскресенья до субботы), когда автора не будет (без параметров сделает сброс)
```

## License

This source code is governed by a GPLv3 license that can be found
in the [LICENSE](https://github.com/z0rr0/gobot/blob/main/LICENSE) file.