Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 1.26 KB

README.md

File metadata and controls

44 lines (37 loc) · 1.26 KB
Raw

iohook is a global native keyboard and mouse listener for Node.js. This is a fork of https://github.com/wilix-team/iohook, which is abandoned and unmainntained.

We provide a modern CI pipeline for easy, fast, reliable, builds of iohook for modern versions of Node and Electron. At Robolab, we use this library in MechaKeys, the integrated typing environment.

Supported Versions

  • Versions >= 0.9.4 support Electron 25 and Node 18
  • For older version support, use the wilix-team library

Installation

# Install MechaKeys iohook
npm install --save @mechakeys/iohook
# Install prebuilt binaries for your platform, architecture, and ABIs.
cd ./node_modules/@mechakeys/iohook
npm i
node install.js

By default, prebuilds will be downloaded for your own platform and architecture, but you can download specific ones through your package.json:

"iohook": {
    "targets": [
        "node-108",
        "electron-116"
    ],
    "platforms": [
        "win32",
        "darwin",
        "linux"
    ],
    "arches": [
        "x64",
    ]
}

As of right now, we do not build 32-bit versions.