https://github.com/exposedcat/ethereal-y
Multifunctional Telegram assistant
https://github.com/exposedcat/ethereal-y
Last synced: 2 months ago
JSON representation
Multifunctional Telegram assistant
- Host: GitHub
- URL: https://github.com/exposedcat/ethereal-y
- Owner: ExposedCat
- Created: 2021-12-01T20:30:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-09T16:17:26.000Z (over 2 years ago)
- Last Synced: 2025-01-18T14:34:15.457Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://ethereal-y.vercel.app
- Size: 7.38 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ethereal Y
[](https://github.com/ExposedCat)
[](https://t.me/ethereal-y)
[](https://t.me/ExposedCatDev)
## ⭐️ Features
`[expression]` - Replace with specified expression without square brackets.
`{Reply}` - Requires reply message.
`{Photo}` - Command must be specified as photo caption (photo must be non-compressed).
### Roleplay
Sends roleplay message with specified action.
```
/do [action]
```
### RegExp Replacement
Sends message with specified replacements.
```
/re [flags1]/[expression1]/[replacement1]
...
[flagsN]/[expressionN]/[replacementN]
```
`flags` can be omitted.
### Reminders
Sends specified note at specified date and time with tagging all subsribers.
```
/reminder [date] [time] [note]
/reminder 31.01 12:34 Note
/reminder today 12:34 Note
/reminder tomorrow 12:34 Note
```
### Broadcast
`{Reply}` `{Full rights}`
Sends specified message to all groups to which this bot was added.
```
/broadcast
```
### Vote for restriction
`{Reply}`
Creates poll to mute (Read-Only mode) or kick chat member. Restriction is applied after positive votes of 30% of group members.
```
/voteban
/votemute
```
### Send anonymous message
Sends given text message and deletes sender.
```
/anon [text]
```
### Recurring reminders
Sends specified note every time by specified [time rule](https://crontab.guru) with tagging all subsribers.
```
/cron [time rule] [note]
/cron 30 */1 * * * Note
```
### Triggers
Sends specified message when specified keyword is sent (or deletes trigger).
#### Add
`{Reply}`
`-r` use regular expression as trigger
`-s` makes trigger case-sensitive. Removes `i` flag if `-r` is specified
```
/bind [keyword]
/bind -s [keyword]
/bind -r [keyword]
/bind -r -s [keyword]
```
#### Add trigger to delete
`{Reply}`
`-r` use regular expression as trigger
`-s` makes trigger case-sensitive. Removes `i` flag if `-r` is specified
```
/bind_delete [keyword]
/bind_delete -s [keyword]
```
#### Remove
```
/unbind [keyword]
```
#### Show group triggers
```
/bindings
```
### Restrictions
Restricts specified user.
#### Read-only mode (mute)
`{Reply}` `{Admin rights}`
```
/mute
/mute [time in minutes]
```
#### Remove all restrictions
`{Reply}` `{Admin rights}`
```
/unmute
```
#### Kick user (ban)
`{Reply}` `{Admin rights}`
```
/ban
```
### Add UA flag frame to images
Generates rounded image with ukrainian flag background and frame.
`{Photo}`
```
/ua_frame
```
## 🏗️ Forking
```
git clone https://github.com/ExposedCat/ethereal-y.git
cd ethereal-y
rm -r .git
npm install
```
Copy `.env.example` to `.env`, set `TOKEN`, then run bot with `npm start`
## 🐋 Containers
```
cp .env.example .env
# edit TOKEN in .env
docker compose up --build -d
```
Stop:
```
docker compose down
```