Merge branch 'master' of https://github.com/bottytools/botty

Fixed Stormshield using wrong mod for damage reduction
Fixed Crown of Ages using wrong mod for damage reduction
Added +Skill to Arkaine's Valor Perfect
Added Damage Reduction mod for Leviathan Perfect

.coveragerc

@@ -0,0 +1,16 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == "__main__":

.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?
 
@@ -26,7 +29,7 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots or even better a short video of the error happening to help explain your problem. Botty often automatically makes screenshots when something goes wrong. Add these also.
 
 **Logs**
-Add the relevant part of the info.log in this section. Either upload it as a fail or copy-paste the relevant part in here.
+Add the relevant part of the log/log_(time).txt in this section. Either upload it as a fail or copy-paste the relevant part in here.
 
 **Additional info**
 Add any other information about the problem here.

.github/workflows/ci.yml

@@ -5,16 +5,16 @@ jobs:
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Setup Miniconda Python 3.8
+      - name: Setup Miniconda Python 3.10
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: '3.10'
       # TODO: The below setp only chaches conda packages, need to cache pip seperatly
       - name: Cache conda
         uses: actions/cache@v2
         env:
           # Increase this value to reset cache if environment.yml has not changed
-          CACHE_NUMBER: 0
+          CACHE_NUMBER: 1
         with:
           path: ~/conda_pkgs_dir
           key: conda-${{ env.CACHE_NUMBER }}-${{hashFiles('environment.yml') }}
@@ -22,14 +22,14 @@ jobs:
         uses: actions/cache@v2
         env:
           # Increase this value to reset cache if environment.yml has not changed
-          CACHE_NUMBER: 0
+          CACHE_NUMBER: 1
         with:
           path: ~/pip
           key: pip-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yml') }}
       - name: Install Miniconda
         uses: conda-incubator/setup-miniconda@v2
         with:
-          python-version: 3.8
+          python-version: '3.10'
           activate-environment: botty
           channel-priority: strict
           environment-file: environment.yml
@@ -39,9 +39,14 @@ jobs:
         run: |
           C:\Miniconda\condabin\conda.bat init powershell
           set PYTHONPATH=./src
-      - name: Pytest
+      - name: Pytest & Coverage
         shell: powershell
         run: |
           C:\Miniconda\condabin\conda.bat activate botty
           python -c "import sys; print(sys.version)"
-          pytest -v -s
+          coverage run --source=./src -m pytest -v -s
+      - name: Coverage Report Generation
+        shell: powershell
+        run: |
+          C:\Miniconda\condabin\conda.bat activate botty
+          coverage xml

.gitignore

@@ -4,19 +4,35 @@ __pycache__/
 playground.py
 *.pyc
 *.pyo
-*.log
 *.spec
 dist/
 build/
-run.build/
-run.dist/
-run.onefile-build/
+main.build/
+main.dist/
+main.onefile-build/
 generated/
 botty_v*/
 custom.ini
-*info_*.png
+config/custom.ini
+config/custom.*.ini
 .vscode
 .vs/
