View robotjs-custom-unicode on Snyk Open Source Advisor

Package Health Score

50 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.5.11	\|	07/2019	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (2)

GitHub Stars: 12.38K
Forks: 962
Contributors: 50

Direct Usage Popularity

The npm package robotjs-custom-unicode receives a total of 2 downloads a week. As such, we scored robotjs-custom-unicode popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package robotjs-custom-unicode, we found that it has been starred 12,376 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 50
Funding: No

With more than 10 contributors for the robotjs-custom-unicode repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like robotjs-custom-unicode is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 167
Open PR: 30
Last Release: 5 years ago
Last Commit: 3 years ago

Further analysis of the maintenance status of robotjs-custom-unicode based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for robotjs-custom-unicode is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 2 Direct
Versions: 12
Install Size: 299 kB
Dist-tags: 1
# of Files: 69
Maintainers: 1
TS Typings: Yes

robotjs-custom-unicode has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

> Node.js Desktop Automation. Control the mouse, keyboard, and read the screen.

RobotJS supports Mac, Windows, and Linux.

This is a work in progress so the exported functions could change at any time before the first stable release (1.0.0). Ideas?

Check out some of the cool things people are making with RobotJS! Have your own rad RobotJS project? Feel free to add it!

Installation

Install RobotJS using npm:

npm install robotjs

It's that easy! npm will download one of the prebuilt binaries for your OS.

You can get npm here if you don't have it installed.

If you need to build RobotJS, see the building section. Instructions for Electron.

Examples

Mouse

// Move the mouse across the screen as a sine wave.
var robot = require("robotjs");

// Speed up the mouse.
robot.setMouseDelay(2);

var twoPI = Math.PI * 2.0;
var screenSize = robot.getScreenSize();
var height = (screenSize.height / 2) - 10;
var width = screenSize.width;

for (var x = 0; x &lt; width; x++)
{
	y = height * Math.sin((twoPI * x) / width) + height;
	robot.moveMouse(x, y);
}

Keyboard

// Type "Hello World" then press enter.
var robot = require("robotjs");

// Type "Hello World".
robot.typeString("Hello World");

// Press enter.
robot.keyTap("enter");

Screen

// Get pixel color under the mouse.
var robot = require("robotjs");

// Get mouse position.
var mouse = robot.getMousePos();

// Get pixel color in hex format.
var hex = robot.getPixelColor(mouse.x, mouse.y);
console.log("#" + hex + " at x:" + mouse.x + " y:" + mouse.y);

Read the Wiki for more information!

API

The RobotJS API is hosted at .

Building

Please ensure you have the required dependencies before installing:

Windows
- windows-build-tools npm package (npm install --global --production windows-build-tools from an elevated PowerShell or CMD.exe)
Mac
- Xcode Command Line Tools.
Linux
- Python (v2.7 recommended, v3.x.x is not supported).
- make.
- A C/C++ compiler like GCC.
- libxtst-dev and libpng++-dev (sudo apt-get install libxtst-dev libpng++-dev).

Install node-gyp using npm:

npm install -g node-gyp

Then build:

node-gyp rebuild

See the node-gyp readme for more details.

Plans

√ Control the mouse by changing the mouse position, left/right clicking, and dragging.
√ Control the keyboard by pressing keys, holding keys down, and typing words.
√ Read pixel color from the screen and capture the screen.
Find an image on screen, read pixels from an image.
Possibly include window management?

Progress

Module	Status	Notes
Mouse	100%	All planned features implemented.
Keyboard	100%	All planned features implemented.
Screen	85%	Image search, pixel search.
Bitmap	0%	Saving/opening, png support.

FAQ

Does RobotJS support global hotkeys?

Not currently, and I don't know if it ever will. I personally use Electron/NW.js for global hotkeys, and this works well. Later on I might add hotkey support or create a separate module. See #55 for details.

Can I take a screenshot with RobotJS?

Soon! This is a bit more complicated than the rest of the features, so I saved it for last. Luckily the code is already there, I just need to write the bindings, and I've already started. Subscribe to #13 for updates.

Why is <insert key> missing from the keyboard functions?

We've been implementing keys as we need them. Feel free to create an issue or submit a pull request!

How about multi-monitor support?

The library doesn't have explicit multi-monitor support, so anything that works is kind of on accident. Subscribe to #88 for updates.

For any other questions please submit an issue.

Story

I'm a huge fan of AutoHotkey, and I've used it for a very long time. AutoHotkey is great for automation and it can do a bunch of things that are very difficult in other languages. For example, it's imagesearch and pixel related functions are hard to reproduce on Mac, especially in scripting languages. These functions are great for automating apps that can't be automated like Netflix. This has never been a big deal since I've always used Windows at work, but for the past few years I've been using Mac exclusively.

I like AutoHotkey, but I like Node.js more. By developing RobotJS I get an AutoHotkey replacement on Mac (finally!), and I get to use my favorite language.

TLDR: There's nothing like AutoHotkey on Mac, so I'm making it.

License

MIT

Based on autopy. Maintained by Jason Stallings.

robotjs-custom-unicode dependencies

nan prebuild-install

robotjs-custom-unicode development dependencies

jasmine prebuild run-script-os targetpractice

FAQs

What is robotjs-custom-unicode?

Node.js Desktop Automation. Visit Snyk Advisor to see a full health score report for robotjs-custom-unicode, including popularity, security, maintenance & community analysis.

Is robotjs-custom-unicode popular?

The npm package robotjs-custom-unicode receives a total of 2 weekly downloads. As such, robotjs-custom-unicode popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is robotjs-custom-unicode well maintained?

We found indications that robotjs-custom-unicode is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is robotjs-custom-unicode safe to use?

While scanning the latest version of robotjs-custom-unicode, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 11 November-2024, at 02:18 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (2)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Contents

Installation

Examples

Mouse

Keyboard

Screen

API

Building

Plans

Progress

FAQ

Does RobotJS support global hotkeys?

Can I take a screenshot with RobotJS?

Why is <insert key> missing from the keyboard functions?

How about multi-monitor support?

Story

License

robotjs-custom-unicode dependencies

robotjs-custom-unicode development dependencies

FAQs

What is robotjs-custom-unicode?

Is robotjs-custom-unicode popular?

Is robotjs-custom-unicode well maintained?

Is robotjs-custom-unicode safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues