1.0.0 • Published 11 months ago

nmouse-js v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

periphericJS - Nodejs Periferic Emulator

introducing a new Node.js library that allows you to control the mouse and keyboard of your computer! With this library, you can simulate mouse clicks, mouse movement, and keyboard input from within a Node.js application.

This library is especially useful for automating user input in desktop applications or games, or for creating custom input devices that interface with your computer via Node.js. It provides a simple and intuitive API for controlling the mouse and keyboard, making it easy to get started and integrate into your projects.

With this library, you can simulate left and right mouse clicks, mouse movement, scrolling, and keyboard input such as typing and key presses. It works on all major platforms, including Windows, macOS, and Linux, and is designed to be easy to use and flexible enough to meet a wide range of use cases.

So whether you're building an automated testing suite, creating a custom input device, or just want to control your computer's mouse and keyboard from within a Node.js application, this library has got you covered!

Dependencies

windows: 
	-visual studio 2015 and C++ development tools
	-python 2.7 and above

linux: 
	-python 2.7 and above
	-build-essential
	-X11/Xlib
	-Xorg

Mac:
	-python 2.7 and above
	-build-essential
	-X11/Xlib
	-Xorg

Instalation

You can install this library via npm:

	npm install peripheric-js

Usage

To use this library, simply require it in your Node.js application:

	const input = require('peripheric-js');

Mouse

Node Mouse and Keyboard Control is a Node.js library that allows you to control the mouse and keyboard of your computer. With this library, you can simulate mouse clicks, mouse movement, and keyboard input from within a Node.js application.

	//TODO: Scroll Events
	input.mouseScrollUp();
	input.mouseScrollDown();

	//TODO: Mouse Events
	input.mouseMove( x,y )        //X & Y are Float numbers from [ 0 - 100 ];
	input.mouseClick( btn );      //btn is an integer number from [ 1 - 3 ];
	input.mouseButtonUp( btn );   //btn is an integer number from [ 1 - 3 ];
	input.mouseButtonDown( btn ); //btn is an integer number from [ 1 - 3 ];

Keyboard

The Keyboard module provides an API for controlling the keyboard. Here are some examples of what you can do with it:

	//TODO: Key Events NOTE: key is the ascii key charcode
	input.keyUp( key );
	input.keyDown( key );
	input.keyClick( key );

Compatibility

This library works on all major platforms, including Windows, macOS, and Linux.

Contributions

Contributions are welcome! Please feel free to open an issue or submit a pull request.

License

This library is released under the MIT License.