Telegram Bot Tagging

Roadmap

• About
• Logo
• Acknowledgments
• Tech
• Demo
• Installation
• Run locally
• Documentation
• Additional information

About

"Telegram Bot Tagging" is a Telegram bot server designed to mention or tag users in a group.

Logo

Acknowledgements

• Logo maker
• Library tgbot-cpp
• Library BS::thread_pool
• Library SQLiteCpp
• Library OpenSSL

Tech Stack

• C++(v17)
• Telegram Bot API(v6.4)
• vcpkg(v2023.07.21-1)
• tgbot-cpp(Boost, OpenSSL, libcurl, v1.6)
• OpenSSL(v3.1.2)
• SQLiteCpp(SQLite, sqlite3, v3.3.0)
• BS::thread_pool(v3.5.0)
• python(pyinstaller, pywin32, winshell, v3.11.3)
• cmake(v3.22.1)
• SQLite(3.42.0)
• compiler Visual Studio(v17 2022)
• builder MSBuild(v17 2022)
• compiler gcc(c, c++, v13.2.1)
• builder Unix Makefiles(v4.4.1)
• operating systems(Windows, Linux)

Demo

• Initial launch of the program(request a token and save it):

1.mp4

• Rejection of initial requests from users:

2.mp4

• Interaction with the bot in a private chat:

3.mp4

• Сommand start:

4.mp4

• Сommand help:

5.mp4

• Сommand sign:

6.mp4

• Command tag:

7.mp4

• Command settings:

8.mp4

• Log file data:

9.mp4

• Database display:

10.mp4

Installation

To install the project yourself, you must follow the following instructions:

1. Clone the current project or download the rar or zip file via GitHub:

  git: git clone https://github.com/cppVolodya/TelegramBotTagging.git

  WinRar: cod->Download ZIP(don't forget to unzip)

2. Go to the project directory:

  telegram_bot_tagging/

3. Builder Telegram Bot Tagging - Follow the link to first download the required project dependencies and build it

4. Then, after building the project, you can run the program and follow the next instructions(setting up the Telegram bot) of the program.

Regarding the second point, namely the setting of the Telegram bot, you can refer to the additional information, which is at the very bottom.

Run Locally

In order not to build the project, you can use ready-made binary (executable) files, for this you need to follow the following steps:

1. Clone the current project or download the rar or zip file via GitHub:

  git: git clone https://github.com/cppVolodya/TelegramBotTagging.git

  WinRar: cod->Download ZIP(don't forget to unzip)

2. Go to the program directory:

  telegram_bot_tagging/program/windows

3. Select the application architecture:

  telegram_bot_tagging/program/windows/x32
                      or
  telegram_bot_tagging/program/windows/x64

4. Run the program or the shortcut.

  telegram_bot_tagging.exe
                      or
  Telegram Bot Tagging[x32, x64].lnk

5. Then, after launching the program, you must follow the further instructions (Telegram bot setup) of the program.

Regarding the creation and configuration of the Telegram bot,
you can refer to the additional information, which is located at the very bottom.

You can copy the shortcut "Telegram Bot Tagging[x32, x64].lnk" to the desktop.

Documentation

Information about the function of each Telegram bot command:

• /start - this command allows you to get general information about the bot. You will receive information such as: firstname, username, about, description, group privacy, commands(as well as a brief description of each command) and description picture.

• /help - This command provides you with detailed help and instructions for using the bot. You will learn about all the available commands and their purpose in a broad description.

• /settings - with this command you can select the users you want to tag. A list of selected users to tag or mention will be provided and a panel will open where you can select users by clicking on buttons, clicking on a specific user will automatically add or remove it from the list. A "Default" button will also be available, which will perform the function of resetting the default settings, that is, all registered users will be selected for tagging.

• /sign - This command allows you to log into the bot. With the help of this command, you can be tagged or mentioned in the group.

• /tag [text] - This command allows you to tag all selected users with or without text. Just type /tag and then optionally type the text you want to include in the message to be tagged.

Additional information

To simplify the creation and configuration of your Telegram bot, you can use this information:

• firstname: TagBot(voluntarily)
• username: tag_cpp_bot(voluntarily)
• about: This bot is designed to mention or tag users in a group.
• description: This Telegram bot provides a simple and effective feature to mention or tag users in a group. It will further increase organization and simplify communication, allowing you to quickly address selected groups of participants.
• description picture: згенероване зображення + слоган "@ + Easy tagging"
• botpic: згенероване зображення
• commands:
  • start - Get general information about the bot.
  • help - Get help and instructions for using the bot.
  • settings - Select users to be tagged.
  • sign - Sign in to the bot.
  • tag - Tag all selected users with or without text: /tag [text].