Bump version to 0.2.1

feat(pickit): Expanded pickit items and defined new naming convention

.gitignore

@@ -12,3 +12,4 @@ run.dist/
 run.onefile-build/
 generated/
 botty_v*/
+custom.ini

README.md

@@ -1,50 +1,66 @@
 # <img src="assets/docs/header_green.png" width="370">
 
-Simple Pixelbot for Diablo 2 Resurrected written in python and opencv. Obviously only use it in offline mode as it is against the TOS of Blizzard to use it in online mode!
+Simple Pixelbot for Diablo 2 Resurrected written in python and opencv. Obviously only use it in offline mode as it is against the TOS of Blizzard to use it online!
+[**Download here**](https://github.com/aeon0/botty/releases). Got to have a [**Discord**](https://discord.gg/CnkfsjqN) nowadays I guess :man_shrugging:
 
-Join the [**Discord Channel**](https://discord.gg/CnkfsjqN) for help and discussions.
+
+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://vimeo.com/641410429)
 
-## Supported features
+## What it does
 - Run Pindle, Eldtritch, Shenk
-- Pickit with per item config.
+- Pickit with per item config
 - Stash picked up items (using all 4 stashes)
 - Prebuff
 - Revive Merc if dead
 - Heal at Malah if needed
-- Take potions and chicken if in trouble during fights
+- Shop for tps and repair at Lazurk
+- Take potions (health and mana) and chicken if in trouble during fights
 - Check for death. In this case start another game and pick up corpse.
 - Supported builds: Sorceress (Blizz, Light, Meteor), Hammerdin
-- Debug color checker to easily verify your settings
+- Auto Settings and Debug Color Mode to easily verify your settings
 - Runs in Hyper-V
+- Highly configurable, consult the param.ini section for more details
 
 ## Getting started
 ### 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. The important ones are listed here:
-
-- Resolution: 1920x1080 (Fullscreen)
-- Gamma: 155
-- Item Label Display: Hold
-- Large Font Mode: on
+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 "Color Test Mode" to verify your settings.</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.
 
 ### 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 __param.ini__ for the `[char]` and `[sorceress]` section accordingly. Check out the param.ini section in the Readme for more details on each param.
+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.
+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.
 
 ### 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 hell when starting a hell game.
 
 ### 5) Start Botty
-Download the a prebuilt release [here](https://github.com/aeon0/botty/releases). Start `run.exe` in the botty folder, go to D2R window and press the "resume" key. Move to your D2R window and press "f11". You can always force stop botty with f12.
+Download the a prebuilt release [here](https://github.com/aeon0/botty/releases). Start `run.exe` in the botty folder. Move to your D2R window and press the start key (default f11). You can always force stop botty with f12.
+
+## Color Test Mode
+To check if you graphic settings are good and if the bot would pick up items there is a **Color Test Mode** built in. Start botty and press F10 (Default key). This will open up a (mostly black) window. Start a game in D2R and throw some items of different type on the ground. If you now bring forward the debug window all items should show up with their names while the background is black. If you throw an item on the ground that should be picked up, it will have a red circle.</br>
+<img src="assets/docs/color_checker.png" width="400">
 
 ## 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:
+```ini
+; custom.ini - overwrites 3 params in the param.ini
+[general]
+monitor=1
+
+[routes]
+run_pindle=1
+run_shenk=0
+```
+
  [general]                      | Descriptions                                
 --------------------------------|---------------------------------------------
 monitor | Select on which monitor D2R is running in case multiple are available
@@ -52,6 +68,10 @@ min_game_length_s | Games must have at least this length, will wait in hero sele
 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
 color_checker_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.
+send_drops_to_discord | If 1 sends your drops to the discord channel "drop-log"
+custom_discord_hook | If 1 sends a message about drops to this hook and will update you in case botty got stuck and can not resume
 
  [routes]                       | Descriptions                                
 --------------------------------|---------------------------------------------
@@ -62,6 +82,12 @@ run_shenk | Run shenk in each new game. Select "1" to run it "0" to leave it out
 --------------------------------|---------------------------------------------
 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.
+static_path_pindle | If set to 1, the pathing is done by staticly recorded screen positions. Otherwise it uses reference templates
+static_path_eldritch | If set to 1, the pathing is done by staticly recorded screen positions. Otherwise it uses reference templates
+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.
@@ -100,9 +126,5 @@ blessed_hammer | Hotkey for Blessed Hammer
 --------------------------------|---------------------------------------------
 item_type | Select "1" if item should be picked up, "0" if not.
 
-## Some distant future plans
-- Running chaos with AI algo
-- Emulating Keyboard and Mouse with Arduino
-
 ## Support this project
-This project is free. Support it by contributing in any technical way, giving feedback, PRs or by submitting issues. That being said, I am not above accepting some pixel currency :) So if you want to send some fg my way to keep my dopamine high, here is my jsp: [jojo22](https://forums.d2jsp.org/user.php?i=768967).
+This project is free. Support it by contributing in any technical way, giving feedback, PRs or by submitting issues. That being said, I am not above accepting some pixel currency :) So if you want to send some fg my way to keep my dopamine high, here is my d2jsp: aeon0 (https://forums.d2jsp.org/user.php?i=768967).