@gulfie/lepikevents v1.6.13

Lepik Events

An event based, Global Keyboard and Mouse listener.

Lepik Events is only part from LepikJS. Definitely try it out!

Visit LepikJS's website.

Installing

npm install lepikevents

Coding

// Require lepikEvents
const lepikEvents = require('lepikevents');

lepikEvents.events.on('keyPress', (data) => {
  // Returns key pressed as String 
  console.log(data); // e||esc||space||backspace ...
});

lepikEvents.events.on('keyRelease', (data) => {
  // Returns key released as String 
  console.log(data); // e||esc||space||backspace ...
});

lepikEvents.events.on('mouseClick', (data) => {
  // Returns array containing mouse position x, y and button clicked 
  console.log(data); // [361, 235, *1]
  // *1 for left, 2 for right, 3 for middle
});

lepikEvents.events.on('mouseDoubleClick', (data) => {
  // Returns array containing mouse position x, y and button double-clicked 
  console.log(data); // [361, 235, *1]
  // *1 for left, 2 for right, 3 for middle
});

lepikEvents.events.on('mouseMove', (data) => {
  // Returns array containing mouse x, y and time (seconds)
  console.log(data); // [20, -35, 1663787912.698]
});

All events

Curently there are 5 events in total, mouseMove, mouseClick, mouseDoubleClick, keyPress and keyRelease.

Requirements

Lepik Events uses Python keyboard and Python mouse which runs on Python.

If your are on Windows, then you don't even have to have it installed, cause thanks to Pyinstaller, the code is compiled into executable.

If you are not using windows, you need to have atleast Python3 installed. It's better to have atleast node13 but not required.

License

The code is licensed under the MIT license (http://opensource.org/licenses/MIT). See LICENSE file.