Skip to content

Commit e8d3cad

Browse files
committed
Readme
1 parent 77a086c commit e8d3cad

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

readme.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,16 @@
33
[![Dwarven Realms](https://img.shields.io/badge/Dwarven%20Realms%20Version-5.3.2.0-purple)]()
44
[![Windows](https://img.shields.io/badge/Platform-Windows-blue)]()
55

6-
A Windows overlay tool that automatically uses potions when your HP drops below a configurable threshold. Features a PyQt5 overlay, hotkey controls, and direct memory reading for reliable automation.
6+
A game tool for Dwarven Realms that automatically uses potions when HP drops below a configurable threshold. Attaches to the game process via pymem and reads player health data from memory using iterative pointer dereferencing with pointer chain resolution. Memory reading runs in a separate background thread with thread-safe operation. Features a PyQt5 overlay window with transparency and always-on-top behavior, and is also thread-safe for responsiveness.
77

8-
**️Warning**: This tool is intended for **offline use only**. While it may work online, use it at your own risk and discretion.
8+
**️ Warning**: This tool is intended for **offline use only**. While it may work online, use it at your own risk and discretion.
99

1010

1111

1212
**A few important notes:**
1313

1414
* While it's not a guarantee of survival, it will save you most of the time. It works with any class or build, just make sure you always have enough potions!
15-
* Because of how the game handles health and damage over time (DoT), if you take a lot of DoT or very fast hits, your HP can drop below the threshold very quickly, multiple times or stay below the threshold even with potion drinks.
16-
* The potion will trigger as soon as your real HP drops below the threshold, but if the accumulated or incoming damage is higher than what a potion can heal, you might still die.
15+
* Because of how the game handles health and damage over time (DoT), if you take a lot of DoT or very fast hits, your HP can drop below the threshold very quickly, multiple times or stay below the threshold even with potion drinks. The potion will trigger as soon as your real HP drops below the threshold, but if the accumulated or incoming damage is higher than what a potion can heal, you might still die.
1716

1817

1918
## ✨ Features
@@ -26,7 +25,7 @@ A Windows overlay tool that automatically uses potions when your HP drops below
2625
* **Auto Potion**: Automatically triggers a potion when HP falls below a set percentage.
2726
* **Potion log**: The overlay displays a log of recent potion uses, showing HP values and timestamps for each use.
2827
* **Overlay UI**: Movable, lockable PyQt5 overlay showing status, HP, and logs.
29-
* **Customizable Hotkeys**: Easily change hotkeys for toggling, hiding, and closing the overlay.
28+
* **Customizable Hotkeys**: Easily change hotkeys for toggling ON/OFF, locking, and closing the overlay.
3029
* **Safe & Configurable**: All settings in a user-friendly config file.
3130

3231
## 🛠️ Setup Instructions
@@ -49,9 +48,9 @@ cd AutoPot-DR
4948
```bash
5049
pip install -r requirements.txt
5150
```
52-
Now either run it natively via python or build the executable.
51+
Now either run it with python or build the executable.
5352

54-
### Run Natively with Python
53+
### Run with Python
5554

5655
* Run the application:
5756
```bash
@@ -64,7 +63,7 @@ python src/main.py
6463
```bash
6564
./build_release.sh
6665
```
67-
* The executable will be in the `release/` folder.
66+
* The executable will be in the `release` folder.
6867

6968
## ⚙️ Configuration
7069

0 commit comments

Comments
 (0)