Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jarusll/keydogger
Keydogger is a tiny text expander written in C
https://github.com/jarusll/keydogger
linux macro wayland
Last synced: 2 days ago
JSON representation
Keydogger is a tiny text expander written in C
- Host: GitHub
- URL: https://github.com/jarusll/keydogger
- Owner: jarusll
- License: mit
- Created: 2024-03-11T13:19:40.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-07T13:48:15.000Z (4 months ago)
- Last Synced: 2024-08-01T21:40:33.479Z (3 months ago)
- Topics: linux, macro, wayland
- Language: C
- Homepage:
- Size: 663 KB
- Stars: 114
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - jarusll/keydogger - Keydogger is a tiny text expander written in C (C)
README
# Keydogger
*Keylogger but funnier*
> Keydogger is a tiny text expander written in C
> [!WARNING]
> This is a privileged application. Hence it NEEDS sudo privileges. I have tried to keep the codebase small to reduce the footprint
## Prerequisites
- `wl-clipboard`
- `gcc`
- `make`
```bash
git clone https://github.com/jarusll/keydogger.git
cd keydogger
```
## Configuration
Set the environment `KEYDOGGER_KEYBOARD` as the path to your keyboard device.
It should be of the pattern `/dev/input/eventX`. X will be different for your system. You can use `evtest` to find out your keyboard device path.
## Installation
To install, run the following as sudo
```bash
make clean install
```
## Testing
You can test out sample expansions from the local `keydoggerrc` file by
```bash
make clean build
sudo ./keydogger debug
```
## Usage
### Configuring expansions
Set trigger and expansion values in `~/keydoggerrc`. Expansion definitions follow the format `trigger=expansion`.
Here are some sample expansions you might like
```
@hello=Hello, World!
@program=Keydogger
:love:=❤️
@gg=Good game folks, see you tomorrow
@@[email protected]
:ai=explain in short and simple terms
@install=sudo package-manager install -y
@update=sudo package-manager update -y
@restart=sudo keydogger stop && sudo keydogger start
@backup=rsync -avz ~/important_files/ jarusll@homeserver:backups/
```
### Commands
```bash
# -E flag to preseve env variables if you've already set KEYDOGGER_KEYBOARD
sudo -E keydogger start
# Here's another way to pass env variables
sudo env KEYDOGGER_KEYBOARD=/dev/input/event keydogger status
sudo keydogger status
sudo keydogger stop
# Restart if you want to switch keyboards or reload expansions
sudo -E keydogger restart
```
## TODO
### v1
- [x] Daemonize it
- [x] Use `/dev/uinput` to emit events
- [x] Read trigger & expansions from `.keydoggerrc`
### v2
- [x] Unicode support
### v2.1
- [x] feat: Keyboard path as environment Variable `KEYDOGGER_KEYBOARD`
### 2.2
- [x] fix: Send keyup for all trigger keys to fix keypresses for characters common in trigger & expansion
## Acknowledgements
- [emisilve86](https://github.com/emisilve86/Keylogger-Daemon-Linux) for their code
- [Espanso](https://github.com/federico-terzi/espanso) for the `1000` microseconds of delay between events
- [ydotool](https://github.com/ReimuNotMoe/ydotool) for direct mapping of `character code` to `Linux key code`
## Contributing
Patches are preffered over PR because this is a mirror of my personal git server.