Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vcaesar/robotn
Robotn, Native cross-platform GUI automation
https://github.com/vcaesar/robotn
automation c go javascript node python robot robotgo robotn
Last synced: about 1 month ago
JSON representation
Robotn, Native cross-platform GUI automation
- Host: GitHub
- URL: https://github.com/vcaesar/robotn
- Owner: vcaesar
- License: apache-2.0
- Created: 2019-03-05T17:39:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T00:36:08.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T08:29:32.525Z (about 1 month ago)
- Topics: automation, c, go, javascript, node, python, robot, robotgo, robotn
- Language: JavaScript
- Homepage:
- Size: 111 KB
- Stars: 176
- Watchers: 6
- Forks: 18
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Robotn
[](https://travis-ci.org/go-vgo/robotgo)
[](https://circleci.com/gh/go-vgo/robotgo)
[](https://goreportcard.com/report/github.com/go-vgo/robotgo)
[](https://godoc.org/github.com/go-vgo/robotgo)
[](https://github.com/go-vgo/robotgo/releases/latest)
[](https://gitter.im/go-vgo/robotgo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
>Golang Desktop Automation, binding other language. Control the mouse, keyboard, bitmap, read the screen, Window Handle and global event listener.
Robotn supports Mac, Windows, and Linux(X11). Robot supports go, javascript, python and other.
[简体中文](https://github.com/vcaesar/robotn/blob/master/README_zh.md)
## Contents
- [Docs](#docs)
- [Requirements](#requirements)
- [Installation](#installation)
- [Update](#update)
- [Examples](#examples)
- [Authors](#authors)
- [Plans](#plans)
- [Donate](#donate)
- [Contributors](#contributors)
- [License](#license)
## Docs
- [GoDoc](https://godoc.org/github.com/go-vgo/robotgo)
- [API Docs](https://github.com/go-vgo/robotgo/blob/master/docs/doc.md)
- [中文文档](https://github.com/go-vgo/robotgo/blob/master/docs/doc_zh.md)
## Requirements:
Now, there is no prebuild binary version available, Please make sure `Golang, GCC` is installed correctly before installing robotgo.
[Robotgo Requirements](https://github.com/go-vgo/robotgo#requirements)
# Install robotn
```
npm install robotn
```
Also, you can [Build from source code](#Build-from-source-code). The python's `pip install`, and the prebuilt binaries will be added in the future.
## [Examples:](https://github.com/go-vgo/robotgo/blob/master/examples)
#### [Mouse](https://github.com/go-vgo/robotgo/blob/master/examples/mouse/main.go)
```js
var robot = require('robotn');
robot.scroll(10, 10);
robot.mouseClick("left", true);
robot.moveSmooth(100, 200, 1.0, 100.0);
```
#### python
```py
import robot
robot.scroll(10, 10)
robot.mouseClick("left", true)
robot.moveSmooth(100, 200, 1.0, 100.0)
```
#### [Keyboard](https://github.com/go-vgo/robotgo/blob/master/examples/key/main.go)
```js
var robot = require('robotn');
robot.typeStr("测试")
robot.typeStr("山达尔星新星军团, galaxy. こんにちは世界.")
robot.sleep(1)
robot.keyTap("enter")
robot.writeAll("Test")
var text = robot.readAll()
console.log(text)
```
#### [Screen](https://github.com/go-vgo/robotgo/blob/master/examples/screen/main.go)
```js
var robot = require('robotn');
var pos = robot.getMousePos()
console.log("pos: ", pos)
var color = robot.getPixelColor(100, 200)
console.log("color---- ", color)
```
#### [Bitmap](https://github.com/go-vgo/robotgo/blob/master/examples/bitmap/main.go)
```js
var robot = require('robotn');
var bitmap = robot.captureScreen(10, 20, 30, 40)
console.log("...", bitmap)
var pos = robot.findBitmap(bitmap)
console.log("FindBitmap------ ", pos)
robot.saveBitmap(bitmap, "test.png")
// use `robot.freeBitmap(bit)` to free the bitmap
robot.freeBitmap(bitmap)
```
#### [Event](https://github.com/go-vgo/robotgo/blob/master/examples/event/main.go)
```js
var robot = require('robotn');
var keve = robot.addEvent("k");
if (keve) {
console.log("you press... ", "k");
}
var s = robot.addEvents("q", "ctrl");
if (s) {
console.log("you press... ", "mouse left button");
}
```
#### [Window](https://github.com/go-vgo/robotgo/blob/master/examples/window/main.go)
```js
var robot = require('robotn');
var fpid = robot.findIds("Google")
console.log("pids... ", fpid)
if (fpid.length > 0) {
robot.activePID(fpid[0])
robot.kill(fpid[0])
}
robot.activeName("chrome")
var isExist = robot.pidExists(100)
if (isExist) {
console.log("pid exists is", isExist)
robot.kill(100)
}
var abool = robot.showAlert("test", "robotgo")
if (abool == 0) {
console.log("ok@@@ ", "ok")
}
var title = robot.getTitle()
console.log("title@@@ ", title)
```
## Build from source code:
### Install robotgo
```
go get -u github.com/go-vgo/robotgo
```
```
git clone https://github.com/vcaesar/robotn
```
### [Build-tools](https://github.com/vcaesar/gocs)
```
go get -v github.com/vcaesar/gocs
```
### Building
```
cd robotn
```
```
gocs -n robotgo
```
#### node:
##### Install npm modules
```
npm install
```
#### python
```
pip install cffi
```
## Authors
* [The author is vz](https://github.com/vcaesar)
* [Maintainers](https://github.com/orgs/go-vgo/people)
* [Contributors](https://github.com/go-vgo/robotgo/graphs/contributors)
## Plans
- Update Find an image on screen, read pixels from an image
- Update Window Handle
- Try support Android, maybe support IOS
## Contributors
- See [contributors page](https://github.com/go-vgo/robotgo/graphs/contributors) for full list of contributors.
- See [Contribution Guidelines](https://github.com/go-vgo/robotgo/blob/master/CONTRIBUTING.md).
## License
Robotgo is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.
See [LICENSE-APACHE](http://www.apache.org/licenses/LICENSE-2.0), [LICENSE-MIT](https://github.com/go-vgo/robotgo/blob/master/LICENSE).