Simple Hotkeys

A bare bones copy of AutoHotkey for Hyprland.

Installation

Install simple-hotkeys with cargo, make sure ~/.cargo/bin is in the path and you are in the input group. If you just added yourself to the input group make sure to logout and sign back in.

  export PATH=$PATH:/home/$USER/.cargo/bin  # Add to path
  sudo usermod -aG input $USER              # Join the input group

  cargo install simple-hotkeys

Usage

Usage: simple-hotkeys [OPTIONS]... FILE_PATH
Run a simple hotkey script

Options:
    -d, --debug         Turn on debug mode
    -h, --help          Display this message

Documentation

Each line is split into 3 parts <operation> <action> [modifier]

Operations

• on - Defines the trigger event for the script
• event - Defines an event to send
• sleep - Defines a delay between events

Actions

For the on and event operations

• key:code - Sends a key event with a certain code, see Key Codes
• mouse:code - Sends a mouse event with a certain code, see Mouse Codes

For the sleep operation

• duration - How long to sleep for in ms

Modifiers

For the on operation

• once | repeat - Should the script repeat if the trigger is still pressed, Default: once

For the event operation

• press | release | click - The direction of the event, Default: click

Examples

# example.shk
on mouse:1 repeat

sleep 1000
event key:c down
sleep 500
event key:o
event key:o
event key:l
event key:c up
sleep 30
event mouse:2

This script waits until mouse 1 is pressed and will then wait a second before pressing 'c', waiting half a second, then typing 'ool' and releasing 'c', then waiting 30 ms and then right clicking. It will repeat if the mouse 1 button is still down.

Codes

Key Codes

The list of events is less complete than the trigger codes. Keys that are unsupported for the events will be marked with an *. There may (are) some inconsistencies with this list to the actual values, for the true list see src/parser.rs and look for the parse_xxx_key_string functions. All patterns are case insensitive. (Don't ask me what half of these are)

Mouse Codes

For the mouse codes the only option is to put the number corresponding to the button. For example the left mouse button is code 1 so in the .shk file I would put mouse:1.

Support

This has only ever been tested on Arch Linux 6.16.5+ with Hyprland. If you have an issue running on your system then good luck.

Contributing

If you want to contribute please open a pull request or issue.