@@ -26,25 +26,16 @@ This is a work in progress so the exported functions could change at any time be
26
26
27
27
## Installation
28
28
29
- Please ensure you have the [ required dependencies] ( https://github.com/nodejs/node-gyp#installation ) before installing:
30
-
31
- * Windows
32
- * Visual Studio 2013 (Express works fine).
33
- * Python (v2.7.3 recommended, v3.x.x is not supported).
34
- * Mac
35
- * Xcode Command Line Tools.
36
- * Linux
37
- * Python (v2.7 recommended, v3.x.x is not supported).
38
- * make.
39
- * A C/C++ compiler like GCC.
40
- * libxtst-dev and libpng++-dev (` sudo apt-get install libxtst-dev libpng++-dev ` ).
41
-
42
- Then install RobotJS using npm:
29
+ Install RobotJS using npm:
43
30
44
31
```
45
32
npm install robotjs
46
33
```
47
- I [ plan on] ( https://github.com/octalmage/robotjs/issues/64 ) using node-pre-gyp to make this process easier.
34
+ It's that easy! npm will download one of the prebuilt [ binaries] ( https://github.com/octalmage/robotjs/releases/latest ) your OS.
35
+
36
+ You can get npm [ here] ( https://nodejs.org/en/download/ ) if you don't have it installed.
37
+
38
+ If you need to build RobotJS, see the [ building] ( #building ) section.
48
39
49
40
## Examples
50
41
@@ -105,36 +96,49 @@ The [RobotJS API](https://github.com/octalmage/robotjs/wiki/Syntax) is contained
105
96
106
97
## Building
107
98
108
- node-gyp is required to build RobotJS.
99
+ Please ensure you have the required dependencies before installing:
100
+
101
+ * Windows
102
+ * Visual Studio 2013 (Express works fine).
103
+ * Python (v2.7.3 recommended, v3.x.x is not supported).
104
+ * Mac
105
+ * Xcode Command Line Tools.
106
+ * Linux
107
+ * Python (v2.7 recommended, v3.x.x is not supported).
108
+ * make.
109
+ * A C/C++ compiler like GCC.
110
+ * libxtst-dev and libpng++-dev (` sudo apt-get install libxtst-dev libpng++-dev ` ).
109
111
110
112
Install node-gyp using npm:
111
113
112
114
```
113
115
npm install -g node-gyp
114
116
```
115
117
116
- Then configure and build:
118
+ Then build:
117
119
118
120
```
119
- node-gyp configure
120
- node-gyp build
121
+ node-gyp rebuild
121
122
```
122
123
124
+ See the [ node-gyp readme] ( https://github.com/nodejs/node-gyp#installation ) for more details.
125
+
123
126
## Plans
124
127
125
- * Control the mouse by changing the mouse position, left/right clicking, and dragging.
126
- * Control the keyboard by pressing keys, holding keys down, and typing words.
127
- * Read pixel color from the screen and capture the screen.
128
- * Find image on screen, read pixels from image.
129
- * Possibly include window management?
128
+ * √ Control the mouse by changing the mouse position, left/right clicking, and dragging.
129
+ * √ Control the keyboard by pressing keys, holding keys down, and typing words.
130
+ * √ Read pixel color from the screen and capture the screen.
131
+ * Find an image on screen, read pixels from an image.
132
+ * Possibly include window management?
130
133
131
134
## Progress
132
135
133
136
| Module | Status | Notes |
134
137
| ------------- | -------------: | ------- |
135
138
| Mouse | 100% | All planned features implemented. |
136
139
| Keyboard | 100% | All planned features implemented. |
137
- | Screen | 10% | Screenshot, image search. |
140
+ | Screen | 85% | Image search, pixel search. |
141
+ | Bitmap | 0% | Saving/opening, png support. |
138
142
139
143
## FAQ
140
144
0 commit comments