@nut-tree/template-matcher

Installation

You build it, you run it, no matter when or where.

Go check out the repository to build it yourself.

Attention

@nut-tree/template-matcher only supports node up to v16 and Electron up to v13. It is also NOT available for Apple Silicon.

It is no longer maintained and will not receive any updates, thus, it is not recommended to use it in new projects.

In case you want to use maintained plugin for image search in later versions of node/Electron, or on Apple Silicon devices, please check out @nut-tree/nl-matcher for access to .

Usage

Simply require / import the package to wire up the provider:

const {screen, imageResource} = require("@nut-tree/nut-js");
require("@nut-tree/template-matcher");

(async () => {
    const img = await screen.find(imageResource("..."));
})();

Configuration

@nut-tree/template-matcher takes an optional configuration object passed to it via MatchRequest#providerData property.

export interface TemplateMatcherProviderData {
    searchMultipleScales: boolean; // default: true
}

const {screen, imageResource} = require("@nut-tree/nut-js");
require("@nut-tree/template-matcher");

(async () => {
    const img = await screen.findAll(imageResource("..."), {
        providerData: {
            searchMultipleScales: false
        }
    });
})();