Skip to content

README.md

Latest commit

 

History

History
64 lines (42 loc) · 3.51 KB

README.md

File metadata and controls

64 lines (42 loc) · 3.51 KB
Raw

KeyboardManager

A lightweight C++ Windows keyboard manager utilizing Dear ImGui, miniaudio, and the Raw Input API for passive custom binds, soundboarding, and background media control.

Safety model

  • Physical keyboard input is observed through Raw Input and is never blocked or rewritten.
  • Action failures are logged and do not disable native keyboard input.
  • Configuration is replaced atomically and invalid JSON is preserved before defaults are used.
  • KeyboardManager does not inspect, inject into, or modify game processes. No software can guarantee acceptance by every anti-cheat product, so compatibility should be verified with each target game.

Features

  • Passive global input through RegisterRawInputDevices; input is never blocked or rewritten.
  • Full-size, TKL, and 60% physical layouts with labels resolved from the active Windows keyboard language.
  • Physical scan-code binds, including distinct E0/E1 extended keys and exact Ctrl/Shift/Alt/Win combinations.
  • Hover summaries for assigned keys, grouped by modifier chord and action chain.
  • Chained sound, file-launch, and media-key actions with initial-KeyDown debouncing.
  • Profile persistence, output-device routing, master volume, tray operation, and a global Ctrl+Alt+P kill switch.
  • Silent recovery from missing action targets. Diagnostics are written to %LOCALAPPDATA%\KeyboardManager\KeyboardManager.log.

Configuration is stored atomically at %LOCALAPPDATA%\KeyboardManager\config.json. Audio files placed in the Sounds directory can be assigned from the bind editor. Rescanning sounds also reloads decoded audio, so replacing a file with a new version under the same name takes effect immediately.

Release installers create an empty user-managed Sounds directory. Personal or third-party audio files are not bundled with public releases.

Build

Requirements: Windows 10 or newer, Visual Studio 2022 with the C++ desktop workload, CMake 3.24+, Git, and an x64 generator.

cmake -S . -B build -A x64
cmake --build build --config Release

CMake fetches pinned Dear ImGui, miniaudio, and nlohmann/json revisions. The release executable is build\Release\KeyboardManager.exe and uses the static MSVC runtime.

Tests

Configuration persistence, validation, and recovery are covered by CTest. The GitHub Actions workflow builds the complete application and runs the tests with Visual Studio 2022 on Windows.

cmake -S . -B build -A x64 -DBUILD_TESTING=ON
cmake --build build --config Release
ctest --test-dir build -C Release --output-on-failure

Installer

After a Release build, compile installer\KeyboardManager.iss with Inno Setup 6. The installer is emitted under dist, creates optional desktop and Start Menu shortcuts, and asks a running tray instance to shut down before an install or update replaces files.

To package a Release artifact from a different build directory, override BuildOutputDir:

ISCC.exe /DBuildOutputDir=..\build-mingw installer\KeyboardManager.iss

Contributing and security

See CONTRIBUTING.md for the development workflow. Report suspected vulnerabilities privately according to SECURITY.md.

Design documents cover the planned virtual microphone, driver signing, and extensible action architecture.

License

KeyboardManager is available under the MIT License. Third-party license notices are listed in THIRD_PARTY_NOTICES.md.