Auto-detect and use character specific hotkeys via key file #905

Ezro · 2022-06-18T21:36:48Z

This implementation will read the provided 'key_file' param (which should map to the exact name in the saved_games_folder) and parse the hotkeys for the provided character. Once Botty goes into game it will then run a "discovery" to try to determine what skills are bound to the discovered hotkeys.

The PR should auto-detect sorc, pally, barb, necro, sin, and druid skill. The existing char scripts should be updated to use the proposed hotkey solution.

An important thing to note is that the implementation currently assumes that Quick Casting is disabled; if we plan on shifting to using Quick Casting then I think this solution can be tweaked to hold the keybind prior to taking the screenshot.

src/utils/hotkeys.py

src/ui/skills.py

src/template_finder.py

aeon0 · 2022-06-21T11:37:52Z

src/template_finder.py

@@ -60,10 +60,37 @@ def stored_templates() -> dict[Template]:
            )
    return templates

+@cache
+def stored_templates_by_dir() -> dict[Template]:


I dont like that we bascially copy the stored_templates() functionality here. I'd rather go for adding the dir normally to TEMPLATE_PATHS and to get all the specific template names loop through folder and get names of the files in a list.

Then we also can ditch the search_all_templates() function.

stored_templates_by_dir and search_all_templates have been removed

@Ezro would you be willing to create a new test case for the new functionality? Just add here https://github.com/aeon0/botty/blob/master/test/template_finder_test.py

@mgleed I added some asserts but they're very basic; please validate

aliig · 2022-06-21T12:13:02Z

One thing that needs to be tested here is localization. Botty currently allows users to select characters that have names that aren't in English alphabet. Not sure if this will break things if people have a keyfile with kanji, for example.

Ezro · 2022-06-21T15:33:19Z

One thing that needs to be tested here is localization. Botty currently allows users to select characters that have names that aren't in English alphabet. Not sure if this will break things if people have a keyfile with kanji, for example.

I've confirmed that this should work for any provided language, but the Logger doesn't seem to like the encoding; I can update the debug line to "Determine hotkeys" and remove the key_name to avoid this error.

Edit: I've updated the PR to no longer print the key file name

aliig · 2022-06-21T23:14:13Z

@Ezro left a few comments earlier

aeon0 · 2022-06-22T08:33:11Z

From my side it looks good. I leave it to gleed since he seems to still have some topics.

aliig · 2022-06-23T12:41:59Z

Also, why'd you choose to stick with precise keyfile name rather than use regexp with character name like we discussed?

aliig

Overall very well done! See comments. Thanks for doing this.

Last wish list item for this PR would be basic validation.

There are some hotkeys that simply cannot be unset. Like force move, etc. Do you think it'd be hard to implement some basic validation for required hotkeys?

src/template_finder.py

aliig · 2022-06-21T18:33:29Z

src/template_finder.py

@@ -60,10 +60,37 @@ def stored_templates() -> dict[Template]:
            )
    return templates

+@cache
+def stored_templates_by_dir() -> dict[Template]:


@Ezro would you be willing to create a new test case for the new functionality? Just add here https://github.com/aeon0/botty/blob/master/test/template_finder_test.py

src/bot.py

src/inventory/belt.py

src/pather.py

src/utils/hotkeys.py

Ezro · 2022-06-23T14:46:06Z

Overall very well done! See comments. Thanks for doing this.

Last wish list item for this PR would be basic validation.

There are some hotkeys that simply cannot be unset. Like force move, etc. Do you think it'd be hard to implement some basic validation for required hotkeys?

I think we can implement that very easily (at some point). Here's the current spot for parsing the key block into actual hotkeys

Ezro · 2022-06-23T14:52:20Z

Also, why'd you choose to stick with precise keyfile name rather than use regexp with character name like we discussed?

I haven't tested this but I think it's better to be explicit; I have a feeling that the hash is there for multi-account handling; e.g., if account A has character 'Paladin' and account B has character 'Paladin' and both were played online on the same PC then we wouldn't actually be able to determine which Paladin file to use.

This adds a bit of overhead for the users (to find and enter the explicit key file name) but I think the trade-off is that Botty wouldn't have to do decision making logic for choosing / erroring.

aliig · 2022-06-23T17:42:14Z

Also, why'd you choose to stick with precise keyfile name rather than use regexp with character name like we discussed?

I haven't tested this but I think it's better to be explicit; I have a feeling that the hash is there for multi-account handling; e.g., if account A has character 'Paladin' and account B has character 'Paladin' and both were played online on the same PC then we wouldn't actually be able to determine which Paladin file to use.

This adds a bit of overhead for the users (to find and enter the explicit key file name) but I think the trade-off is that Botty wouldn't have to do decision making logic for choosing / erroring.

That's a good point and I'd bet your theory is correct.

done

aliig

Testing locally. if it works well I'll merge today ™️

not quite ready

…logic

…g A5_Portal)

aliig · 2022-06-27T15:15:00Z

Are you able to recover my test that I wrote in template_finder_test.py for this? Looks like that got overwritten with a force push.

Ezro mentioned this pull request Jun 18, 2022

added param to bind a key for "clear_screen" #878

Open

Ezro changed the title ~~Feature/auto detect hotkeys~~ Auto-detect and use character specific hotkeys via key file Jun 18, 2022

