My-Key-Mouse

My-Key-Mouse is a Node.js module for simulating keyboard and mouse actions on both Linux and Windows platforms. It provides functions to send key presses, mouse clicks, and complex key-mouse combinations, making it useful for automation tasks in various applications, including games like Albion Online.

Installation

To use this module, you need to have ffi-napi-v22 installed. You can install it via npm:

npm install ffi-napi-v22

Additionally, make sure you have libxdo installed on your Linux system. On Ubuntu/Debian, you can install it using:

Linux system.

sudo apt-get install xdotool

Windows system.

For Windows, user32.dll is used, which is available by default.

Usage

Below are examples of how to use the Key and Mouse classes to simulate keyboard and mouse actions.

const { Key, Mouse } = require('my-key-mouse');

// Simulate pressing down the 'a' key
Key.down('a');

// Simulate releasing the 'a' key
Key.up('a');

// Simulate typing the string 'hello'
Key.type('hello');

// Simulate pressing down 'Ctrl' and 'a'
Key.combo(['ctrl', 'a']);

// Simulate pressing 'Shift' and then clicking the left mouse button
(async () => {
    await Key.comboClick(['Shift_L'], 'left');
})();

// Move the mouse to coordinates (900, 600)
Mouse.move(900, 600);

// Simulate a left mouse button click
Mouse.click('left');

// Simulate a right mouse button click
Mouse.click('right');

// Simulate a middle mouse button click
Mouse.click('middle');

// Simulate pressing down the left mouse button
Mouse.down('left');

// Simulate releasing the left mouse button
Mouse.up('left');

These examples demonstrate how to use the Key and Mouse classes to simulate various keyboard and mouse actions. You can combine these methods to create complex automation scripts for your applications.