This repository has been archived by the owner on Feb 7, 2023. It is now read-only.
forked from wilix-team/iohook
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
24,882 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,73 +1,7 @@ | ||
# iohook | ||
This is a fork from [wilix-team/iohook](https://github.com/wilix-team/iohook). Since it no longer provides prebuild binary for new version Node.js and Electron, and not support Apple m1 (a.k.a amd64, aarch64), so I forked the project, provided prebuild binary files (based on iohook v0.9.3) and posted it to npm. | ||
|
||
[](https://www.npmjs.com/package/iohook) | ||
[](https://github.com/wilix-team/iohook/releases/latest) | ||
[](https://github.com/marketplace/actions/super-linter) | ||
[](https://github.com/wilix-team/iohook/actions/workflows/ci.yml) | ||
[](https://github.com/prettier/prettier) | ||
[](https://gitter.im/iohookjs/Lobby) | ||
[](https://github.com/wilix-team/iohook/issues) | ||
Just install it and it should work for you: | ||
|
||
## About | ||
|
||
Node.js global native keyboard and mouse listener. | ||
|
||
This module can handle keyboard and mouse events via native hooks inside and outside your JavaScript/TypeScript application. | ||
|
||
Found a bug? Have an idea? Feel free to post an [issue](https://github.com/wilix-team/iohook/issues) or submit a [PR](https://github.com/wilix-team/iohook/pulls). | ||
|
||
**Check out the [documentation](https://wilix-team.github.io/iohook).** | ||
|
||
## Platform support | ||
|
||
- Versions >= 0.6.0 support only officially supported platforms versions. | ||
- Versions 0.5.X are the last to support Electron < 4.0.0 | ||
- Versions 0.4.X are the last to support for Node < 8.0 and Electron < 2.0.0 | ||
|
||
## Installation | ||
|
||
iohook provides prebuilt version for a bunch of OSes and platforms. | ||
|
||
### Linux (including WSL) | ||
|
||
```bash | ||
# On Linux (including WSL) platform, you will need libxkbcommon-x11 installed | ||
sudo apt-get install -y libxkbcommon-x11-0 | ||
``` | ||
|
||
### All platforms | ||
|
||
```bash | ||
npm install iohook --save # or yarn add iohook | ||
```text | ||
npm install @hcfy/iohook | ||
``` | ||
|
||
## FAQ | ||
|
||
Q. _Does this module require Java ?_ | ||
|
||
A. No, this module doesn't require Java (like jnativehook) or any other runtimes. | ||
|
||
Q. _Is iohook compatible with Node/Electron version X.Y.Z ?_ | ||
|
||
A. We try to match the currently supported version of both [Node](https://nodejs.org/en/about/releases/) and [Electron](https://electronjs.org/docs/tutorial/support#currently-supported-versions). | ||
|
||
## Apps | ||
|
||
Are you using iohook in your project ? Please tell us in a [PR](https://github.com/wilix-team/iohook/pulls) so we an add it to the list ! | ||
|
||
- [Cortex](https://crtx.gg/) | ||
- [Tracklify](https://tracklify.com/) | ||
- [CrewLink](https://github.com/ottomated/CrewLink) | ||
- [Runtime](https://github.com/yikuansun/desktopspeedruntools#runtime-speedrun-tools) | ||
|
||
## Contributors | ||
|
||
Thanks to _kwhat_ for the [libuiohook](https://github.com/kwhat/libuiohook) project and [ayoubserti](https://github.com/ayoubserti) for the first iohook prototype. | ||
|
||
- [vespakoen](https://github.com/vespakoen) (prebuild system implementation) | ||
- [matthewshirley](https://github.com/matthewshirley) (Windows prebuild fix) | ||
- [djiit](https://github.com/djiit) (project & community help) | ||
- [ezain](https://github.com/eboukamza) (add feature enable/disable mouse click propagation) | ||
- [anoadragon453](https://github.com/anoadragon453) (electron 4+ support) | ||
- [ykhwong](https://github.com/ykhwong) (node-gyp usage, electron 9+ support) | ||
- All the other contributors. Feel free to extend this list ! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.