# simple-keyboard-remapper

**Repository Path**: wallacegibbon/simple-keyboard-remapper

## Basic Information

- **Project Name**: simple-keyboard-remapper
- **Description**: Low level keyboard remapper that support dual action on press and release.
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-03-05
- **Last Updated**: 2026-01-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Simple Keyboard Remapper

On Linux, this program creates a new virtual keyboard device with
[uinput][uinput].  It grabs input from the physical keyboard and pipe events
to that virtual device.

The code is ready to be ported to other systems.


## Installation

If you only have one keyboard, the installation should be simple.

To build, install, enable and start the service:

```shell
sudo make install
```

If you have more than one keyboards, this program may not find the right
device, then you need to change the systemd file to fix that.

To stop, remove the service and uninstall the program:

```shell
sudo make uninstall
```


## Debug

We can see event printing when this project is built with DEBUG enabled:
```shell
make DEBUG=1
```

After installation, we can read the log with this command:

```shell
journalctl -u simple-keyboard-remapper -f
```

Or: (In the project path)

```shell
make showlog
```

To find out the event file that our keyboard is bound to:
```sh
cat /proc/bus/input/devices | grep -i keyboard -B1 -A4
```


## History

This project was modified from [Janus Key][janus-key].

The `libevdev` dependency is removed, we use `uinput` directly.

[uinput]: https://www.kernel.org/doc/html/v4.12/input/uinput.html
[janus-key]: https://github.com/pietroiusti/janus-key