New release v0.6.1 (#332)

* Bump version to v0.6.1

* adjust version

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,6 +7,9 @@ assignees: ''
 
 ---
 
+**Is it really a Bug report?**
+If you have questions regarding setup or feature information/requests, please consider asking in the Discord channel: https://discord.gg/Jf3J8cuXWg. The Github issues section is for bug reports only.
+
 **Botty Version**
 What version of botty are you running? Are you using a pre-compiled release? Which one. Are you using the latest master branch? On which commit?
 

.gitignore

@@ -14,9 +14,11 @@ run.onefile-build/
 generated/
 botty_v*/
 custom.ini
+config/custom.ini
 *info_*.png
 .vscode
 .vs/
 info_screenshots/
 loot_screenshots/
-.venv
+stats/
+.venv

README.md

@@ -1,45 +1,43 @@
 # <img src="assets/docs/header_green.png" width="370">
 
-Simple Pixelbot for Diablo 2 Resurrected single player written in python and opencv. Botty does not work for online games and is not intended for this usage!
-[**Download here**](https://github.com/aeon0/botty/releases). Got to have a [**Discord**](https://discord.gg/Jf3J8cuXWg) nowadays I guess :man_shrugging:
+Pixelbot for Diablo 2 Resurrected. This project is for informational and educational purposes only. Feel free to dig around, add stuff, make PRs, or ask questions should you get stuck!
 
+[**Download here**](https://github.com/aeon0/botty/releases) and got to have a [**Discord**](https://discord.gg/Jf3J8cuXWg) nowadays I guess :man_shrugging:
 
-And please. I urge you to actually read that README! It will make your life a lot easier.
-
-[![Watch the video](assets/docs/video_thumbnail.png)](https://streamable.com/67h9ay)
-
-## Getting started
-Botty only supports English language! Botty is currently working in 720p and will either switch to windowed mode or to fullscreen depending on your current monitor res when you run the "Auto Settings".</br>
-It is highly recommended to let botty run with /nopickup active. This will reduce the amount of accidently picked up trash by a lot. Espacially when playing builds without teleport.
+## Getting started & Prequists
+- D2r needs to be in English Language,
+- Botty currently works with 720p D2r window (will be adjusted automatically on auto settings)
 
 ### 1) Graphics and Gameplay Settings
-All settings will automatically be set when you execute `run.exe` and press the hotkey for "Adjust D2R settings" (default f9). Note that D2R should not run during this process, or if it does you will have to restart afterwards. It is not a 100% thing, in rare cases you might still have to fiddle around with your brightness. I suggest using the "Graphic Debugger" to verify your settings.
-**Note**: There have been issues reported with image sharpening being truned on via the graphic card settings itself outside of D2R. Try turning it off when running botty. Also HDR should be truned off.
+
+All settings will automatically be set when you execute `main.exe` and press the hotkey for "Adjust D2R settings" (default f9). It is not a 100% thing, in rare cases you might still have to fiddle around with your brightness. I suggest using the "Graphic Debugger" to verify your settings.
+**Note**: Make sure that no other external programs adapt your graphics settings (HDR, Geforce Experience, etc.)
 
 ### 2) Supported builds
 
-#### Soceress
-You can put any skills on left and right attack and see if it works out. E.g. Glacial Spike on left attack and Blizzard or right attack.
-Adjust the hotkeys in the __custom.ini__ or __param.ini__ for the `[char]` and `[sorceress]` section accordingly. Check out the param.ini section in the Readme for more details on each param.
-#### Hammerdin
-Your standard Hammerdin with Enigma. Dont think I have to explain much here. Same story as with sorc, set up your skills in the .ini file to what you have in D2R or the other way around. When running more than just pindle or shenk you need to start with a full tome of tps in your inventory.
+Check the documentation for **param.ini** further down. Different Sorc builds, Hammardin, Barb, Trapsin are already implemented to different extents. It is quite straightforward to implement new classes. Give it a go if you like!
 
 ### 3) Start Location
-Open up D2R and wait till you are at the hero selection screen. Make sure the char you running with is selected and will be in A5 in the respective difficulty you set in the __param.ini__ once the bot starts the game.
+
+Open up D2R and wait till you are at the hero selection screen. Make sure the char you running with is selected and will be in any of Act 3, 4 or 5 in the respective difficulty you set in the **param.ini** once the bot starts the game.
 
 ### 4) Start Botty
-Download the a prebuilt release [here](https://github.com/aeon0/botty/releases). Start `run.exe` in the botty folder. Switch (ALT+TAB) to your D2R window and press the start key (default f11). You can always force stop botty with f12.
 
+You can either run from python. Follow [development.md](development.md) for that. Or you download the a prebuilt release [here](https://github.com/aeon0/botty/releases) (the .rar file!). Start `main.exe` in the botty folder. Focus your D2R window and press the start key (default f11). You can always force stop botty with f12.
 
 ## Graphic Debugger
-To check if you graphic settings are good and if the bot would pick up items there is a **Graphic Debugger Mode** built in. Start botty and press F10 (Default key). This will open up a (mostly black) window. Start a game in D2R and go to A5. You should see some templates with blue circles detected and scores printed out to the console. E.g. for 720p you should see scores higher 0.8 for the templates. To check item finding, throw some items of different types on the ground. The debug window should show the item names with black background. If you throw an item on the ground that should be picked up, it will have a red circle. The console will print out the scores for each item that would be picked up. Scores should be well above 0.9 for these items.</br>
+
+To check if you graphic settings are good and if the bot would pick up items there is a **Graphic Debugger Mode**. Start botty and press F10 (Default key). This will open up a (mostly black) window. Start a game in D2R and go to A5. You should see some templates with blue circles detected and scores printed out to the console. To check item finding, throw some items of different types on the ground. The debug window should show the item names with black background. If you throw an item on the ground that should be picked up, it will have a red circle. The console will print out the scores for each item that would be picked up. Scores should be well above 0.9 for these items.</br>
 <img src="assets/docs/graphic_debugger.png" width="900">
 
 ## Development
+
 Check out the [development.md](development.md) docu for infos on how to build from source and details of the project structure and code.
 
 ## param.ini
-To ease the switch to new botty versions, you can also overwrite any of the param.ini fields in a __custom.ini__ file. When a new version of botty is released you just copy the file to the new version without having to port all your __param.ini__ changes to the new version. Example:
+
+All botty configuration files are located in the __config__ folder. To ease the switch to new botty versions, you can also overwrite any of the .ini fields in a **custom.ini** file. When a new version of botty is released you just copy the file to the new version without having to port all your **param.ini** changes to the new version. Example:
+
 ```ini
 ; custom.ini - overwrites 3 params in the param.ini
 [general]
@@ -50,85 +48,127 @@ run_pindle=1
 run_shenk=0
 ```
 
- [general]                      | Descriptions
---------------------------------|---------------------------------------------
-name | Name used in terminal and discord messages
-monitor | Select on which monitor D2R is running in case multiple are available
-max_game_length_s | Botty will attempt to stop whatever its doing and try to restart a new game. Note if this fails, botty will attempt to shut down D2R and Bnet
-exit_key | Pressing this key (anywhere), will force botty to shut down
-resume_key | After starting the exe botty will wait for this keypress to atually start botting away
-graphic_debugger_key | Pressing this key will start a debug mode to check if the color filtering works with your settings. It also includes the item search and marks items it would pick up with red circles
-logger_lvl | Can be any of [info, debug] and determines how much output you see on the command line
-randomize_runs | If 0, the order will always be pindle -> eldritch/shenk. If 1 the order will be random.
-difficulty | Set to `normal` `nightmare` or `hell` for game difficulty
-custom_discord_hook | Add your own discord hook here to get messages about drops and in case botty got stuck and can not resume
-info_screenshots | If 1, the bot takes a screenshot with timestamp on every stuck / chicken / timeout / inventory full event. This is 1 by Default, so remember to clean up the folder every once in a while
-loot_screenshots | If 1, the bot takes a screenshot with timestamp everytime he presses show_items button and saves it to loot_screenshots folder. Remember to clear them once in a while...
+| [general]                | Descriptions              |
+| --------------------     | --------------------------|
+| name                     | Name used in terminal and discord messages |
+| monitor                  | Select on which monitor D2R is running in case multiple are available |
+| custom_message_hook      | Add your own message hook here to get messages about drops and botty status updates, discord webhook is default  |
+| logger_lvl               | Can be any of [info, debug] and determines how much output you see on the command line |
+| max_game_length_s        | Botty will attempt to stop whatever its doing and try to restart a new game. Note if this fails, botty will attempt to shut down D2R and Bnet     |
+| randomize_runs           | 0: the order will be as seen in the params.ini. 1: the order will be random |
+| difficulty               | Set to `normal` `nightmare` or `hell` for game difficulty |
+| discord_status_count     | Number of games between discord status messges being sent. Leave empty for no status reports.
+| discord_status_condensed | Toggles condensed view of Discord status messages. 0 Full text, 1 Condensed text.
+| info_screenshots         | If 1, the bot takes a screenshot with timestamp on every stuck / chicken / timeout / inventory full event. This is 1 by Default, so remember to clean up the folder every once in a while |
+| loot_screenshots         | If 1, the bot takes a screenshot with timestamp everytime he presses show_items button and saves it to loot_screenshots folder. Remember to clear them once in a while... |
+| saved_games_folder       | Optional folder path of Diablo 2 : Ressurrected saved games that will be used to overwrite when running the "auto settings" |
 
- [routes]                       | Descriptions
---------------------------------|---------------------------------------------
-run_pindle | Run Pindle in each new game. Select "1" to run it "0" to leave it out.
-run_eldritch | Run Eldritch in each new game. Select "1" to run it "0" to leave it out.
-run_shenk | Run shenk in each new game. Select "1" to run it "0" to leave it out.
+| [routes]     | Descriptions                                                             |
+| ------------ | ------------------------------------------------------------------------ |
+| run_trav     | Run Trav in each new game. Select "1" to run it "0" to leave it out. Specific trav gear is suggested |
+| run_pindle   | Run Pindle in each new game. Select "1" to run it "0" to leave it out.   |
+| run_eldritch | Run Eldritch in each new game. Select "1" to run it "0" to leave it out. |
+| run_shenk    | Run shenk in each new game. Select "1" to run it "0" to leave it out.    |
+| run_nihlatak | Run Nihlatak in each new game. Select "1" to run it "0" to leave it out. (Teleport required) |
 
- [char]                         | Descriptions
---------------------------------|---------------------------------------------
-type | Build type. Currently only "sorceress" or "hammerdin" is supported
-casting_frames | Depending on your char and fcr you will have a specific casting frame count. Check it here: https://diablo2.diablowiki.net/Breakpoints and fill in the right number. Determines how much delay there is after each teleport for example.
-stash_gold | Bool value to stash gold each time when stashing items
-atk_len_pindle | Attack length for hdin or number of attack sequences for sorc when fighting pindle
-atk_len_eldritch | Attack length for hdin or number of attack sequences for sorc when fighting eldritch
-atk_len_shenk | Attack length for hdin or number of attack sequences for sorc when fighting shenk
-num_loot_columns | Number of columns in inventory used for loot (from left!). Remaining space can be used for charms
-take_health_potion | Health percentage when healing potion will be used
-take_mana_potion | Mana percentage when mana potion will be used. Currently belt managment is not very clever and it is safest to only pick up health pots and make sure mana reg is enough for pindle to not need mana pots.
-heal_merc | Merc health percentage when giving healing potion to merc
-chicken | Will chicken (leave game) when player health percentage drops below set value, range 0 to 1. Set to 0 to not chicken.
-merc_chicken | Will chicken (leave game) when merc health percentage drops below set value, range 0 to 1. Set to 0 to not chicken.
-show_items | Hotkey for "show items"
-inventory_screen | Hotkey to open up inventory
-stand_still | Hotkey for "stand still". Note this can not be the default shift key as it would interfere with the merc healing routine.
-tp | Hotkey for using a town portal
-belt_rows | Integer value of how many rows the char's belt has
-show_belt | Hotkey for "show belt"
-potion1 | Hotkey to take potion in slot 1
-potion2 | Hotkey to take potion in slot 2
-potion3 | Hotkey to take potion in slot 3
-potion4 | Hotkey to take potion in slot 4
-belt_rejuv_columns | Number of belt columns for rejuv potions
-belt_hp_columns | Number of belt columns for healing potions
-belt_mp_columns | Number of belt columns for mana potions
-cta_available | 0: no cta available, 1: cta is available and should be used during prebuff
-weapon_switch | Hotkey for "weapon switch" (only needed if cta_available=1)
-battle_order | Hotkey for battle order from cta (only needed if cta_available=1)
-battle_command | Hotkey for battle command from cta (only needed if cta_available=1)
+| [char]             | Descriptions |
+| ------------------ | -------------------------------------------------------------------------------------------------|
+| type               | Build type. Currently only "sorceress" or "hammerdin" is supported |
+| casting_frames     | Depending on your char and fcr you will have a specific casting frame count. Check it here: https://diablo2.diablowiki.net/Breakpoints and fill in the right number. Determines how much delay there is after each teleport for example. If your system has some delay e.g. on vms, you might have to increase this value above the suggest value in the table! |
+| num_loot_columns   | Number of columns in inventory used for loot (from left!). Remaining space can be used for charms |
+| show_items         | Hotkey for "show items" |
+| inventory_screen   | Hotkey to open inventory |
+| force_move         | Hotkey for "force move" |
+| stand_still        | Hotkey for "stand still". Note this can not be the default shift key as it would interfere with the merc healing routine |
+| tp                 | Hotkey for using a town |
+| belt_rows          | Integer value of how many rows the char's belt has |
+| show_belt          | Hotkey for "show belt" |
+| potion1            | Hotkey to take potion in slot 1 |
+| potion2            | Hotkey to take potion in slot 2 |
+| potion3            | Hotkey to take potion in slot 3 |
+| potion4            | Hotkey to take potion in slot 4 |
+| cta_available      | 0: no cta available, 1: cta is available and should be used during prebuff |
+| weapon_switch      | Hotkey for "weapon switch" (only needed if cta_available=1) |
+| battle_order       | Hotkey for battle order from cta (only needed if cta_available=1) |
+| battle_command     | Hotkey for battle command from cta (only needed if cta_available=1) |
+| stash_gold         | Bool value to stash gold each time when stashing items |
+| gold_trav_only     | Hacky config that will restrict gold pickup to trav only. misc_gold must be set to 1 for this to have any effect |
+| use_merc           | Set to 1 for using merc. Set to 0 for not using merc (will not revive merc when dead), default = 1 |
+| atk_len_trav       | Attack length for hdin fighting trav (note this atk length will be applied in 4 different spots each) |
+| atk_len_pindle     | Attack length for hdin or number of attack sequences for sorc when fighting pindle |
+| atk_len_eldritch   | Attack length for hdin or number of attack sequences for sorc when fighting eldritch |
+| atk_len_shenk      | Attack length for hdin or number of attack sequences for sorc when fighting shenk |
+| atk_len_nihlatak   | Attack length for hdin or number of attack sequences for sorc when fighting nihlatak |
+| take_health_potion | Health percentage when healing potion will be used. e.g. 0.6 = 60% helath |
+| take_mana_potion   | Mana percentage when mana potion will be used |
+| take_rejuv_potion_health | Health percentag when rejuv potion will be used |
+| take_rejuv_potion_mana   | Mana percentag when rejuv potion will be used |
+| heal_merc          | Merc health percentage when giving healing potion to merc |
+| heal_rejuv_merc    | Merc health percentage when giving rejuv potion to merc |
+| chicken            | Will chicken (leave game) when player health percentage drops below set value, range 0 to 1. Set to 0 to not chicken. |
+| merc_chicken       | Will chicken (leave game) when merc health percentage drops below set value, range 0 to 1. Set to 0 to not chicken. |
+| belt_rejuv_columns | Number of belt columns for rejuv potions |
+| belt_hp_columns    | Number of belt columns for healing potions |
+| belt_mp_columns    | Number of belt columns for mana potions |
+| pre_buff_every_run | 0: Will only prebuff on first run, 1: Will prebuff after each run/boss |
 
- [sorceress]                    | Descriptions
---------------------------------|---------------------------------------------
-teleport | Required Hotkey for teleport
-skill_left | Required Hotkey for skill that is used on left mouse btn (e.g. Glacial Spike)
-skill_right | Required Hotkey for skill that is used on right mouse btn (e.g. Blizzard)
-frozen_armor | Optional Hotkey for frozen armor (or any of the other armors)
-energy_shield | Optional Hotkey for energy shield
-thunder_storm | Optional Hotkey for thunder storm
+### Builds
+| [sorceress]   | Descriptions                                                                  |
+| ------------- | ----------------------------------------------------------------------------- |
+| teleport      | Required Hotkey for teleport                                                  |
+| frozen_armor  | Optional Hotkey for frozen armor (or any of the other armors)                 |
+| energy_shield | Optional Hotkey for energy shield                                             |
+| thunder_storm | Optional Hotkey for thunder storm                                             |
 
- [hammerdin]                    | Descriptions
---------------------------------|---------------------------------------------
-teleport | Optional Hotkey for teleport. If left empty hammerdin will run instead of teleport.
-concentration | Required Hotkey for Concentration
-holy_shield | Hotkey for Holy Shield
-blessed_hammer | Hotkey for Blessed Hammer
-redemption | Optional Hotkey for redemption
-vigor | Optional Hotkey for vigor
+| [light_sorc]  | Descriptions                                                                  |
+| ------------- | ----------------------------------------------------------------------------- |
+| chain_lightning | Optional Hotkey for chain_lightning (must be bound to left skill)           |
+| lightning     | Required Hotkey for lightning (must be bound to right skill)                  |
 
- [advanced_options]             | Descriptions
---------------------------------|---------------------------------------------
-pathing_delay_factor | A linear scaling factor, between 1 and 10, applied to pathing delays.
-template_threshold | Threshold to find templates used during pathing.
+| [blizz_sorc]  | Descriptions                                                                  |
+| ------------- | ----------------------------------------------------------------------------- |
+| ice_blast     | Optional Hotkey for ice_blast (must be bound to left skill)                   |
+| blizzard      | Required Hotkey for Blizzard (must be bound to right skill)                   |
 
- [items]                        | Descriptions
---------------------------------|---------------------------------------------
-item_type | 0: Item will not be picked up. 1: Item will be picked up. 2: Item will be picked up and a discord message will be sent.
+| [hammerdin]    | Descriptions                                                                        |
+| -------------- | ----------------------------------------------------------------------------------- |
+| teleport       | Optional Hotkey for teleport. If left empty hammerdin will run instead of teleport. |
+| concentration  | Required Hotkey for Concentration                                                   |
+| holy_shield    | Required Hotkey for Holy Shield                                                     |
+| blessed_hammer | Required Hotkey for Blessed Hammer. (Must be set as left skill!)                    |
+| redemption     | Optional Hotkey for redemption                                                      |
+| vigor          | Optional Hotkey for vigor                                                           |
+
+| [trapsin]    | Descriptions                                                                        |
+| -------------- | ----------------------------------------------------------------------------------- |
+| teleport       | Optional Hotkey for teleport. If left empty trapsin will run instead of teleport.   |
+| skill_left     | Optional Hotkey for Left Skill                                                      |
+| burst_of_speed | Optional Hotkey for Burst of Speed                                                  |
+| fade           | Optional Hotkey for Fade                                                            |
+| shadow_warrior | Optional Hotkey for Shadow Warrior                                                  |
+| lightning_sentry | Required Hotkey for Lightning Sentry                                              |
+| death_sentry   | Required Hotkey for Death Sentry                                                    |
+
+| [barbarian]    | Descriptions                                                                        |
+| -------------- | ----------------------------------------------------------------------------------- |
+| teleport       | Optional Hotkey for teleport. If left empty barb will run instead of teleport.      |
+| leap           | Required Hotkey for Leap                                                            |
+| shout          | Required Hotkey for Shout                                                           |
+| war_cry        | Required Hotkey for War Cry                                                         |
+| find_item      | Optional Hotkey for Find Item                                                       |
+
+| [dclone]             | Descriptions                                                          |
+| -------------------- | --------------------------------------------------------------------- |
+| region_ips           | Start of the region ip you want to filter for. e.g. EU Server = 37.244.11, 37.244.48 |
+| dclone_hotip         | Hot ip you are looking for. Botty will stay in game and message you if a message_hook is set |
+
+| [advanced_options]   | Descriptions                                                          |
+| -------------------- | --------------------------------------------------------------------- |
+| pathing_delay_factor | A linear scaling factor, between 1 and 10, applied to pathing delays. |
+| message_headers      | Headers that are sent with each messages                              |
+| message_body_template | Message body of the post message sent                                |
+| message_highligh     | 0: Send messages as is, 1: Uses message highlighting for discord      |
 
 ## Support this project
+
 Support it by contributing in any technical way, giving feedback, bug reports or submitting PRs.

assets/d2r_settings.json

@@ -42,5 +42,7 @@
     "Chat Gem Mode": 1,
     "Item Name Display": 1,
     "Chat Background": 0,
-    "Always Run": 1
+    "Always Run": 1,
+    "Quick Cast Enabled": 0,
+    "Display Active Skill Bindings": 0
 }