V1.1.0 Aliases, Naming of lines, a lot of internal Refactoring

[wasiejen]

Hello Everyone,
a new release with some changes, mainly a lot of internal improvements and changes to the general organization of the whole program.
Not much changes in usage or hopefully not much breaking of old functionality. :-)

Biggest ones are (WIP):

NEW:

ALIASES can now be used in Macros and Rebinds (still only one Key_Event allowed) :-D

• <*name of alias*>
• Aliases are active for all Focus Groups
• Maybe will come to each focus group separately so you can have the same aliases with different key groups for each focus group
• mainly intended for Macro trigger_group and key_groups, but can be used in trigger_group of Rebinds (will not work in replacement keys :-) )

NAMING for Tap_Groups, Rebinds and Macros

• Macro Sequences can be reset by using there name as a Constraint (will evaluate to True)
  • e.g. ke|(crouch_macro) will reset the Macro Sequence with this name
  • this will always eval to True, so if you do not want this key to be played just add |(False) after
• for all else mostly just for better overview
• will be shown in CLI

Refactor into different files for better overview and easier changes in future.

Evaluation of Constraints of a Trigger Group

• Eval of Constraints will only start if all key_events are fulfilled
  • e.g. ´-c, +ctrl|(False), +space|(constraint2)´ :
    • 1. -c checked, 2. +ctrl checked, 3. +space checked ... if all True then constraints will be checked
    • 4. constraint (False) will always be False and 5. constraint2 will never be checked
• Eval of Constraints will abort as soon as one (starting from the first ke) will result in False

Eval of Key Groups Constraints

• in Macros will always take place at the start of the playback instead at the time of the key_event being played as before - so everything will be evaluated AT THE SAME TIME with the same internal state of pressed and released keys.
  • lead to changed internal state when run and not deterministic behavior if other action where taken
  • or the macro itself changed the state

New or changed evaluations:

• ap("key_string") : all press (checks if key is pressed for real AND simulated keys)
  • a("key_string") and P("key_string") only check for real key press or release
• ar("key_string") : all release (same just for releases)
• stop_all_repeat() : will stop every active repeat; eval to False
• reset_timer() changed to reset_repeat() ; eval to True

Press state of all keys will be reset on esc or alt+tab

• to make it easier for menu navigation in game and to hopefully not get stuck keys outside of the game any more

Simulated keys that contradict real key presses will now always be suppressed except for tap_groups

• e.g. holding shift can now no longer be released by shift release of a macro or rebind (simulated key)

Option 0 of the CLI menu is much more verbose and helpful now

Bugfixes:

• Edited: BUG: currently not possible to run the program without a \<focus> group #59 fixed - can be run again without any focus group in config
• Edited: BUG: comments in \<focus> lines will not be stripped #60 fixed - focus group names will now be also stripped of comments and white spaces removed before and after

For details on smaller changes see WIP release notes after the example.

So here an example of my usage right now. :-D

#<arg>-debug
#<arg>-crossover=15
#<arg>-tapdelay=6,4
#<arg>-aliasdelay=6,4
<arg>-nomenu
#<arg>-nocontrols
<arg>-nodelay
<arg>-status_indicator=15

# Tap Groups
a, d
w, s

#----------------------------------------
### Horizon Forbidden West
<focus>   Horizon

<arg>-tapdelay=6,4
<arg>-aliasdelay=50,50          # shorter delays lead to missed keys in game
<arg>-nomenu
<arg>-crosshair

# Aliases
<run_if_not> -shift|(ar('shift'))
<alias_in_alias> <run_if_not>, +ctrl|75|(ap('-ctrl')), -ctrl|150, +c|75|(ap('-c')), +ctrl, -shift

# Rebinds
(autospring_toggle) caps_lock : ^shift                     # naming possible for tap_groups, rebinds and macros
(autosprint_on_dc) +shift|(dc()<900) : +suppress           # but only has added functionality of reset for macro sequences
(focus_toggle) p: ^alt                                     # see also macro (stop_shift_on_menu_and_map_reset)

(esc_repeat_stop) -esc : -esc|(stop_all_repeat())          # easy way to stop ALL repeating keys still active

# example for reapting key `v`, reset repeat on manual v press and stop when holding v key for at least 500 ms
(repeat_scan) +v|(tr("+v")>500) :: +v, v|(stop_repeat())
(repeat_scan) u : v|(toggle_repeat(6500))    # stop also possible just by hitting again
(repeat_scan) v : v|(reset_repeat())


# Macros
(aiming) -left_mouse, -right_mouse :: -left_mouse|900, -alt|(p("right_mouse"))
(aiming_mod1) +left_mouse, -right_mouse :: +left_mouse, +alt, -reset_0
(aiming_mod2) +right_mouse, -left_mouse :: +left_mouse|50|(last('-ml')>800), +right_mouse, +alt, -reset_0

(crouch) -c :: <run_if_not>, +c|100|(ap('-c')), -c|100, +c, -shift             # example of alias usage
(crouch_mod) +c : +suppress

(evade_1) -mouse_x2|(dc('mx2')<1000) :: <alias_in_alias>        # example of alias usage: dc() -> double click (on same key it is like last key press)
(evade_2) -mouse_x2|(dc('mx2')>1000) :: <run_if_not>, +c|75|(ap('-c')), -c|150, +ctrl|75|(ap('-ctrl')), +c    # example of alias usage

(heavy_attack) -mouse_x1 :: -g|50, +shift|50, -shift|50, +g 
(heavy_attack_mod) +mouse_x1 : +suppress

(special_ability) i :: -f|50, space|50, +f

(map_open_close) -m :: m          # the only macro sequence in this example
		     : esc
