anti-premium-stickers-bot

TypeScript bot for auto-deleting of Telegram premium stickers with some interesting features based on the grammY library

This bot was created as an additional tool to fight against premium Telegram stickers, the animations of which make any device shudder

Features

• Removes premium stickers
• Handy white/ignore lists configuration from DM
• Locale configuration via commands
• and more... (maybe)

Setup

Local

1. Create a new bot and get a bot token

2. Install redis-cli and node.js

3. Clone this repository

4. Create a .env file in the root of the folder and pass variables into it:

   • BOT_KEY - bot token
   • CREATOR_ID - your ID for working with the bot whitelist/ignored list from the DM

5. Open and edit in bot.ts call for createClient from:

   const client: RedisClientType = createClient({
       url: `redis://${redisUser}:${redisPass}@${redisURL}:${redisPort}`,
   });

   to

   const client: RedisClientType = createClient();

   This function call will use your local Redis DB

6. Run npm i and npm run local

7. Wait for Starting bot log message

8. Bot is ready to go!

If you want to pass environment variables on your system, all you need to do is run npm start in step 6

Heroku

1. Create a new bot and get a bot token
2. Create a new Redis database and get: Username, Password, Host and Port

   How to create a Redis database, create a user and get the necessary data to connect will not be written here

3. Create a new pipeline in Heroku, the application in it and set neccessary config vars in the settings:
   • BOT_KEY - bot token
   • CREATOR_ID - your ID for working with the bot whitelist/ignored list from the DM
   • REDIS_USER - name of Redis DB user
   • REDIS_PASS - password of Redis DB user
   • REDIS_URL - endpoint of Redis DB
   • REDIS_PORT - port of Redis DB endpoint
4. Push sources on Heroku (or set up auto-deployment) and wait for build
5. Wait for Starting bot log message
6. Bot is ready to go!

Note about Heroku

Go to step 3 in Heroku Docker Docs to convert the stack into a container.

If something doesn't work, check the application logs in Heroku or locally and try googling the problem. If nothing helps, open an Issue with a detailed description of the problem

Bot commands

Group commands:

• silent - manage bot silent mode
• help - send help message
• silentonlocale - change message when silent mode is enabled
• silentonlocalereset - reset message when silent mode is enabled
• silentofflocale - change message when silent mode is disabled
• silentofflocalereset - reset message when silent mode is disabled
• messagelocale - change message when bot removes stickers
• messagelocalereset - reset message when bot removes stickers

DM commands:

• addwhitelist - add group ID to white list
• removewhitelist - remove group ID from white list
• getwhitelist - get all groups info from white list
• addignorelist - add group ID to ignore list
• removeignorelist - remove group ID from ignore list
• getignorelist - get all groups ID from ignore list

Bot locale configuration

The entire locale is now stored in the locale.ts file. Some words can be changed for chats using the commands above with locale substring in it.

Remember to change creatorLink in locale.ts, which allows users to contact you for whitelist access

Changelog

The project now has a separate file CHANGELOG.md. Check it for details

FAQ

Q: How white/ignore lists are working?

When the bot is added to an unknown group, you will be prompted to add the group to the whitelist, decline the offer to add, or add it to the ignore list. The ignore list is used to prevent the bot from sending you information about future additions to the group that you have set to the ignore list. In the case of a simple rejection, the bot will not work in the new chat until you add it to the whitelist

Q: Why were these lists added in the first place?

During the tests, it became clear that with limited resources (small database memory, low system configuration, etc.), the best solution was to limit the number of chats, for less load on the infrastructure of the bot. If you want, whitelist can be cut out of the code, perhaps later will be created a separate branch for this, but not for sure

License

This repository is licensed under MIT License