Currently, there are two official ImageFinder
implementations provided by nut.js.
1npm i @nut-tree/template-matcher
Initial implementation for on-screen image search.
Simply require / import the package to wire up the provider:
1const { screen, imageResource } = require("@nut-tree/nut-js"); 2require("@nut-tree/template-matcher"); 3 4(async () => { 5 const img = await screen.find(imageResource("...")); 6})();
1npm i @nut-tree/nl-matcher
Attention: @nut-tree/nl-matcher
is only available to sponsors of nut.js.
In case you want to get access to it, please consult the sponsoring profile
Next Level module for image search.
Comes with additional features compared to @nut-tree/template-matcher
See the table below for a comparison of both modules:
@nut-tree/template-matcher | @nut-tree/nl-matcher | |
---|---|---|
Windows | ✔️ | ✔️ |
Linux | ✔️ | ✔️ |
Apple (Intel) / Apple (Apple Silicon) | ✔️ / ❌ | ✔️ / ✔️ |
find | ✔️ | ✔️ |
findAll | ❌ | ✔️ |
Supports node 12 / 13 / 14 / 15 / 16 / 17 / next | ✔️ / ❌ / ✔️ / ✔️ / ✔️ / ❌ / ❌ | ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ✔️ |
Supports Electron 8 / 9 / 10 / 11 / 12 / 13 / 14 / 15 / 16 / next | ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ❌ / ❌ / ❌ / ❌ | ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ✔️ / ✔️ |
Simply require / import the package to wire up the provider:
1const { screen, imageResource } = require("@nut-tree/nut-js"); 2require("@nut-tree/nl-matcher"); 3 4(async () => { 5 const img = await screen.findAll(imageResource("...")); 6})();
© 2022