Ezro force-pushed the feature/auto_detect_hotkeys branch from f086892 to 59f7681 Compare June 20, 2022 17:49

Ezro added work in progress ready for review For PRs and removed work in progress labels Jun 20, 2022

aeon0 previously requested changes Jun 21, 2022

View reviewed changes

Ezro requested review from aeon0 and aliig June 21, 2022 19:42

aliig previously requested changes Jun 23, 2022

View reviewed changes

Ezro force-pushed the feature/auto_detect_hotkeys branch 2 times, most recently from fa84dff to eef2a92 Compare June 23, 2022 19:01

aliig self-requested a review June 23, 2022 19:15

aliig previously approved these changes Jun 23, 2022

View reviewed changes

Ezro force-pushed the feature/auto_detect_hotkeys branch from 813a6c1 to df2e5ac Compare June 23, 2022 20:03

Ezro added 5 commits June 24, 2022 18:44

Add wip

07d1eb4

Add wip code

400f193

Refactor the code and add more wip code

bc74cac

Add assassin and druid skill templates

2da5dca

Add druid skills and fix typo

27c6185

Ezro added 9 commits June 24, 2022 18:45

Add handling for tilde hotkey

a7816bb

Add comments for key_file

8e8b2dd

Update README to include hotkey auto-detection

3e47fcd

Add capslock mapping

7af599e

Fix fn key mapping and slow down _find_keymapping

ebd3d29

Update battle_command template

73ac248

Fix KeyError when not using teleport on start_from_town

3c28fb4

Add more None handling

6d57f85

Update basic_ranged

c1d0ddf

Ezro force-pushed the feature/auto_detect_hotkeys branch from d463ed2 to c1d0ddf Compare June 25, 2022 00:46

Add seams for auto-starting d2r

6d6fc7d

Ezro linked an issue Jun 25, 2022 that may be closed by this pull request

Auto-detect and use character specific hotkeys via key file #940

Open

Ezro added 9 commits June 25, 2022 07:52

Find saved games folder when not provided

b0036e5

Remove validation from find_d2r_folder()

4a40fb4

Fix selecting online chars

e3e59a0

Fix bug in _find_keymapping and switch back to old select_online_tab …

8124b01

…logic

Revert back to origin select_char logic

cb01179

Update TownPortal ScreenObject ref

c57c8ce

Check if OnlineStatus before select_online_tab

4b1fa52

Switch pather and i_char move back to original logic

50b3e92

Fix issue aeon0#951 (prevent sorc from using telekinesis when enterin…

7f3ec49

…g A5_Portal)

Ezro linked an issue Jun 27, 2022 that may be closed by this pull request

Sorceress telekinesis results in bad starting position when entering Pindle #951

Closed

Move discovered flag into hotkeys

4e18c84

Ezro force-pushed the feature/auto_detect_hotkeys branch from 007c463 to 4e18c84 Compare June 27, 2022 17:46

Ezro added 2 commits June 27, 2022 11:48

Add missing bot.py update for previous commit

b3d72db

Revert sorc select_by_template TK logic back to master

30f3f52

Ezro removed a link to an issue Jun 27, 2022

Sorceress telekinesis results in bad starting position when entering Pindle #951

Closed

add search_all(best_match=True) test

39c47db

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Auto-detect and use character specific hotkeys via key file #905

Auto-detect and use character specific hotkeys via key file #905

Ezro commented Jun 18, 2022 •

edited

Loading

aeon0 Jun 21, 2022

aeon0 Jun 21, 2022

Ezro Jun 21, 2022

aliig Jun 21, 2022

Ezro Jun 23, 2022

aliig commented Jun 21, 2022

Ezro commented Jun 21, 2022 •

edited

Loading

aliig commented Jun 21, 2022

aeon0 commented Jun 22, 2022

aliig commented Jun 23, 2022

aliig left a comment •

edited

Loading

aliig Jun 21, 2022

Ezro commented Jun 23, 2022

Ezro commented Jun 23, 2022

aliig commented Jun 23, 2022

aliig left a comment

aliig commented Jun 27, 2022

Auto-detect and use character specific hotkeys via key file #905

Are you sure you want to change the base?

Auto-detect and use character specific hotkeys via key file #905

Conversation

Ezro commented Jun 18, 2022 • edited Loading

aeon0 Jun 21, 2022

Choose a reason for hiding this comment

aeon0 Jun 21, 2022

Choose a reason for hiding this comment

Ezro Jun 21, 2022

Choose a reason for hiding this comment

aliig Jun 21, 2022

Choose a reason for hiding this comment

Ezro Jun 23, 2022

Choose a reason for hiding this comment

aliig commented Jun 21, 2022

Ezro commented Jun 21, 2022 • edited Loading

aliig commented Jun 21, 2022

aeon0 commented Jun 22, 2022

aliig commented Jun 23, 2022

aliig left a comment • edited Loading

Choose a reason for hiding this comment

aliig Jun 21, 2022

Choose a reason for hiding this comment

Ezro commented Jun 23, 2022

Ezro commented Jun 23, 2022

aliig commented Jun 23, 2022

aliig left a comment

Choose a reason for hiding this comment

aliig commented Jun 27, 2022

Ezro commented Jun 18, 2022 •

edited

Loading

Ezro commented Jun 21, 2022 •

edited

Loading

aliig left a comment •

edited

Loading