hotcuts/README.md

# hotcuts

![GitHub](https://img.shields.io/github/license/MatMasIt/hotcuts)

Transform an input device into a shortcut board. for example, a second keyboard with pictures on keys

## How does it work?

A main daemon (`hotcutdaemon.py`) running as root intercepts a keyboard device through its device file, acquiring a lock on it and preventing it from sending inputs to the X server.

The key presses trigger commands  as specified in the `config.ini` file

## Setup

1. Locate the device file and edit `config.ini` by setting the device path and your shortcuts.
2.  Determine your keyboards serial id (you may use,`sudo udevadm info -a -n {DEVICE_FILE}`) edit `udev/99-keyboard-shortcuts.rules` with it, while setting `OWNER={Your username}` and add said file to `/etc/udev/rules.d` to tell udev to allow your user to access the device file; restart udev with `sudo udevadm trigger`
3. chmod +x `hotcutdaemon.py` with your user
4. add `hotcutdaemon.py` to a crontab (or to your i3/wm config file) for automatic execution
Initial commit 2021-08-29 00:05:00 +02:00			`# hotcuts`
Added license badge 2021-10-18 09:45:17 +02:00
			`![GitHub](https://img.shields.io/github/license/MatMasIt/hotcuts)`

Update README.md 2021-08-29 00:27:05 +02:00			`Transform an input device into a shortcut board. for example, a second keyboard with pictures on keys`
Update README.md 2021-08-29 00:14:55 +02:00
Fixed headers 2021-08-29 00:15:11 +02:00			`## How does it work?`
Update README.md 2021-08-29 00:14:55 +02:00
Update README.md 2021-08-30 00:30:24 +02:00			A main daemon (`hotcutdaemon.py`) running as root intercepts a keyboard device through its device file, acquiring a lock on it and preventing it from sending inputs to the X server.
Update README.md 2021-08-29 00:14:55 +02:00
Update README.md 2021-08-30 00:30:24 +02:00			The key presses trigger commands as specified in the `config.ini` file
Update README.md 2021-08-29 00:14:55 +02:00
Update README.md 2021-08-30 00:30:24 +02:00			`## Setup`
Update README.md 2021-08-29 00:14:55 +02:00
Update README.md 2021-08-30 00:30:24 +02:00			1. Locate the device file and edit `config.ini` by setting the device path and your shortcuts.
			2. Determine your keyboards serial id (you may use,`sudo udevadm info -a -n {DEVICE_FILE}`) edit `udev/99-keyboard-shortcuts.rules` with it, while setting `OWNER={Your username}` and add said file to `/etc/udev/rules.d` to tell udev to allow your user to access the device file; restart udev with `sudo udevadm trigger`
			3. chmod +x `hotcutdaemon.py` with your user
			4. add `hotcutdaemon.py` to a crontab (or to your i3/wm config file) for automatic execution