(map_open_close_mod) +m : +suppress

(stop_shift_on_menu_and_map_reset) -tab :: +shift|100, -tab|(map_open_close)      # <- new reset option based on (names)

(interact_shift_mod) +e|(tr("+e")>500) :: +e, +shift
(interact_shift_mod) +e|(dc() < 1000) :: +e, -shift

# evade macro sequence as example 
# see the usage of reset after long delays to reset them automatically before next
# sequence interrupts the reset if pressed in time
# first crouch slide and then 3 evades (with shorter reset times) instead of crouch slide
#-mouse_x2 :: -shift|200|(ar('shift')),  +c|75|(ap('-c')),        c   |50,  #c   |50, +ctrl|(1000-last('-mx2')), -reset  
#           : -shift|(ar('shift')),  +ctrl|75|(ap('-ctrl')),  ctrl|50,  #ctrl|50, +c|450,  -reset
#           : -shift|(ar('shift')),  +ctrl|75|(ap('-ctrl')),  ctrl|50,  #ctrl|50, +c|450,  -reset
#           : -shift|(ar('shift')),  +ctrl|75|(ap('-ctrl')),  ctrl|50,  #ctrl|50, +c|450,  -reset 


### Pls report or comment in discussion of the release on what is not working or what you would have expected to work differently

Preliminary Release Notes V1.1 (WIP - some of it is not up to date yet):

trigger_groups:

-trigger_groups can now be distinguished also via constraints - not only by the key_events in the trigger_group

• -mouse_x2|(dc('mx2')<1000) and -mouse_x2|(dc('mx2')>1000) are now recognized as 2 different trigger for rebind or macros and the second will no longer overwrite the first one

• reset can now also be used in a trigger_group to reset the macro sequence on trigger activation

  • combined with constraints it can now work to flexibly reset a macro sequence
  • e.g. -c, +reset|(dc('c')>1000):: ... (dc = double click to get the time since last press, when using it with the same key; last() should be used when using it with another key)
  • use always+reset because it is handled like a key event and must be fulfilled (in this case must be released which is for all reset keys always True) before the constraints will be checked
  • only if the constraints all result in True will the reset activated

rebinds

• reset key_events that reset macro sequences now also work in rebinds as replacement key

macro/ macro sequences:

• the constraint check of a played group (rebind or macro) (not trigger group) will be all checked at the same time now.

  • before it was always checked at the exact time of playback and could be way later than the original start of the macro due to before applied delays - this lead to some very strange behavior when using time evaluations because they could be updated while the macro was still running
  • now it has consistent behavior

• removed toggle option from played macro groups

  • (maybe unnecessary????)
  • I want to rework that because the key states tracking now allows a better solution for this

repeat keys

• stop_repeat will now again evaluate to False to suppress the playback of the stopped keys

general behavior

• all key states (press or release) are now tracked - real keys states as well as simulated key states

  • can now be used in invocations as ap('key_string') (all keys press) and ar('key_string') (all keys release)
  • with this now also the simulated key states can be used to create more complex macros/rebinds

• simulated key events that would release real key presses are now suppressed with the exception of the keys defined in the tap groups to allow the snap tap behavior.

GUI

• status indicator now has the option on doubleClick or middleClick to open the config file like in the contextmenu - just to get to it easier
• crosshair now will redraw itself if left clicked on it (hard to hit :-D )
• crosshair now waits 1 extra second after switching focus groups due to window changes to make it more likely to recognize the right window and its size better

On window change:

• all currently pressed simulated keys will be released on window change
  • dependent on rebinds or macros it was possible to get stuck keys until the real key was pressed again to release the key state
  • will ignore currently pressed real keys and not release these
• esc now also releases all not currently pressed simulated keys
  • even if manually paused
• alt+tab will now also try to release all currently pressed simulated keys

internal

• renamed everything with delay as constraint to better fit the evolved functionality
• separated execute_key_event into its functional parts to realize more flexible reset and constraint handling

refactoring

• refactoring of all global mutable states
• creation of manager classes to handle different aspects of the functionalities
• class FST_keyboard binds it all together and offers access to the managers

bugfix:

• the reset key_event did not work before (reset_0 to reset_30 and reset_all did work)
  • reset will now reset the macro sequence it was started from/in
• fix focus lines comments not being stripped
  • fixed and upgraded to also stripping leading or trailing white spaces
• reset of toggle via real key is working again
• not working when using no focus name
• toggle key is broken - fixed ... broken AGAIN ... - fixed

--- alias updates (WIP)

• stop_all_repeat() eval (useful on esc ingame to stop them all when in menu)
  • eval to True
• aliases
• names and
• resets for sequences with names and ke|(name)
  • eval to True
• eval of constraints will abort following constraints if one results in False

???:
-should every invocation or reset as invocation result in True?

• can always be stopped from sending by following up with a False eval .. e.g. |(False)
• (start_repeat()), (toggle_repeat()) MUST eval to False, because a Repeat_thread takes constraints[1:] with it into the repeat ...
  • so v|(start_repeat)|(False) would try to repeat v|(False) and never send anything - learning by trial xD
• and (stop_repeat()) eval to False - because is needs to be used with the same ke to be stopped and when you want to stop something you do not want to execute it first again ...

Idea and TODO:

• lots of doc_string missing
• use aliases for repeat input: e.g. ke|toggle_repeat('<repeat_scan>')
  • would be no longer dependent on actual ke and way more flexible and easy to use
• reset press state before releasing all keys to prevent suppression because of contradiction a real key state

---

This discussion was created from the release V1.1.0 Aliases, Naming of lines, a lot of internal Refactoring.