Skip to content

Commit 0fbddfc

Browse files
committed
Add Docs
1 parent e81bab1 commit 0fbddfc

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

.env-example

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
API_ID=
2+
API_HASH=

README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
[<img src="https://img.shields.io/badge/Telegram-%40Me-orange">](https://t.me/hhhscvx)
2+
3+
## Functionality
4+
5+
| Functional | Supported |
6+
| ---------------------------------------------------------------------- | :-------: |
7+
| Multithreading ||
8+
| Binding a proxy to a session ||
9+
| Auto Task complete ||
10+
| Random sleep time between complete tasks ||
11+
12+
## [Change Settings](https://github.com/hhhscvx/GHArenaBot/blob/master/bot/config/config.py)
13+
14+
| Settings | Description |
15+
| --------------------- | ----------------------------------------------------------------------- |
16+
| **API_ID / API_HASH** | Platform data from which to launch a Telegram session (stock - Android) |
17+
18+
## Installation
19+
20+
You can download [**Repository**](https://github.com/hhhscvx/GHArenaBot) by cloning it to your system and installing the necessary dependencies:
21+
22+
```shell
23+
~ >>> git clone https://github.com/hhhscvx/GHArenaBot.git
24+
~ >>> cd GHArenaBot
25+
26+
#Linux
27+
~/GHArenaBot >>> python3 -m venv venv
28+
~/GHArenaBot >>> source venv/bin/activate
29+
~/GHArenaBot >>> pip3 install -r requirements.txt
30+
~/GHArenaBot >>> cp .env-example .env
31+
~/GHArenaBot >>> nano .env # Here you must specify your API_ID and API_HASH , the rest is taken by default
32+
~/GHArenaBot >>> python3 main.py
33+
34+
#Windows
35+
~/GHArenaBot >>> python -m venv venv
36+
~/GHArenaBot >>> venv\Scripts\activate
37+
~/GHArenaBot >>> pip install -r requirements.txt
38+
~/GHArenaBot >>> copy .env-example .env
39+
~/GHArenaBot >>> # Specify your API_ID and API_HASH, the rest is taken by default
40+
~/GHArenaBot >>> python main.py
41+
```
42+
43+
[You can change bot settings here](https://github.com/hhhscvx/GHArenaBot/blob/master/bot/config/config.py)
44+
45+
Also for quick launch you can use arguments, for example:
46+
```shell
47+
~/GHArenaBot >>> python3 main.py --action (1/2/3)
48+
# Or
49+
~/GHArenaBot >>> python3 main.py -a (1/2/3)
50+
51+
#1 - Create session
52+
#2 - Run clicker
53+
```

0 commit comments

Comments
 (0)