Auto-detect and use character specific hotkeys via key file

README.md

@@ -15,7 +15,9 @@ All settings will automatically be set when you execute `main.exe` and press the
 
 ### 2) Supported builds
 
-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!
+Botty will auto-detect hotkeys for the character using **params.ini** saved_games_folder and key_file and use the **params.ini** type to "pilot" the character.
+
+The logic for "piloting", as well as supported **params.ini** types can be found in the [char folder](https://github.com/bottytools/botty/tree/master/src/char).
 
 ### 3) Start Location
 
@@ -82,6 +84,7 @@ order=run_pindle, run_eldritch
 | 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. |
+| key_file                 | Key(o) file for the character (found in the Saved Games folder). 'key' is offline characters, 'keyo' is online characters. Some online characters may have a hash added to them: Paladin53672482.keyo. |
 | 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. |

config/game.ini

@@ -106,9 +106,9 @@ tp_search=353,120,547,400
 repair_btn=318,473,90,80
 left_inventory=35,92,378,378
 right_inventory=866,348,379,152
-skill_right=664,673,41,41
+skill_right=664,673,45,45
 skill_right_expanded=655,375,385,255
-skill_left=574,673,41,41
+skill_left=574,673,45,45
 main_menu_top_left=0,0,100,100
 gamebar_anchor=600,650,90,90
 gamebar_belt_expandable=792,659,28,28

config/params.ini

@@ -4,6 +4,8 @@ difficulty=hell
 name=Botty
 randomize_runs=0
 saved_games_folder=
+; key_file should be the key(o) file for the character (found in the Saved Games folder). 'key' is offline characters, 'keyo' is online characters. Some online characters may have a hash added to them: Paladin53672482.keyo.
+key_file=
 
 ; messaging
 custom_loot_message_hook=
@@ -55,26 +57,6 @@ safer_routines=0
 ; Store charms, etc. to the right of the inventory.
 num_loot_columns=5
 
-; game hotkeys:
-force_move=e
-inventory_screen=i
-potion1=1
-potion2=2
-potion3=3
-potion4=4
-; show_belt is different from the default hotkey as "~" is for many keyboards not reachable without also pressing altgr
-show_belt=k
-show_items=alt
-; stand_still cannot be the default "shift" as it would interfere with merc healing
-stand_still=capslock
-; teleport: leave empty if you can't use
-teleport=
-town_portal=f9
-; call to arms settings:
-weapon_switch=x
-battle_orders=f7
-battle_command=f8
-
 ; ==========================
 ; ==== Optional configs ====
 ; ==========================
@@ -140,69 +122,32 @@ transmute_every_x_game=20
 ; ==== Builds: Sorceress ====
 ; ===========================
 [sorceress]
-energy_shield=
-frozen_armor=
-static_field=
-telekinesis=
-thunder_storm=
-
 [light_sorc]
 ; chain_lightning must be bound to left skill (hotkey optional as it shouldnt change)
-chain_lightning=
 ; lightning must be right skill, hotkey required
-lightning=
 ; frozen orb must be right skill, hotkey recommended to increase safty for you and merc at trav!
-frozen_orb=
-
 [blizz_sorc]
 ; blizzard must be right skill, hotkey required
-blizzard=
 ; ice_blast must be left skill (hotkey optional as it shouldnt change)
-ice_blast=
-
 [nova_sorc]
 ; nova must be right skill, hotkey required
-nova=
-
 [hydra_sorc]
 ; only supports Pindle and Eldritch currently
-; alt_attack is any alternate attacking right skill. Fireball,Lightning,Frozen Orb, hotkey required
-alt_attack=
-; hydra must be right skill, hotkey required
-hydra=
 
 ; =========================
 ; ==== Builds: Paladin ====
 ; =========================
 [paladin]
-cleansing=
-holy_shield=
-redemption=
-vigor=
-
 [fohdin]
 ; foh must be left skill, hotkey required
-blessed_hammer=
-concentration=
-conviction=
-foh=
-holy_bolt=
-
 [hammerdin]
-blessed_hammer=
-concentration=
 
 
 ; ==========================
 ; ==== Builds: Assassin ====
 ; ==========================
 ; Currently no Trav implementaiton!
 [trapsin]
-burst_of_speed=
-death_sentry=
-fade=
-lightning_sentry=
-shadow_warrior=
 skill_left=
 
 
@@ -214,10 +159,6 @@ skill_left=
 ; Ensure Battle Order/Command hotkeys are set above in the [char] section
 [barbarian]
 cry_frequency=0.7
-find_item=
-leap=
-shout=
-war_cry=
 
 
 ; ==========================
@@ -231,40 +172,12 @@ war_cry=
 ;recomended to set skeleton mage to same as revive hot hey
 ;skeleton mages cause pathing issues not ideal to use yet
 [necro]
-amp_dmg=
-bone_armor=
-clay_golem=
-clear_pindle_pack=
-corpse_explosion=
-heart_of_wolverine=
-raise_mage=
-raise_revive=
-raise_skeleton=
 skill_left=
 
 [poison_necro]
-bone_armor=
-# Can use any golem
-clay_golem=
-clear_pindle_pack=
-corpse_explosion=
-heart_of_wolverine=
-# Can Use any curse
-lower_res=
-poison_nova=
-raise_mage=
-raise_revive=
-raise_skeleton=
-# Not Required
 skill_left=
 
 [bone_necro]
-bone_armor=
-bone_spear=
-bone_spirit=
-bone_wall=
-clay_golem=
-teeth=
 ; Damage scaling. One setting to adjust kill speed to account for better/worse gear.
 ; ex: 2 will cast all attack skills twice a long, .5 half as long. Currently only used by bone necro
 damage_scaling=1

src/bot.py

@@ -11,6 +11,7 @@
 
 from health_manager import set_pause_state
 from transmute import Transmute
+from utils import hotkeys
 from utils.misc import wait, hms
 from utils.restart import safe_exit, restart_game
 from game_stats import GameStats
@@ -34,6 +35,7 @@
 from char.basic_ranged import Basic_Ranged
 from ui_manager import wait_until_hidden, wait_until_visible, ScreenObjects, is_visible, detect_screen_object
 from ui import meters, skills, view, character_select, main_menu
+from ui.skills import SkillName
 from inventory import personal, vendor, belt, common
 
 from run import Pindle, ShenkEld, Trav, Nihlathak, Arcane, Diablo
@@ -218,7 +220,8 @@ def _rebuild_as_asset_to_trigger(trigger_to_assets: dict):
 
     def on_init(self):
         self._game_stats.log_start_game()
-        keyboard.release(Config().char["stand_still"])
+        if hotkeys.HotkeyName.StandStill in hotkeys.d2r_keymap:
+            keyboard.release(hotkeys.d2r_keymap[hotkeys.HotkeyName.StandStill])
         transition_to_screens = Bot._rebuild_as_asset_to_trigger({
             "select_character": main_menu.MAIN_MENU_MARKERS,
             "start_from_town": town_manager.TOWN_MARKERS,
@@ -248,7 +251,7 @@ def on_create_game(self):
         # Start a game from hero selection
         if (m := wait_until_visible(ScreenObjects.MainMenu)).valid:
             if "DARK" in m.name:
-                keyboard.send("esc")
+                keyboard.send(hotkeys.d2r_keymap[hotkeys.HotkeyName.OpenMenu])
             main_menu.start_game()
             view.move_to_corpse()
         else:
@@ -257,19 +260,27 @@ def on_create_game(self):
 
     def on_start_from_town(self):
         self._curr_loc = self._town_manager.wait_for_town_spawn()
-
         # Handle picking up corpse in case of death
         if (corpse_present := is_visible(ScreenObjects.Corpse)):
             self._previous_run_failed = True
             view.pickup_corpse()
             wait_until_hidden(ScreenObjects.Corpse)
             belt.fill_up_belt_from_inventory(Config().char["num_loot_columns"])
+        if not hotkeys.discovered:
+            saved_games_folder = Config().general["saved_games_folder"]
+            key_file = Config().general["key_file"]
+            hotkeys.discover_hotkey_mappings(saved_games_folder, key_file)
         self._char.discover_capabilities()
-        if corpse_present and self._char.capabilities.can_teleport_with_charges and not self._char.select_tp():
-            keybind = Config().char["teleport"]
+        teleport_selected = skills.select_tp(hotkeys.right_skill_key_map[SkillName.Teleport]) if SkillName.Teleport in hotkeys.right_skill_key_map else None
+        if corpse_present and self._char.capabilities.can_teleport_with_charges and not teleport_selected:
+            keybind = hotkeys.right_skill_key_map[SkillName.Teleport]
             Logger.info(f"Teleport keybind is lost upon death. Rebinding teleport to '{keybind}'")
-            self._char.remap_right_skill_hotkey("TELE_ACTIVE", Config().char["teleport"])
-
+            hotkeys.remap_skill_hotkey(
+                SkillName.Teleport.value,
+                keybind,
+                Config().ui_roi["skill_right"],
+                Config().ui_roi["skill_right_expanded"]
+            )
         # Run /nopickup command to avoid picking up stuff on accident
         if Config().char["enable_no_pickup"] and (not self._ran_no_pickup and not self._game_stats._nopickup_active):
             self._ran_no_pickup = True
@@ -286,7 +297,6 @@ def on_start_from_town(self):
     def on_maintenance(self):
         # Pause health manager if not already paused
         set_pause_state(True)
-
         # Dismiss skill/quest/help/stats icon if they are on screen
         if not view.dismiss_skills_icon():
             view.return_to_play()
@@ -368,7 +378,8 @@ def on_maintenance(self):
         # Check if we are out of tps or need repairing
         need_repair = is_visible(ScreenObjects.NeedRepair)
         need_routine_repair = False if not Config().char["runs_per_repair"] else self._game_stats._run_counter % Config().char["runs_per_repair"] == 0
-        need_refill_teleport = self._char.capabilities.can_teleport_with_charges and (not self._char.select_tp() or self._char.is_low_on_teleport_charges())
+        teleport_selected = skills.select_tp(hotkeys.right_skill_key_map[SkillName.Teleport]) if SkillName.Teleport in hotkeys.right_skill_key_map else None
+        need_refill_teleport = self._char.capabilities.can_teleport_with_charges and (not teleport_selected or self._char.is_low_on_teleport_charges())
         if need_repair or need_routine_repair or need_refill_teleport or sell_items:
             if need_repair:
                 Logger.info("Repair needed. Gear is about to break")

src/char/barbarian.py

@@ -1,8 +1,8 @@
 import keyboard
-from ui import skills
+from ui.skills import SkillName, is_left_skill_selected, is_right_skill_active
+from utils import hotkeys
 from utils.custom_mouse import mouse
 from char import IChar, CharacterCapabilities
-import template_finder
 from pather import Pather
 from logger import Logger
 from screen import convert_abs_to_monitor
@@ -24,10 +24,10 @@ def _cast_war_cry(self, time_in_s: float):
         #  keyboard.send(self._skill_hotkeys["concentration"])
         #  wait(0.05, 0.1)
         cry_frequency = min(0.2, self._skill_hotkeys["cry_frequency"])
-        keyboard.send(Config().char["stand_still"], do_release=False)
+        keyboard.send(hotkeys.d2r_keymap[hotkeys.HotkeyName.StandStill], do_release=False)
         wait(0.05, 0.1)
-        if self._skill_hotkeys["war_cry"]:
-            keyboard.send(self._skill_hotkeys["war_cry"])
+        if SkillName.WarCry in hotkeys.right_skill_key_map:
+            keyboard.send(hotkeys.right_skill_key_map[SkillName.WarCry])
         wait(0.05, 0.1)
         start = time.time()
         while (time.time() - start) < time_in_s:
@@ -36,16 +36,16 @@ def _cast_war_cry(self, time_in_s: float):
             wait(cry_frequency, cry_frequency + 0.2)
             mouse.click(button="right")
         wait(0.01, 0.05)
-        keyboard.send(Config().char["stand_still"], do_press=False)
+        keyboard.send(hotkeys.d2r_keymap[hotkeys.HotkeyName.StandStill], do_press=False)
 
     def on_capabilities_discovered(self, capabilities: CharacterCapabilities):
         if capabilities.can_teleport_natively:
             self._pather.offset_node(149, [120, 70])
 
     def _do_hork(self, hork_time: int):
         wait(0.5)
-        if self._skill_hotkeys["find_item"]:
-            keyboard.send(self._skill_hotkeys["find_item"])
+        if SkillName.FindItem in hotkeys.right_skill_key_map:
+            keyboard.send(hotkeys.right_skill_key_map[SkillName.FindItem])
             wait(0.5, 0.15)
         pos_m = convert_abs_to_monitor((0, -20))
         mouse.move(*pos_m)
@@ -56,15 +56,15 @@ def _do_hork(self, hork_time: int):
         wait(1)
 
     def pre_buff(self):
-        keyboard.send(Config().char["battle_command"])
+        keyboard.send(hotkeys.right_skill_key_map[SkillName.BattleCommand])
         wait(0.08, 0.19)
         mouse.click(button="right")
         wait(self._cast_duration + 0.08, self._cast_duration + 0.1)
-        keyboard.send(Config().char["battle_orders"])
+        keyboard.send(hotkeys.right_skill_key_map[SkillName.BattleOrders])
         wait(0.08, 0.19)
         mouse.click(button="right")
         wait(self._cast_duration + 0.08, self._cast_duration + 0.1)
-        keyboard.send(self._skill_hotkeys["shout"])
+        keyboard.send(hotkeys.right_skill_key_map[SkillName.Shout])
         wait(0.08, 0.19)
         mouse.click(button="right")
         wait(self._cast_duration + 0.08, self._cast_duration + 0.1)
@@ -73,10 +73,10 @@ def pre_move(self):
         # select teleport if available
         super().pre_move()
         # in case teleport hotkey is not set or teleport can not be used, use leap if set
-        should_cast_leap = self._skill_hotkeys["leap"] and not skills.is_left_skill_selected(["LEAP"])
-        can_teleport = self.capabilities.can_teleport_natively and skills.is_right_skill_active()
+        should_cast_leap = SkillName.Leap in hotkeys.right_skill_key_map and not is_left_skill_selected(SkillName.Leap.value)
+        can_teleport = self.capabilities.can_teleport_natively and is_right_skill_active()
         if  should_cast_leap and not can_teleport:
-            keyboard.send(self._skill_hotkeys["leap"])
+            keyboard.send(hotkeys.right_skill_key_map[SkillName.Leap])
             wait(0.15, 0.25)
 
     def _move_and_attack(self, abs_move: tuple[int, int], atk_len: float):

src/char/basic.py

@@ -1,5 +1,6 @@
 import keyboard
 from ui import skills
+from utils import hotkeys
 from utils.custom_mouse import mouse
 from char import IChar,CharacterCapabilities
 import template_finder
@@ -25,7 +26,7 @@ def on_capabilities_discovered(self, capabilities: CharacterCapabilities):
             self._pather.offset_node(149, [120, 70])
 
     def _cast_attack_pattern(self, time_in_s: float):
-        keyboard.send(Config().char["stand_still"], do_release=False)
+        keyboard.send(hotkeys.d2r_keymap[hotkeys.HotkeyName.StandStill], do_release=False)
         wait(0.05, 0.1)
         keyboard.send(self._skill_hotkeys["left_attack"])
         wait(0.05, 0.1)
@@ -40,7 +41,7 @@ def _cast_attack_pattern(self, time_in_s: float):
                 wait(0.05, 0.1)
                 mouse.click(button="left")
         wait(0.01, 0.05)
-        keyboard.send(Config().char["stand_still"], do_press=False)
+        keyboard.send(hotkeys.d2r_keymap[hotkeys.HotkeyName.StandStill], do_press=False)
 
     def pre_buff(self):
         if Config().char["cta_available"]: