inpmap 0.2.0__tar.gz

inpmap-0.2.0/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to InpMap. Versions follow [semantic versioning](https://semver.org/);
+before 1.0, minor versions may change the configuration language (the
+`version` line in configuration files guards against incompatible changes).
+
+## 0.2.0 (first public release)
+
+InpMap is a configuration-driven input remapper for Linux: one key or
+button can drive keys, buttons and sticks on several virtual devices at
+once.
+
+- **Configuration language** (`.inpmap` files, version 1), with errors
+  reported as `FILE:LINE:COLUMN` before any device is touched.
+- **Virtual keyboard and gamepad** outputs (buttons, D-pad, sticks,
+  triggers); unmapped input passes through unchanged; LEDs keep working;
+  devices that are unplugged are picked up again.
+- **Mappings:** hold, tap, chords, sequences with waits and random waits,
+  loops, autofire, toggles, parallel branches, stick movements with ramps,
+  variables, conditions (tap vs. hold, double tap, long press, "pressed
+  alone", lock LEDs), modifiers (`modifiers(ctrl, shift)`), mappings for one
+  device or for every input, `disable`.
+- **Sticks, analog triggers and the D-pad as triggers**
+  (`map pad.ABS_RZ above 0.5`), including two-stage triggers.
+- **Layers** (`layer NAME { … }`, `hold layer`, `layer NAME toggle`) and
+  **reusable blocks** (`block` / `call`).
+- **Profiles** in `~/.config/inpmap/`; a systemd **user service**
+  (`inpmap@NAME`); an **emergency stop** (Backspace + Escape + Enter).
+- **Tools:** `input-config` (pick devices, also by pressing a key; starts
+  from the built-in example for the profile `example`), `detect` (presses
+  shown as triggers), `axes`, `codes`, `check`, `macro-trace`, `fmt`,
+  `devices`, `udev-rules`, `service-unit`, `syntax-file`, `test-outputs`.
+
+Tested on CachyOS with KDE Plasma (Wayland); other distributions and
+desktops are not tested yet.

inpmap-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 unoctanium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

inpmap-0.2.0/MANIFEST.in

@@ -0,0 +1,5 @@
+# The source distribution: everything needed to build, read and test InpMap.
+include CHANGELOG.md
+recursive-include docs configuration.md installation.md usage.md development.md roadmap.md manual-tests.md
+recursive-include tests *.py *.inpmap
+include tools/gen_codes.py

inpmap-0.2.0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: inpmap
+Version: 0.2.0
+Summary: Configuration-driven input remapper (own configuration language, multiple virtual output devices)
+Author: unoctanium
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/unoctanium/InpMap
+Project-URL: Documentation, https://github.com/unoctanium/InpMap/blob/main/docs/usage.md
+Project-URL: Changelog, https://github.com/unoctanium/InpMap/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/unoctanium/InpMap/issues
+Keywords: input,remapper,keyboard,gamepad,evdev,uinput,macros,linux
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: System :: Hardware
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lark<2,>=1.2
+Requires-Dist: evdev; sys_platform == "linux"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# InpMap
+
+[![CI](https://github.com/unoctanium/InpMap/actions/workflows/ci.yml/badge.svg)](https://github.com/unoctanium/InpMap/actions/workflows/ci.yml)
+
+InpMap is an input remapper for Linux. It takes over your physical keyboard
+or gamepad and turns its keys and buttons into whatever you describe in a
+small configuration file: other keys, gamepad buttons, stick movements, or
+whole timed sequences ("macros"). One key can act on **several virtual
+devices at once**, for example press a keyboard key and a gamepad button
+together.
+
+```inpmap
+version 1
+input kbd { path = "/dev/input/by-id/usb-4348_2.4G_Dongle-event-kbd" }
+output keyboard { type = keyboard }
+output gamepad { type = gamepad }
+
+map KEY_X {  # X = keyboard Y + gamepad A
+    hold KEY_Y
+    hold BTN_SOUTH
+}
+
+map KEY_F10 {  # tap, double tap, long press
+    on tap { tap KEY_1 }
+    on double_tap { tap KEY_2 }
+    on long_press { tap KEY_3 }
+}
+
+map KEY_CAPSLOCK {  # Caps Lock alone = Esc, with another key = Ctrl
+    if single { tap KEY_ESC } else { hold KEY_LEFTCTRL }
+}
+```
+
+## Why InpMap?
+
+[Input Remapper](https://github.com/sezanzeb/input-remapper) is the
+established remapper for Linux and served as the functional reference.
+InpMap was started for needs it covers less well:
+
+- **Several virtual output devices per mapping.** A key can drive a
+  virtual keyboard and a virtual gamepad (or two gamepads) at the same time
+  — e.g. for games that expect a gamepad.
+- **Configuration as a readable text file** instead of a GUI: easy to write
+  in any editor, to compare, to keep in git and to copy to other PCs.
+  Errors are reported with file, line and column before any device is
+  touched.
+- **Predictable behaviour**: exact rules for modifiers (Shift+A stays a
+  capital A unless you map it), reference-counted outputs, and a guarantee
+  that no key is ever left stuck — on release, on errors, on unplugging and
+  on shutdown.
+- **A portable core.** The mapping engine is independent of Linux; a
+  Windows version is planned.
+
+## Features
+
+- Keyboard keys and gamepad buttons as triggers, optionally with modifiers
+  (`modifiers(ctrl, shift)`), from any number of physical devices. A
+  mapping applies to every configured device that has the key, or to one
+  device only (`pad.BTN_EAST`). Keys can be disabled.
+- Sticks, analog triggers and the D-pad as buttons (`map pad.ABS_RZ above
+  0.5`), also two-stage triggers; `inpmap axes` shows their live values.
+- Virtual keyboards and gamepads (buttons, D-pad, sticks, triggers).
+- Hold, tap, chords (`ctrl + KEY_C`), sequences with waits and random
+  waits, loops, autofire, toggles, parallel branches, stick movements with
+  ramps.
+- Conditions: tap vs. hold, double tap, long press, "pressed alone",
+  Caps/Num/Scroll Lock state, variables.
+- Layers: groups of mappings switched on while a key is held or toggled,
+  e.g. Caps Lock + WASD as arrow keys, or a flight-sim layer on the gamepad.
+- Reusable blocks: write a sequence once (`block close_dialog { … }`) and
+  `call` it from several mappings.
+- Unmapped keys pass through unchanged; LEDs keep working; devices that
+  are unplugged and plugged in again are picked up automatically.
+- `inpmap input-config` finds your devices for you: press a key on the
+  keyboard or gamepad you want, and it is added to the configuration.
+- `inpmap fmt` lays out configuration files consistently, without ever
+  changing what they mean.
+- `inpmap macro-trace` shows the exact timeline of a mapping without
+  touching any device.
+- Runs in the foreground or as a systemd user service that starts at
+  login. Profiles (e.g. one per game) are switched with `systemctl --user`.
+  Holding Backspace + Escape + Enter always stops it (emergency stop).
+
+Not yet: mouse output, a GUI, Windows, a system-wide service.
+
+## Documentation
+
+| Document | Contents |
+|---|---|
+| [docs/installation.md](https://github.com/unoctanium/InpMap/blob/main/docs/installation.md) | requirements, installation, device permissions, user service, uninstall |
+| [docs/usage.md](https://github.com/unoctanium/InpMap/blob/main/docs/usage.md) | first configuration step by step, all commands and options, troubleshooting |
+| [docs/configuration.md](https://github.com/unoctanium/InpMap/blob/main/docs/configuration.md) | **reference** of the configuration language: every feature with examples |
+| [docs/development.md](https://github.com/unoctanium/InpMap/blob/main/docs/development.md) | for contributors: tests, architecture, releases |
+| [docs/roadmap.md](https://github.com/unoctanium/InpMap/blob/main/docs/roadmap.md) | goals, requirements, milestones and what comes next |
+| [CHANGELOG.md](https://github.com/unoctanium/InpMap/blob/main/CHANGELOG.md) | changes per version |
+
+## Quick start
+
+```sh
+sudo pacman -S --needed python python-evdev python-pipx   # Arch; other distributions: see installation.md
+pipx install --system-site-packages inpmap
+
+inpmap input-config example          # the example with your keyboard (press i, then a key)
+inpmap run example --timeout 60      # try F1-F8, Caps Lock, Insert
+inpmap input-config                  # your own profile: ~/.config/inpmap/default.inpmap
+inpmap detect                        # press keys: see how to write them in a mapping
+```
+
+Device permissions may be needed first: see
+[installation.md §3](https://github.com/unoctanium/InpMap/blob/main/docs/installation.md#3-device-permissions).
+To work on InpMap itself, install it from the source code
+([installation.md §2b](https://github.com/unoctanium/InpMap/blob/main/docs/installation.md#2b-from-the-source-code-for-development)).
+
+## Status
+
+Version 0.2, Linux only. Verified on CachyOS / KDE Plasma (Wayland) with a
+real keyboard and gamepad: remapping, suppression of the original keys,
+passthrough, macros, modifiers, axes as triggers, the configuration
+language and the user service. Later: Windows, then GUIs.
+
+## License
+
+MIT, see [LICENSE](https://github.com/unoctanium/InpMap/blob/main/LICENSE). Input Remapper (GPL-3.0) served as a
+functional reference only; InpMap contains no code from it.

inpmap-0.2.0/README.md

@@ -0,0 +1,124 @@
+# InpMap
+
+[![CI](https://github.com/unoctanium/InpMap/actions/workflows/ci.yml/badge.svg)](https://github.com/unoctanium/InpMap/actions/workflows/ci.yml)
+
+InpMap is an input remapper for Linux. It takes over your physical keyboard
+or gamepad and turns its keys and buttons into whatever you describe in a
+small configuration file: other keys, gamepad buttons, stick movements, or
+whole timed sequences ("macros"). One key can act on **several virtual
+devices at once**, for example press a keyboard key and a gamepad button
+together.
+
+```inpmap
+version 1
+input kbd { path = "/dev/input/by-id/usb-4348_2.4G_Dongle-event-kbd" }
+output keyboard { type = keyboard }
+output gamepad { type = gamepad }
+
+map KEY_X {  # X = keyboard Y + gamepad A
+    hold KEY_Y
+    hold BTN_SOUTH
+}
+
+map KEY_F10 {  # tap, double tap, long press
+    on tap { tap KEY_1 }
+    on double_tap { tap KEY_2 }
+    on long_press { tap KEY_3 }
+}
+
+map KEY_CAPSLOCK {  # Caps Lock alone = Esc, with another key = Ctrl
+    if single { tap KEY_ESC } else { hold KEY_LEFTCTRL }
+}
+```
+
+## Why InpMap?
+
+[Input Remapper](https://github.com/sezanzeb/input-remapper) is the
+established remapper for Linux and served as the functional reference.
+InpMap was started for needs it covers less well:
+
+- **Several virtual output devices per mapping.** A key can drive a
+  virtual keyboard and a virtual gamepad (or two gamepads) at the same time
+  — e.g. for games that expect a gamepad.
+- **Configuration as a readable text file** instead of a GUI: easy to write
+  in any editor, to compare, to keep in git and to copy to other PCs.
+  Errors are reported with file, line and column before any device is
+  touched.
+- **Predictable behaviour**: exact rules for modifiers (Shift+A stays a
+  capital A unless you map it), reference-counted outputs, and a guarantee
+  that no key is ever left stuck — on release, on errors, on unplugging and
+  on shutdown.
+- **A portable core.** The mapping engine is independent of Linux; a
+  Windows version is planned.
+
+## Features
+
+- Keyboard keys and gamepad buttons as triggers, optionally with modifiers
+  (`modifiers(ctrl, shift)`), from any number of physical devices. A
+  mapping applies to every configured device that has the key, or to one
+  device only (`pad.BTN_EAST`). Keys can be disabled.
+- Sticks, analog triggers and the D-pad as buttons (`map pad.ABS_RZ above
+  0.5`), also two-stage triggers; `inpmap axes` shows their live values.
+- Virtual keyboards and gamepads (buttons, D-pad, sticks, triggers).
+- Hold, tap, chords (`ctrl + KEY_C`), sequences with waits and random
+  waits, loops, autofire, toggles, parallel branches, stick movements with
+  ramps.
+- Conditions: tap vs. hold, double tap, long press, "pressed alone",
+  Caps/Num/Scroll Lock state, variables.
+- Layers: groups of mappings switched on while a key is held or toggled,
+  e.g. Caps Lock + WASD as arrow keys, or a flight-sim layer on the gamepad.
+- Reusable blocks: write a sequence once (`block close_dialog { … }`) and
+  `call` it from several mappings.
+- Unmapped keys pass through unchanged; LEDs keep working; devices that
+  are unplugged and plugged in again are picked up automatically.
+- `inpmap input-config` finds your devices for you: press a key on the
+  keyboard or gamepad you want, and it is added to the configuration.
+- `inpmap fmt` lays out configuration files consistently, without ever
+  changing what they mean.
+- `inpmap macro-trace` shows the exact timeline of a mapping without
+  touching any device.
+- Runs in the foreground or as a systemd user service that starts at
+  login. Profiles (e.g. one per game) are switched with `systemctl --user`.
+  Holding Backspace + Escape + Enter always stops it (emergency stop).
+
+Not yet: mouse output, a GUI, Windows, a system-wide service.
+
+## Documentation
+
+| Document | Contents |
+|---|---|
+| [docs/installation.md](https://github.com/unoctanium/InpMap/blob/main/docs/installation.md) | requirements, installation, device permissions, user service, uninstall |
+| [docs/usage.md](https://github.com/unoctanium/InpMap/blob/main/docs/usage.md) | first configuration step by step, all commands and options, troubleshooting |
+| [docs/configuration.md](https://github.com/unoctanium/InpMap/blob/main/docs/configuration.md) | **reference** of the configuration language: every feature with examples |
+| [docs/development.md](https://github.com/unoctanium/InpMap/blob/main/docs/development.md) | for contributors: tests, architecture, releases |
+| [docs/roadmap.md](https://github.com/unoctanium/InpMap/blob/main/docs/roadmap.md) | goals, requirements, milestones and what comes next |
+| [CHANGELOG.md](https://github.com/unoctanium/InpMap/blob/main/CHANGELOG.md) | changes per version |
+
+## Quick start
+
+```sh
+sudo pacman -S --needed python python-evdev python-pipx   # Arch; other distributions: see installation.md
+pipx install --system-site-packages inpmap
+
+inpmap input-config example          # the example with your keyboard (press i, then a key)
+inpmap run example --timeout 60      # try F1-F8, Caps Lock, Insert
+inpmap input-config                  # your own profile: ~/.config/inpmap/default.inpmap
+inpmap detect                        # press keys: see how to write them in a mapping
+```
+
+Device permissions may be needed first: see
+[installation.md §3](https://github.com/unoctanium/InpMap/blob/main/docs/installation.md#3-device-permissions).
+To work on InpMap itself, install it from the source code
+([installation.md §2b](https://github.com/unoctanium/InpMap/blob/main/docs/installation.md#2b-from-the-source-code-for-development)).
+
+## Status
+
+Version 0.2, Linux only. Verified on CachyOS / KDE Plasma (Wayland) with a
+real keyboard and gamepad: remapping, suppression of the original keys,
+passthrough, macros, modifiers, axes as triggers, the configuration
+language and the user service. Later: Windows, then GUIs.
+
+## License
+
+MIT, see [LICENSE](https://github.com/unoctanium/InpMap/blob/main/LICENSE). Input Remapper (GPL-3.0) served as a
+functional reference only; InpMap contains no code from it.