reactor

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 32)

telegram bot that automatically adds reaction buttons to messages (similar to slack/discord, but crappier, coz it's not native feature)

reactor Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# reactor

[![Build Status](https://travis-ci.org/vanyakosmos/reactor.svg?branch=master)](https://travis-ci.org/vanyakosmos/reactor)
[![Coverage](https://codecov.io/gh/vanyakosmos/reactor/branch/master/graph/badge.svg)](https://codecov.io/gh/vanyakosmos/reactor)

Telegram bot that automatically add reaction buttons to messages (similar to slack/discord, but crappier).

![demo](https://raw.githubusercontent.com/vanyakosmos/reactor/master/files/demo.gif)

## Features

- publish messages similar to [@like](https://t.me/like) but also allow to other users to add custom reactions
- repost chat messages on behalf of bot with added reaction buttons
- chat-wise settings:
  - list of predefined permanent buttons
  - types of messages to repost automatically
  - and more
- [magic marks](#magic-marks)

## Usage in groups

- add bot to the group
- give him admin rights (so it could delete messages)
- send message with media content -> bot will repost it with buttons
- reply to that message with "+button" to add new reaction
- use /help /settings /edit to monitor and control bot's behaviour

## Usage for channels

- go to private chat with bot
- type /create
- send message that you would like to "reactify"
- press "publish" -> pick channel -> pick message
- press "vote" to add new reaction -> user will be redirected to the private chat with bot -> send emoji/sticker to bot to add reaction

## Magic Marks

(group chats only)

Apply special action by adding prefix to message's text/caption.

```
# force bot to ignore message (if chat settings allow this type of message to be automatically reposted)
.-text
--text

# force bot to repost message (if bot was told to ignore this type of message)
.+text
++text

# force bot to repost message on his behalf
.++text
+++text
 
# hide credits (don't show who originally posted that message)
.~text

# show "👍 👎" buttons instead of default ones in that chat
.``text
.`👍 👎`text

# combine marks
.+~`👍 👎`text
```

Some magic marks also work with replies (if you are the original poster of that message)

```
# toggle credits
.~

# change buttons
.``
.`👍 👎`
```

## Deployment

### "Prod"

- Create `.envs/.production` dir and copy content of `.envs/.examples`
- Specify telegram bot token in `app.env`
- Run: `docker-compose -f docker-compose.yml up`

### Dev

- 1-2 from prod steps
- Create `.envs/.local` dir and copy content of `.envs/.examples`
- Adjust evn vars for local development
- Create `docker-compose.override.yml` and copy into it content of `docker-compose.override.example.yml`
- Run: `docker-compose up`
- Run migrations (in prod they run automatically after server start, but in dev it might be useful not to run migrations while you are still experimenting with them): 
    - `docker-compose exec bot python manage.py migrate`
- Misc:
    - `make start` - run bot
    - `make restart_bot` - restart bot container w/o waiting for threads to exit

## [TODOs](https://github.com/vanyakosmos/reactor/projects/1)

- [x] add basic bot functionality: messages reposting, reply reactions, chat default buttons
- [x] add reactions to albums without reposting each photo (simple reply with buttons)
- [x] show credits of original message: who posted, from whom forwarded
- [x] allow to change bot settings only to chat's admins
- [x] add more chat settings: 
  - [x] number of buttons in row
  - [x] types of messages to be reposted
  - [x] buttons padding
  - [x] hide/show credits
  - [x] reply to the original message instead of reposting it
  - [x] allow to disable reactions
  - [x] add emoji enforcing
  - [ ] max number of buttons to show
- [x] add forced processing/anonymity/ignore/custom buttons via magic marks (text/caption prefixes)
- [x] reactions for channels via inline interface
- [x] add setting for inline posting
- [ ] gather and store chat statistics
- [ ] add web UI for chat administration and statistics

reactor

reactor Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

reactor

reactor Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README