This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
Telegram/README.md

46 lines
1.6 KiB
Markdown
Raw Normal View History

<h1 align="center">HoloCheckerBot</h1>
2022-10-16 21:35:09 +03:00
<p align="center">Small Telegram bot made on Pyrogram</p>
<p align="center">
2023-05-02 11:58:41 +03:00
<a href="https://git.end-play.xyz/HoloUA/Telegram/src/branch/master/LICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/License-GPL-blue"></a>
<a href="https://git.end-play.xyz/HoloUA/Telegram"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>
2022-10-23 13:13:12 +03:00
2022-10-23 17:22:25 +03:00
## What can this bot do?
* Get user applications
* Send applications to the admins
* Give one-time links to join group
* Track down users that were not allowed to join
* Show applications to other users
2022-12-13 11:44:44 +02:00
* Manage YouTube sponsorships [WIP]
* Send and receive messages to users using bot [WIP]
2022-10-23 17:22:25 +03:00
2022-10-23 13:13:12 +03:00
## Installation
2023-05-02 11:58:41 +03:00
1. `git clone https://git.end-play.xyz/HoloUA/Telegram.git`
2022-10-23 13:13:12 +03:00
2. `cd HoloCheckerBot`
3. Install Python 3.7+ (at least 3.9 is recommended) for your OS
4. `python3 -m pip install -r requirements.txt`
5. Run it with `python3 main.py` after configuring
## Configuration
So bot has its "config_example.json" and it needs to be changed.
Copy this file to "config.json" and open it with any text editor.
2023-04-18 17:07:51 +03:00
You should also install [HoloCheckerAPI](https://git.end-play.xyz/profitroll/HoloCheckerAPI) for inline requests to work.
2022-10-23 13:13:12 +03:00
After all of that you're good to go! Happy using :)
2022-10-24 14:29:23 +03:00
## To-Do
2023-01-03 16:47:44 +02:00
* [ ] Stats and infographics
* [ ] Check group members without completed application
2023-01-04 22:56:54 +02:00
* [x] Replicate some functions of @spoilerobot
2023-01-02 12:17:17 +02:00
* [x] Check sponsorship on Holo girls
* [x] /nearby command
2022-12-21 13:26:50 +02:00
* [x] Complete messenger between user and admins
2023-01-03 22:36:26 +02:00
* [x] Get application by id and user_id