robot-ts v1.0.2

Robot TS 🤖

This library is inspired by older unmaintained libraries like octalmage/robotjs and Robot/robot-js. The goal is to provide cross-platform controls for various devices such as keyboard, mouse, and screen for Node.js applications.

You can find C++ implementation CMake static library 📚 here: developer239/robot-cpp

Supported system:

• MacOS
• Windows (not tested yet)

In case of Linux, please, create issue and leave a star ⭐ and I will implement support. Right now I want to focus on port to Node.js using Node-API.

Known issues:

• Work in progress. If you need specific features, please, create an issue and I will prioritize it.
• I never tested this on Windows. 🙏
• It seems that special keys bindings are not implemented correctly.
• Upper case is converted to lower case when typing. (it will be possible to use shift key when special keys are fixed though)

Installation:

Make sure that you can build C++ projects on your machine and that you have CMake installed.

• On MacOS: brew install cmake
• On Windows: choco install cmake

Install Node dependencies:

yarn add robot-ts

Mouse 🖱️

The Mouse class provides a static interface for controlling the mouse cursor, simulating mouse clicks, and scrolling.

Public Methods

• static move(point: Point): void Moves the mouse cursor to the specified point (x, y).

• static moveSmooth(point: Point, speed?: number): void Moves the mouse cursor smoothly to the specified point (x, y) at the given speed.

• static drag(point: Point, speed?: number): void Drags the mouse cursor to the specified point (x, y) at the given speed.

• static getPosition(): Point Returns the current position of the mouse cursor as a Point.

• static toggleButton(down: boolean, button: MouseButton, doubleClick?: boolean): void Presses or releases the specified mouse button depending on the down argument. If doubleClick is set to true, it will perform a double click.

• static click(button: MouseButton): void Simulates a single click using the specified mouse button.

• static doubleClick(button: MouseButton): void Simulates a double click using the specified mouse button.

• static scrollBy(y: number, x?: number): void Scrolls the mouse wheel by the specified x and y distances.

Example Usage

import { Mouse, Point } from "./bindings";

Mouse.moveSmooth(new Point(100, 200));

Keyboard ⌨️

The Keyboard class provides a static interface for simulating keyboard key presses, releases, and typing.

Public Methods

• static type(query: string): void Types the given text as a string.

• static typeHumanLike(query: string): void Types the given text as a string with a human-like typing speed.

• static click(asciiChar: string): void Simulates a key press and release for the specified ASCII character.

• static click(specialKey: SpecialKey): void Simulates a key press and release for the specified special key.

• static press(asciiChar: string): void Simulates a key press for the specified ASCII character.

• static press(specialKey: SpecialKey): void Simulates a key press for the specified special key.

• static release(asciiChar: string): void Simulates a key release for the specified ASCII character.

• static release(specialKey: SpecialKey): void Simulates a key release for the specified special key.

Example Usage

import { Keyboard } from "./bindings";

Keyboard.typeHumanLike("hello, world");

Screen 🖥️

The Screen class provides functionality to capture the screen, get pixel colors, and save the captured screen as a PNG image.

Public Methods

• getPixelColor(x: number, y: number): Pixel Returns the color of the pixel at the specified (x, y) coordinates as a Pixel structure.

• getScreenSize(): DisplaySize Returns the size of the screen as a DisplaySize structure containing the width and height.

• capture(x?: number, y?: number, width?: number, height?: number): void Captures a rectangular area of the screen defined by the specified (x, y) coordinates and dimensions (width, height).

• getPixels(): Pixel[] Returns an array of Pixel structures representing the captured screen.

• saveAsPNG(filename: string): void Saves the captured screen as a PNG image with the specified filename.

Structures

DisplaySize

DisplaySize is a structure that represents the size of a display with integer dimensions (width, height).

Attributes

• width: number The width of the display.

• height: number The height of the display.

Pixel

Pixel is a structure that represents the color of a pixel with unsigned char values for red, green, and blue channels.

Attributes

• r: number The red channel value of the pixel.

• g: number The green channel value of the pixel.

• b: number The blue channel value of the pixel.

Example Usage

import { Screen } from "./bindings";

const screen = new Screen();
screen.capture(0, 0, 800, 600);
const pixel = screen.getPixelColor(100, 200);
screen.saveAsPNG("screenshot.png");