You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -89,7 +71,7 @@ It's work in progress and will undergo constant modification.
89
71
## Keyboard
90
72
91
73
-[x] Support for standard US keyboard layout
92
-
-[x] Support for German special characters
74
+
-[x] Support for multimedia keys
93
75
94
76
## Mouse
95
77
@@ -107,8 +89,10 @@ It's work in progress and will undergo constant modification.
107
89
108
90
## Screen
109
91
110
-
-[x] findOnScreen
111
-
-[x] waitFor
92
+
-[x] Find an image on screen
93
+
-[x] Find all image occurrences on screen
94
+
-[x] Wait for an image to appear on screen
95
+
-[x] Retrieve RGBA color information on screen
112
96
-[x] Hooks to trigger actions based on images
113
97
-[x] Highlighting screen regions
114
98
@@ -231,96 +215,3 @@ will install the most recent development release of `nut.js`.
231
215
232
216
**Attention**: While snapshot releases are great to work with upcoming features before a new stable release, it is still a snapshot release.
233
217
Please bear in mind that things might change and / or break on snapshot releases, so it is not recommended using them in production.
234
-
235
-
### Usage with Electron
236
-
237
-
`nut.js` in combination with Electron requires bindings built for use with Electron.
238
-
`nut.js` does provide such bindings and e.g. [electron-rebuild](https://www.npmjs.com/package/electron-rebuild) makes installation a breeze.
239
-
240
-
Besides installing `nut.js` via
241
-
242
-
```bash
243
-
npm i @nut-tree/nut-js
244
-
```
245
-
246
-
or
247
-
248
-
```bash
249
-
yarn add @nut-tree/nut-js
250
-
```
251
-
252
-
we also install `electron-rebuild` as a `devDependency`:
253
-
254
-
```bash
255
-
npm i -D electron-rebuild
256
-
```
257
-
258
-
or
259
-
260
-
```bash
261
-
yarn add -D electron-rebuild
262
-
```
263
-
264
-
Next, we add a `rebuild` script to our `package.json`:
265
-
266
-
```json
267
-
{
268
-
...
269
-
"scripts": {
270
-
...
271
-
"start": "electron app.js",
272
-
"rebuild": "electron-rebuild"
273
-
},
274
-
...,
275
-
}
276
-
```
277
-
278
-
Now all we have to do is run `npm run rebuild` and `electron-rebuild` will fetch the appropriate bindings for our Electron version.
279
-
Currently `nut.js` provides bindings for all ABI version to work with Electron v4.x up to 8.x
280
-
281
-
### Manual build
282
-
283
-
As a fallback, `nut.js` is able to build all required dependencies by itself.
284
-
To do so, some setup is required on the respective target platform.
285
-
286
-
#### Windows
287
-
288
-
In order to install `nut.js` on Windows, [Windows Build Tools](https://www.microsoft.com/en-us/download/details.aspx?id=48159) and [Python 2](https://www.python.org/downloads/windows/) are required.
289
-
You can either set them up manually, or install them via npm:
290
-
291
-
```bash
292
-
npm install --global windows-build-tools
293
-
```
294
-
295
-
or
296
-
297
-
```bash
298
-
yarn global add windows-build-tools
299
-
```
300
-
301
-
#### macOS
302
-
303
-
On macOS, Xcode command line tools are required.
304
-
You can install them by running
305
-
```bash
306
-
xcode-select --install
307
-
```
308
-
309
-
#### Linux
310
-
311
-
Depending on your distribution, Linux setups may differ.
0 commit comments