Skip to content

Commit

Permalink
📄 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@shamhi
shamhi committed Sep 19, 2024
1 parent 3f4cf8d commit b7800a8
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 25 deletions.
43 changes: 22 additions & 21 deletions README-EN.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
[<img src="https://img.shields.io/badge/Telegram-%40Me-orange">](https://t.me/sho6ot)
[<img src="https://img.shields.io/badge/python-3.10%20%7C%203.11-blue">](https://www.python.org/downloads/)

> 🇷🇺 README на русском доступен [здесь](README.md)
![demo](.github/images/demo.png)


> 🇷🇺 README на русском доступен [здесь](README.md)

## ⚙ [Settings](.env-example)
<details>
<summary><b>API_ID / API_HASH</b> - Platform Data</summary>
Expand All @@ -24,7 +22,7 @@
<summary><b>MIN_AVAILABLE_ENERGY</b> - Minimum Energy Level</summary>
<p>This setting determines the minimum energy level at which the bot will go idle to simulate human-like activity.</p>
<ul>
<li><strong>Example:</strong> <code>200</code></li>
<li><strong>Example:</strong> <code>535</code></li>
<li><strong>Default:</strong> <code>200</code></li>
</ul>
</details>
Expand All @@ -33,7 +31,7 @@
<summary><b>SLEEP_BY_MIN_ENERGY</b> - Delay at Minimum Energy</summary>
<p>Sets a pause in the bot's operation if the energy drops below the set minimum. This simulates human-like activity.</p>
<ul>
<li><strong>Example:</strong> <code>[1800,3600]</code></li>
<li><strong>Example:</strong> <code>[2000,3300]</code></li>
<li><strong>Default:</strong> <code>[1800,3600]</code></li>
</ul>
</details>
Expand All @@ -51,7 +49,7 @@
<summary><b>MAX_LEVEL</b> - Maximum Upgrade Level</summary>
<p>Determines the maximum level up to which the bot will upgrade your cards.</p>
<ul>
<li><strong>Example:</strong> <code>20</code></li>
<li><strong>Example:</strong> <code>15</code></li>
<li><strong>Default:</strong> <code>20</code></li>
</ul>
</details>
Expand All @@ -60,7 +58,7 @@
<summary><b>MIN_PROFIT</b> - Minimum Upgrade Profit</summary>
<p>Determines the minimum profit of the card that the bot will upgrade.</p>
<ul>
<li><strong>Example:</strong> <code>1000</code></li>
<li><strong>Example:</strong> <code>2500</code></li>
<li><strong>Default:</strong> <code>1000</code></li>
</ul>
</details>
Expand All @@ -69,7 +67,7 @@
<summary><b>MAX_PRICE</b> - Maximum Upgrade Price</summary>
<p>Sets the limit on the amount the bot can spend on a single card upgrade.</p>
<ul>
<li><strong>Example:</strong> <code>50000000</code></li>
<li><strong>Example:</strong> <code>20000000</code></li>
<li><strong>Default:</strong> <code>50000000</code></li>
</ul>
</details>
Expand All @@ -78,7 +76,7 @@
<summary><b>BALANCE_TO_SAVE</b> - Balance Limit</summary>
<p>This parameter defines the minimum balance that the bot will guarantee to keep, without spending it on upgrades or purchases.</p>
<ul>
<li><strong>Example:</strong> <code>1000000</code></li>
<li><strong>Example:</strong> <code>2000</code></li>
<li><strong>Default:</strong> <code>1000000</code></li>
</ul>
</details>
Expand All @@ -87,7 +85,7 @@
<summary><b>UPGRADES_COUNT</b> - Number of Upgrades per Cycle</summary>
<p>Specifies how many cards the bot will upgrade in one cycle to always choose the most profitable card.</p>
<ul>
<li><strong>Example:</strong> <code>10</code></li>
<li><strong>Example:</strong> <code>5</code></li>
<li><strong>Default:</strong> <code>10</code></li>
</ul>
</details>
Expand All @@ -96,7 +94,7 @@
<summary><b>MAX_COMBO_PRICE</b> - Maximum Combo Card Purchase Price</summary>
<p>Defines the maximum amount the bot can spend on purchasing combo cards when the balance is sufficient.</p>
<ul>
<li><strong>Example:</strong> <code>10000000</code></li>
<li><strong>Example:</strong> <code>15000000</code></li>
<li><strong>Default:</strong> <code>10000000</code></li>
</ul>
</details>
Expand Down Expand Up @@ -159,7 +157,7 @@
<summary><b>SLEEP_MINI_GAME_TILES</b> - Delay in the mini game TILES</summary>
<p>Option to set a random delay from the start of the game to its end.</p>
<ul>
<li><strong>Example:</strong> <code>[600,900]</code></li>
<li><strong>Example:</strong> <code>[500,800]</code></li>
<li><strong>Default:</strong> <code>[600,900]</code></li>
</ul>
</details>
Expand All @@ -168,7 +166,7 @@
<summary><b>SCORE_MINI_GAME_TILES</b> - Maximum score for the game TILES</summary>
<p>Sets the random score that will be reached in the game.</p>
<ul>
<li><strong>Example:</strong> <code>[300,500]</code></li>
<li><strong>Example:</strong> <code>[250,600]</code></li>
<li><strong>Default:</strong> <code>[300,500]</code></li>
</ul>
</details>
Expand All @@ -177,7 +175,7 @@
<summary><b>GAMES_COUNT</b> - Number of games in TILES</summary>
<p>Defines the random number of games that the bot will play in one cycle.</p>
<ul>
<li><strong>Example:</strong> <code>[1,10]</code></li>
<li><strong>Example:</strong> <code>[3,15]</code></li>
<li><strong>Default:</strong> <code>[1,10]</code></li>
</ul>
</details>
Expand All @@ -204,7 +202,7 @@
<summary><b>RANDOM_TAPS_COUNT</b> - Random Taps Count</summary>
<p>This parameter defines the range of random tap (click) counts the bot may use at once.</p>
<ul>
<li><strong>Example:</strong> <code>[10,50]</code></li>
<li><strong>Example:</strong> <code>[25,100]</code></li>
<li><strong>Default:</strong> <code>[10,50]</code></li>
</ul>
</details>
Expand All @@ -213,7 +211,7 @@
<summary><b>SLEEP_BETWEEN_TAP</b> - Delay Between Taps</summary>
<p>Sets the interval time between taps (clicks). This prevents too frequent tapping.</p>
<ul>
<li><strong>Example:</strong> <code>[10,25]</code></li>
<li><strong>Example:</strong> <code>[5,15]</code></li>
<li><strong>Default:</strong> <code>[10,25]</code></li>
</ul>
</details>
Expand All @@ -231,7 +229,7 @@
<summary><b>RANDOM_DELAY_IN_RUN</b> - Random Delay at Startup</summary>
<p>Defines the range of random delay applied to each account before starting the bot. This helps to start each account separately rather than simultaneously.</p>
<ul>
<li><strong>Example:</strong> <code>[0,15]</code></li>
<li><strong>Example:</strong> <code>[0,20]</code></li>
<li><strong>Default:</strong> <code>[0,15]</code></li>
</ul>
</details>
Expand Down Expand Up @@ -264,9 +262,10 @@ For each session, you can create a profile with unique data:
}
}
```
> ❕ Note: session1 and session2 are example session names.
> If headers or fingerprint are empty, [default](bot/utils/default.py) data will be used.
> Field `tonAddress` connects TON wallet to game, if there is no connected address.
> [!NOTE]
> `session1` and `session2` are example session names.
> If `headers` or `fingerprint` are empty, [default](bot/utils/default.py) values will be used.
> Field `tonAddress` connects TON wallet to game, if there is no connected.

## ⚡ Quick Start
Expand All @@ -286,7 +285,7 @@ Before you start, make sure you have the following installed:


## 🧱 Installation
You can download the [**Repository**](https://github.com/shamhi/HamsterKombatBot) by cloning it to your system and installing the required dependencies:
You can clone the [**Repository**](https://github.com/shamhi/HamsterKombatBot) to your system and installing the required dependencies:
```shell
~ >>> git clone https://github.com/shamhi/HamsterKombatBot.git
~ >>> cd HamsterKombatBot
Expand All @@ -307,6 +306,8 @@ You can download the [**Repository**](https://github.com/shamhi/HamsterKombatBot
~/HamsterKombatBot >>> # Open the .env file and enter your API_ID and API_HASH
~/HamsterKombatBot >>> python main.py
```

> [!TIP]
> To install as a Linux service for background operation of the bot, see [here](docs/LINUX-SERVIS-INSTALL.md).

Expand Down
7 changes: 3 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
![demo image](.github/images/demo.png)


## ⚙ [Настройки](.env-example)
<details>
<summary><b>API_ID / API_HASH</b> - Данные платформы</summary>
Expand Down Expand Up @@ -261,12 +262,10 @@
}
}
```


> [!NOTE]
> `session1` и `session2` - это примеры названий сессий.
> Если `headers` или `fingerprint` пусты, то возьмутся [дефолтные](bot/utils/default.py) данные.
> Поле `tonAddress` подключает TON кошелек к игре, если нет подключенного адреса.
> Если `headers` или `fingerprint` пусты, то возьмутся [дефолтные](bot/utils/default.py) значения.
> Поле `tonAddress` подключает TON кошелек к игре, если нет подключенного.

## ⚡ Быстрый старт
Expand Down

0 comments on commit b7800a8

Please sign in to comment.