+test/assets/
+.venv
+*.bak
+.coverage
+htmlcov/
+coverage.xml
+utils/live-view/
+config/nip/*
+!config/nip/.gitkeep
+
+stats/
 info_screenshots/
+item_error_screenshots/
 loot_screenshots/
-.venv
+pickit_screenshots/
+*info_log_parsed.txt
+*info_*.png
+*.log
+log/

LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2021 Scott Chacon and others
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,134 +1,249 @@
 # <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 and is not meant for online usage. 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 1080p or 720p and will try to adjust the D2R settings accordingly depending on your monitor res and your botty setting for "res" in the [general] section.
+## 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
-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. Also, there are sample screenshots of how graphics should look like: <a href="/assets/docs/sample_graphics.png">Example 1</a>, <a href="/assets/docs/sample_graphics_2.png">Example 2</a></br>
-**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.
+
+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 tomb of tps in your inventory.
+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 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 **params.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.
 
-
-## 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>
-<img src="assets/docs/graphic_debugger.png" width="900">
+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. Note: Botty will use the /nopickup command in the first game to avoid pickup up trash while traversing. This command will only allow item pickup when "show items" is active.
 
 ## 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:
+## Support this project 💓
+
+You can support this project by giving feedback, reporting bugs, or creating pull requests.
+Contributions are welcome, and we encourage you to contribute to this project if you would like to help out. Botty is a open source project and almost excessively maintained by contributors (there has been 50+ contributors! <3). In our [**discord**](https://discord.gg/Jf3J8cuXWg) there is a contributor role, and you can ping one of the admins and ask for the role to talk to other contributors! Though you don't need to be in the [**discord**](https://discord.gg/Jf3J8cuXWg) to contribute, we do encourage you to do so.
+
+## BNIP Pickit
+
+Botty NIP (BNIP) is an extended version of Njaguar's Item Parser (NIP).
+BNIP is compatible with NIP (with some minor exceptions as discussed below).
+
+There is a default nip file that comes with botty called "default.nip" inside config folder, you can add your own nip files by putting them inside config/nip with a file extension of .nip. Creating your own nip file also turns off the default.nip.
+
+We suggest you read the NIP guide if you are unfamiliar with NIP https://github.com/blizzhackers/pickits/blob/master/NipGuide.md
+
+### New features in BNIP
+
+Poison damage is no longer calculated, but is now read as it's raw value. Example: Adds 5-10 poison damage over 1 seconds can be picked with `[poisonmindam] == 5 && [poisonmaxdam] == 10`. "313 Poison Damage over 5 seconds" can be picked with `[poisonmindam] == 313` or  `[poisonmaxdam] == 313`.
+
+`[allres]` is a thing now. example: `[type] == amulet && [quality] == unique # [allres] == 30` will pick up Mara's
+
+`[idname]` can now be used for unique / set items. For example, `[idname] == thestoneofjordan` will pick up SoJ. Keep in mind, however, this forces the item to be ID'd so be careful if you want to keep unid items.
+
+`[maxquantity]` is not supported (yet). You can leave those tags in but they'll do nothing.
+
+If you have the discord webhook hooked up to alert you when the bot keeps items, you can suppress these alerts by adding a "@" in front of your expression.
+
+@[type] == ring = no notification
+[type] == ring = notification
+
+## Graphic Debugger
+
+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">
+
+## 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 **params.ini** changes to the new version. Example:
+
 ```ini
-; custom.ini - overwrites 3 params in the param.ini
+; custom.ini - overwrites 2 params in the params.ini
 [general]
-monitor=1
+name=MyCustomName
 
 [routes]
-run_pindle=1
-run_shenk=0
+order=run_pindle, run_eldritch
 ```
 
- [general]                      | Descriptions
---------------------------------|---------------------------------------------
-name | Name used in terminal and discord messages
-monitor | Select on which monitor D2R is running in case multiple are available
-res | Resolution settings can be any of [1920_1080, 1280_720]
-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              |
+| --------------------     | --------------------------|
+| difficulty               | Set to `normal` `nightmare` or `hell` for game difficulty. |
+| name                     | Name used in terminal and discord messages. |
+| randomize_runs           | Randomize the order of `[routes]` specified in `params.ini`. |
+| saved_games_folder       | [Optional] Defaults to `~\Saved Games\Diablo II Resurrected`. Used to store configuration settings for `f9` / auto settings. |
+| custom_loot_message_hook      | Add your message hook here (such as Discord channel) to get info about loot |
+| custom_message_hook      | Add your message hook here (such as Discord channel) to get info about botty status updates, discord webhook is default. |
+| discord_log_chicken      | Set to `1` to enable messages about bot chickens, `0` to disable. |
+| discord_status_count     | Number of games between discord status messages being sent. Leave empty for no status reports. |
+| message_api_type         | Which api to use to send botty messages.  Supports "generic_api" (basic discord), or "discord" (discord embeds with images). |
+| break_length_m           | Break for `break_length_m` minutes every `max_runtime_before_break_m` minutes |
+| max_runtime_before_break_m | ^ |
+| 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. |
+| max_consecutive_fails    | Botty will stop making games if the number of consecutive fails reaches this max value. |
+| 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. |
+| 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. |
+| pickit_screenshots         | If `1`, the bot takes a screenshot with timestamp on every ground loot snapshot taken during pickit routine, can be useful for debugging. |
+| 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... |
 
- [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                                                             |
+| ------------ | ------------------------------------------------------------------------ |
+| order        | List of runs botty should do. These will be run in the the order listed unless `randomize_runs` is set to 1. Possible runs: </br> run_trav, run_pindle, run_eldritch, run_eldritch_shenk, run_nihlathak (requires teleport), run_arcane (requires teleport), run_diablo (requires teleport, only hammardin)
 
- [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.
-slow_walk | With this set to 1 the char will have a large delay for each running action in town. Set this to 1 if you keep getting stuck during traversing town.
-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 |
+| belt_rows          | Integer value of how many rows the char's belt has |
+| 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! |
+| cta_available      | 0: no cta available, 1: cta is available and should be used during prebuff |
+| safer_routines    | Set to 1 to enable optional defensive maneuvers/etc during combat/runs at the cost of increased runtime (ex. hardcore players)
+| num_loot_columns   | Number of columns in inventory used for loot (from left!). Remaining space can be used for charms |
+| force_move         | Hotkey for "force move" |
+| inventory_screen   | Hotkey to open inventory |
+| 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 |
+| show_belt          | Hotkey for "show belt" |
+| show_items         | Hotkey for "show items" |
+| stand_still        | Hotkey for "stand still". Note this can not be the default shift key as it would interfere with the merc healing routine |
+| teleport           | Hotkey for teleport (set blank if your character can't teleport) |
+| town_portal           | Hotkey for town portal |
+| weapon_switch      | Hotkey for "weapon switch" (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 |
+| 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_arc        | Attack length for hdin/sorc fighting arcane  |
+| atk_len_eldritch   | Attack length for hdin or number of attack sequences for sorc when fighting eldritch |
+| atk_len_nihlathak   | Attack length for hdin or number of attack sequences for sorc when fighting nihlathak |
+| atk_len_pindle     | Attack length for hdin or number of attack sequences for sorc when fighting pindle |
+| atk_len_shenk      | Attack length for hdin or number of attack sequences for sorc when fighting shenk |
+| atk_len_trav       | Attack length for hdin fighting trav (note this atk length will be applied in 4 different spots each) |
+| atk_len_cs_trashmobs   | Attack length for hdin or number of attack sequences when fighting Trash Mobs 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_vizier   | Attack length for hdin or number of attack sequences when fighting Sealboss A "Vizier of Chaos" in Chaos Sanctuary (Diablo) |
+| atk_len_diablo   | Attack length for hdin or number of attack sequences when fighting Diablo in Chaos Sanctuary |
+| cs_mob_detect | If 1, it will attempt to use holy freeze from merc / conviction aura / poison to detect nearby mobs to help speed-up CS run.
+| cs_town_visits   | CURRENTLY BROKEN, LEAVE AT 0 FOR NOW |
+| 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) |
+| belt_hp_columns    | Number of belt columns for healing potions |
+| belt_mp_columns    | Number of belt columns for mana potions |
+| belt_rejuv_columns | Number of belt columns for rejuv potions |
+| 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. |
+| enable_no_pickup   | When enabled, will type `/nopickup` into chat at game start, which can help reduce accidental pickups especially for walking characters. |
+| 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
+| id_items           | Will identify items with tome of ID or at Cain if enabled |
+| open_chests        | Open up chests in some places. E.g. on dead ends of arcane. |
+| pre_buff_every_run | 0: Will only prebuff on first run, 1: Will prebuff after each run/boss |
+| runs_per_repair    | Force repair after `runs_per_repair` of runs. Set to 0 to repair only when needed. |
+| 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) |
+| sell_junk          | 0: Discard unwanted items by dropping them on ground. 1: Discard items by selling them at vendor. |
 
- [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
+| [transmute]             | Descriptions |
+| ------------------ | -------------------------------------------------------------------------------------------------|
+| 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)
+| transmute         | Add any or all of `chipped, flawed, standard, flawless` to trasmute gems of these types |
+| 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  |
 
- [hammerdin]                    | Descriptions
---------------------------------|---------------------------------------------
-teleport | Required Hotkey for teleport
-concentration | Required Hotkey for Concentration
-redemption | Optional Hotkey for redemption
-holy_shield | Hotkey for Holy Shield
-blessed_hammer | Hotkey for Blessed Hammer
+### Builds
+| [sorceress]   | Descriptions                                                                  |
+| ------------- | ----------------------------------------------------------------------------- |
+| 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                                             |
+| static_field | Optional Hotkey for static field                                      |
+| telekinesis | Optional Hotkey for telekinesis                                      |
 
- [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.
+| [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)                  |
+| frozen_orb     | Optional Hotkey for frozen orb (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.
+| [blizz_sorc]  | Descriptions                                                                  |
+| ------------- | ----------------------------------------------------------------------------- |
+| blizzard      | Required Hotkey for Blizzard (must be bound to right skill)                   |
+| ice_blast     | Optional Hotkey for ice_blast (must be bound to left skill)                   |
 
-## Support this project
-Support it by contributing in any technical way, giving feedback, bug reports or submitting PRs.
+| [nova_sorc]   | Descriptions                                                                  |
+| ------------- | ----------------------------------------------------------------------------- |
+| nova          | Required Hotkey for Nova (must be bound to right skill)                       |
+
+| [hydra_sorc]  | Descriptions                                                                  |
+| ------------- | ----------------------------------------------------------------------------- |
+| alt_attack     | Required Hotkey for any alternate attacking skill. Fireball,Lightning,Frozen Orb, etc. (must be bound to right skill)                             |
+| hydra         | Required Hotkey for Hydra (must be bound to right skill)                      |
+
+| [paladin]    | Descriptions                                                                        |
+| -------------- | ----------------------------------------------------------------------------------- |
+| cleansing      | Optional Hotkey for Cleansing                                                       |
+| holy_shield    | Required Hotkey for Holy Shield                                                     |
+| redemption     | Optional Hotkey for Redemption                                                      |
+| vigor          | Optional Hotkey for Vigor                                                           |
+
+| [fohdin]    | Descriptions                                                                        |
+| -------------- | ----------------------------------------------------------------------------------- |
+| blessed_hammer | Hotkey for Blessed Hammer. (Optional. Bind to left skill)                  |
+| concentration  | Hotkey for Concentration                                                   |
+| conviction  | Hotkey for Conviction                                                   |
+| foh  | Hotkey for Fist of Heavens (Required)                                                   |
+| holy_bolt  | Hotkey for Holy Bolt (Required)                                                   |
+
+
+| [hammerdin]    | Descriptions                                                                        |
+| -------------- | ----------------------------------------------------------------------------------- |
+| concentration  | Required Hotkey for Concentration                                                   |
+| blessed_hammer | Required Hotkey for Blessed Hammer. (must be bound to left skill!)                  |
+
+| [trapsin]    | Descriptions                                                                          |
+| -------------- | ----------------------------------------------------------------------------------- |
+| burst_of_speed | Optional Hotkey for Burst of Speed                                                  |
+| death_sentry   | Required Hotkey for Death Sentry                                                    |
+| fade           | Optional Hotkey for Fade                                                            |
+| lightning_sentry | Required Hotkey for Lightning Sentry                                              |
+| shadow_warrior | Optional Hotkey for Shadow Warrior                                                  |
+| skill_left     | Optional Hotkey for Left Skill                                                      |
+
+| [barbarian]    | Descriptions                                                                        |
+| -------------- | ----------------------------------------------------------------------------------- |
+| cry_frequency  | Time in seconds between each cast of war_cry. Set to 0.0 if max fcr should be used  |
+| find_item      | Optional Hotkey for Find Item                                                       |
+| leap           | Required Hotkey for Leap                                                            |
+| shout          | Required Hotkey for Shout                                                           |
+| war_cry        | Required Hotkey for War Cry                                                         |
+
+| [Necro]        | Descriptions                                                                        |
+| -------------- | ----------------------------------------------------------------------------------- |
+| skill_left     | Required Hotkey for attack (bonespear/teeth)                                        |
+| bone_armor     | Required Hotkey for Bone Armor                                                      |
+| clay_golem     | Required Hotkey for Clay Golem                                                      |
+| raise_skeleton | Required Hotkey for Raise Skeleton                                                  |
+| amp_dmg        | Required Hotkey for Amplify Damage                                                  |
+| corpse_explosion | Required Hotkey Corpse Explosion                                                  |
+| raise_revive   | Required Hotkey revive                                                              |
+| damage_scaling   | Adjusts time spent casting attack skills. Ex: 2 will cast twice as long           |
+| clear_pindle_packs | Clears mobs before pindle                                                       |
+
+| [advanced_options]   | Descriptions                                                          |
+| -------------------- | --------------------------------------------------------------------- |

assets/d2r_settings.json

@@ -42,5 +42,9 @@
     "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,
+    "Lobby Wide Item Drop Enabled": 1,
+    "Item Tooltip Hotkey Appender": 1
 }