Welcome to AutoKey for Wayland (and X11, too)!
- Introduction to Autokey for Wayland
- Installing AutoKey for Wayland
- Installing AutoKey For Wayland on Fedora
- Installing AutoKey for Wayland on Debian/Ubuntu
- Manually Installing AutoKey for Wayland from GitHub
- 1) Clone the AutoKey for Wayland repository locally
- 2) Install system prerequisites
- 3) Configure your system to run AutoKey
- 4) Install the AutoKey icons
- 5) Install AutoKey in a Python virtual environment
- 6) Run AutoKey from the virtual environment
- 7) Exiting the virtual environment when you are finished with AutoKey
- 8) Running AutoKey again
- Cleaning up after ourselves
- Getting Started With AutoKey for Wayland
- What Works & What Does Not
- Autokey Scripting API
- clipboard API
- Common API
- dialog API
- engine API
EngineEngine.create_abbreviation()Engine.create_folder()Engine.create_hotkey()Engine.create_phrase()Engine.get_folder()Engine.get_macro_arguments()Engine.get_script_arguments()Engine.get_script_keyword_arguments()Engine.get_triggered_abbreviation()Engine.remove_all_temporary()Engine.run_script()Engine.run_script_from_macro()Engine.run_system_command_from_macro()Engine.set_return_value()
- highLevel API
- keyboard API
- key Constants
KeyKey.LEFTKey.RIGHTKey.UPKey.DOWNKey.BACKSPACEKey.TABKey.ENTERKey.SCROLL_LOCKKey.PRINT_SCREENKey.PAUSEKey.MENUKey.CONTROLKey.ALTKey.ALT_GRKey.SHIFTKey.SUPERKey.HYPERKey.CAPSLOCKKey.NUMLOCKKey.METAKey.LEFTCONTROLKey.LEFTALTKey.LEFTSHIFTKey.LEFTSUPERKey.LEFTHYPERKey.LEFTCAPSLOCKKey.LEFTNUMLOCKKey.LEFTMETAKey.RIGHTCONTROLKey.RIGHTALTKey.RIGHTSHIFTKey.RIGHTSUPERKey.RIGHTHYPERKey.RIGHTCAPSLOCKKey.RIGHTNUMLOCKKey.RIGHTMETAKey.F1Key.F2Key.F3Key.F4Key.F5Key.F6Key.F7Key.F8Key.F9Key.F10Key.F11Key.F12Key.F13Key.F14Key.F15Key.F16Key.F17Key.F18Key.F19Key.F20Key.F21Key.F22Key.F23Key.F24Key.F25Key.F26Key.F27Key.F28Key.F29Key.F30Key.F31Key.F32Key.F33Key.F34Key.F35Key.ESCAPEKey.INSERTKey.DELETEKey.HOMEKey.ENDKey.PAGE_UPKey.PAGE_DOWNKey.NP_INSERTKey.NP_DELETEKey.NP_HOMEKey.NP_ENDKey.NP_PAGE_UPKey.NP_PAGE_DOWNKey.NP_LEFTKey.NP_RIGHTKey.NP_UPKey.NP_DOWNKey.NP_DIVIDEKey.NP_MULTIPLYKey.NP_ADDKey.NP_SUBTRACTKey.NP_5Key.is_key()
- mouse API
MouseMouse.ButtonMouse.click_absolute()Mouse.click_relative()Mouse.click_relative_self()Mouse.get_location()Mouse.get_relative_location()Mouse.move_cursor()Mouse.move_relative()Mouse.move_relative_self()Mouse.press_button()Mouse.release_button()Mouse.scroll_down()Mouse.scroll_up()Mouse.select_area()Mouse.wait_for_click()
- Buttons
- store API
- system API
- window API
- window API implementation for GNOME/Wayland environments
WindowWindow.activate()Window.center_window()Window.close()Window.get_active_class()Window.get_active_geometry()Window.get_active_title()Window.get_window_geometry()Window.get_window_hex()Window.get_window_list()Window.move_to_desktop()Window.resize_move()Window.set_property()Window.switch_desktop()Window.wait_for_exist()Window.wait_for_focus()
- window API implementation for KDE/Wayland environments
WindowWindow.activate()Window.center_window()Window.close()Window.get_active_class()Window.get_active_geometry()Window.get_active_title()Window.get_window_geometry()Window.get_window_hex()Window.get_window_list()Window.move_to_desktop()Window.resize_move()Window.set_property()Window.switch_desktop()Window.wait_for_exist()Window.wait_for_focus()
- window API implementation for X11 environments
WindowWindow.activate()Window.center_window()Window.close()Window.get_active_class()Window.get_active_geometry()Window.get_active_title()Window.get_window_geometry()Window.get_window_hex()Window.get_window_list()Window.move_to_desktop()Window.resize_move()Window.set_property()Window.switch_desktop()Window.wait_for_exist()Window.wait_for_focus()
- window API implementation for GNOME/Wayland environments
- Availability of the AutoKey Scripting API Methods Under X11 and Wayland
- Troubleshoot Problems
- Additional Technical Detail on Wayland, X11, and AutoKey
- Contributing to AutoKey for Wayland
- Sample Scripts