Bugfix: Game recovery after D2 restart (#620)

* init

* bump version

.gitignore

@@ -15,6 +15,8 @@ generated/
 botty_v*/
 custom.ini
 config/custom.ini
+config/custom.*.ini
+*info_log_parsed.txt
 *info_*.png
 .vscode
 .vs/
@@ -26,3 +28,4 @@ stats/
 .coverage
 htmlcov/
 coverage.xml
+utils/live-view/

README.md

@@ -4,9 +4,9 @@ Pixelbot for Diablo 2 Resurrected. This project is for informational and educati
 
 [**Download here**](https://github.com/aeon0/botty/releases) and got to have a [**Discord**](https://discord.gg/Jf3J8cuXWg) nowadays I guess :man_shrugging:
 
-## Getting started & Prequists
-- D2r needs to be in English Language,
-- Botty currently works with 720p D2r window (will be adjusted automatically on auto settings)
+## Getting started & Prerequisites
+- 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
 
@@ -15,11 +15,11 @@ All settings will automatically be set when you execute `main.exe` and press the
 
 ### 2) Supported builds
 
-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!
+Check the documentation for **params.ini** further down. Different Sorc builds, Hammerdin, 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 any of Act 3, 4 or 5 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 **params.ini** once the bot starts the game.
 
 ### 4) Start Botty
 
@@ -34,14 +34,14 @@ To check if you graphic settings are good and if the bot would pick up items the
 
 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
+## params.ini
 
-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:
+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 **params.ini** changes to the new version. Example:
 
 ```ini
-; custom.ini - overwrites 3 params in the param.ini
+; custom.ini - overwrites 3 params in the params.ini
 [general]
-monitor=1
+name=MyCustomName
 
 [routes]
 run_pindle=1
@@ -50,21 +50,21 @@ 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 |
-| 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 |
-| message_api_type         | Which api to use to send botty messages.  Supports "generic_api" (basic discord), or "discord" (discord embeds with images).
-| discord_status_count     | Number of games between discord status messges being sent. Leave empty for no status reports.
+| name                     | Name used in terminal and discord messages. |
+| 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        | Max game length in seconds. Botty will attempt to stop whatever it's doing and try to restart a new game at specified interval. If this fails, botty will attempt to shut down D2R and Bnet. |
+| max_consecutive_fails    | Botty will stop making games if the number of consecutive fails reaches this max value. |
+| randomize_runs           | Randomize the order of `[routes]` specified in `params.ini`. |
+| difficulty               | Set to `normal` `nightmare` or `hell` for game difficulty. |
+| message_api_type         | Which api to use to send botty messages.  Supports "generic_api" (basic discord), or "discord" (discord embeds with images). |
+| discord_status_count     | Number of games between discord status messages 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" |
-| d2r_path                 | Optional path to find the d2r.exe, if not set will be default to "C:\Program Files (x86)\Diablo II Resurrected\D2R.exe" when attempting to restart |
-| restart_d2r_when_stuck   | Set to `1` and botty will attempt to restart d2r in the case that botty is unable to recover its state (e.g: game crash) |
+| 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] Defaults to `~\Saved Games\Diablo II Resurrected`. Used to store configuration settings for `f9` / auto settings. |
+| d2r_path                 | [Optional] Path to `d2r.exe`. If not set, it will default to `C:\Program Files (x86)\Diablo II Resurrected\D2R.exe` when attempting to restart. |
+| restart_d2r_when_stuck   | Set to `1` and botty will attempt to restart d2r in the case that botty is unable to recover its state (e.g: game crash). |
 
 | [routes]     | Descriptions                                                             |
 | ------------ | ------------------------------------------------------------------------ |
@@ -72,9 +72,9 @@ run_shenk=0
 | 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) |
+| run_nihlathak | Run Nihlathak in each new game. Select "1" to run it "0" to leave it out. (Teleport required) |
 | run_arcane   | Run Arcane Sanctuary in each new game. Select "1" to run it "0" to leave it out. (Teleport required) |
-| run_diablo   | Run Diablo (just the Boss, not the trashmobs) in each new game. Select "1" to run it "0" to leave it out. (Teleport required) |
+| run_diablo   | Run Diablo in each new game. Select "1" to run it "0" to leave it out. (Teleport required) |
 
 | [char]             | Descriptions |
 | ------------------ | -------------------------------------------------------------------------------------------------|
@@ -94,7 +94,7 @@ run_shenk=0
 | 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_order       | Hotkey for battle orders 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 |
@@ -104,13 +104,14 @@ run_shenk=0
 | 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 |
+| atk_len_nihlathak   | Attack length for hdin or number of attack sequences for sorc when fighting nihlathak |
 | atk_len_cs_trashmobs   | Attack length for hdin or number of attack sequences when fighting Trash Mobs in Chaos Sanctuary (Diablo) |
 | atk_len_diablo_vizier   | Attack length for hdin or number of attack sequences when fighting Sealboss A "Vizier of Chaos" in Chaos Sanctuary (Diablo) |
 | atk_len_diablo_deseis   | Attack length for hdin or number of attack sequences when fighting Sealboss B "Lord De Seis" in Chaos Sanctuary (Diablo) |
 | atk_len_diablo_infector   | Attack length for hdin or number of attack sequences when fighting Sealboss C "Infector of Souls" in Chaos Sanctuary (Diablo) |
 | atk_len_diablo_infector   | Attack length for hdin or number of attack sequences when fighting Diablo in Chaos Sanctuary |
-| cs_clear_trash   | If 1, most Trash mob packs from Chaos Sancturay Entrance to Pentagram and Seals A, B, C are cleared (NOT YET IMPLEMENTED). If 0, the run starts at Pentagram and just kills Sealbosses & Diablo |
+| kill_cs_trash   | If 1, most Trash mob packs from Chaos Sancturay Entrance to Pentagram are cleared. If 0, the run starts at Pentagram and just kills Sealbosses & Diablo (default) |
+| cs_town_visits   | If 1, it will go to town, buy pots & stash items between clearing the seals, set 0 to deactivate (default) |
 | 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 |
@@ -123,9 +124,17 @@ run_shenk=0
 | 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 |
-| always_repair      | 0: Will only repair when needed, 1: Will repair at the start of each run (EXPENSIVE FOR HIGH RUNEWORDS) |
+| runs_per_stash    | 0: Will only stash after intentional item pickup, 1+: Will force stash after # of runs set here (recommend at least 4 in case of accidental pickups) |
+| runs_per_repair    | 0: Will only repair when needed, 1+: Will force repair after # of runs set here |
 | id_items           | Will identify items at cain before stashing them. Cain must be rescued for this to work.|
 | open_chests        | Open up chests in some places. E.g. on dead ends of arcane. Note: currently bad runtime. |
+| fill_shared_stash_first | Fill stash tabs starting from right to left, filling personal stash last |
+| gamble_items       | List of items to gamble when stash fills with gold. Leave blank to disable. Supported items currently include circlet, ring, coronet, talon, amulet
+
+| [transmute]             | Descriptions |
+| ------------------ | -------------------------------------------------------------------------------------------------|
+| transmute_every_x_game               | How often to run transmute routine (currently transmutes flawless gems into perfect gems). Transmute routine depends on stashing routine it will only start after items stashing is done. E.g. so it could take more than X games to perform transmutes if there were no items to stash at the time. Default: 20  |
+| stash_destination | Stash tabs by priority to place the results of the transmute. Default: 3,2,1,0. (It means the result will be first placed in stash 3 untils it's full, then to stash 2, etc. 0 - personal tab)
 
 ### Builds
 | [sorceress]   | Descriptions                                                                  |
@@ -168,6 +177,8 @@ run_shenk=0
 | shadow_warrior | Optional Hotkey for Shadow Warrior                                                  |
 | lightning_sentry | Required Hotkey for Lightning Sentry                                              |
 | death_sentry   | Required Hotkey for Death Sentry                                                    |
+| cloak_of_shadows| Optional Hotkey for Cloak of Shadows                                                |
+|  mind_blast    | Optional Hotkey for Mind Blast                                                      |
 
 | [barbarian]    | Descriptions                                                                        |
 | -------------- | ----------------------------------------------------------------------------------- |
@@ -200,7 +211,6 @@ run_shenk=0
 | 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
 

assets/d2r_settings.json

@@ -44,5 +44,7 @@
     "Chat Background": 0,
     "Always Run": 1,
     "Quick Cast Enabled": 0,
-    "Display Active Skill Bindings": 0
+    "Display Active Skill Bindings": 0,
+    "Lobby Wide Item Drop Enabled": 1,
+    "Item Tooltip Hotkey Appender": 1
 }