Robotgo

Golang Desktop Automation. Control the mouse, keyboard, bitmap, read the screen, Window Handle and global event listener.

RobotGo supports Mac, Windows, and Linux(X11).

Chinese Simplified

Contents

• Docs
• Binding
• Requirements
• Installation
• Update
• Examples
• Cross-Compiling
• Authors
• Plans
• Donate
• Contributors
• License

Docs

• GoDoc
• API Docs
• Chinese Docs

Binding:

Robotn, binding JavaScript and other, support more language.

Requirements:

Now, Please make sure Golang, GCC is installed correctly before installing RobotGo.

ALL:

Golang
GCC

For Mac OS X:

Xcode Command Line Tools

For Windows:

MinGW-w64 (Use recommended) or other GCC

For everything else:

GCC, libpng
X11 with the XTest extension (also known as the Xtst library)
Event:
xcb, xkb, libxkbcommon

Ubuntu:

sudo apt-get install gcc libc6-devsudo apt-get install libx11-dev xorg-dev libxtst-dev libpng++-devsudo apt-get install xcb libxcb-xkb-dev x11-xkb-utils libx11-xcb-dev libxkbcommon-x11-devsudo apt-get install libxkbcommon-devsudo apt-get install xsel xclip

Fedora:

sudo dnf install libxkbcommon-devel libXtst-devel libxkbcommon-x11-devel xorg-x11-xkb-utils-develsudo dnf install libpng-develsudo dnf install xsel xclip

Installation:

go get github.com/go-vgo/robotgo

It's that easy!

png.h: No such file or directory? Please see issues/47.

Update:

go get -u github.com/go-vgo/robotgo

Note go1.10.x C file compilation cache problem, golang #24355. go mod vendor problem, golang #26366.

Examples:

Mouse

package main
import (
"github.com/go-vgo/robotgo"
)
funcmain() {
robotgo.ScrollMouse(10, "up")
robotgo.MouseClick("left", true)
robotgo.MoveMouseSmooth(100, 200, 1.0, 100.0)
}

Keyboard

package main
import (
"fmt""github.com/go-vgo/robotgo"
)
funcmain() {
robotgo.TypeStr("Hello World")
robotgo.TypeStr("だんしゃり", 1.0)
// robotgo.TypeString("テストする")robotgo.TypeStr("Hi galaxy. こんにちは世界.")
robotgo.Sleep(1)
// ustr := uint32(robotgo.CharCodeAt("Test", 0))// robotgo.UnicodeType(ustr)robotgo.KeyTap("enter")
// robotgo.TypeString("en")robotgo.KeyTap("i", "alt", "command")
arr:= []string{"alt", "command"}
robotgo.KeyTap("i", arr)
robotgo.WriteAll("Test")
text, err:=robotgo.ReadAll()
iferr==nil {
fmt.Println(text)
}
}

Screen

package main
import (
"fmt""github.com/go-vgo/robotgo"
)
funcmain() {
x, y:=robotgo.GetMousePos()
fmt.Println("pos: ", x, y)
color:=robotgo.GetPixelColor(100, 200)
fmt.Println("color---- ", color)
}

Bitmap

package main
import (
"fmt""github.com/go-vgo/robotgo"
)
funcmain() {
bitmap:=robotgo.CaptureScreen(10, 20, 30, 40)
// use `defer robotgo.FreeBitmap(bit)` to free the bitmapdeferrobotgo.FreeBitmap(bitmap)
fmt.Println("...", bitmap)
fx, fy:=robotgo.FindBitmap(bitmap)
fmt.Println("FindBitmap------ ", fx, fy)
robotgo.SaveBitmap(bitmap, "test.png")
}

Event

package main
import (
"fmt""github.com/go-vgo/robotgo"
hook "github.com/robotn/gohook"
)
funcmain() {
fmt.Println("--- Please press ctrl + shift + q to stop hook ---")
robotgo.EventHook(hook.KeyDown, []string{"q", "ctrl", "shift"}, func(e hook.Event) {
fmt.Println("ctrl-shift-q")
robotgo.EventEnd()
})
fmt.Println("--- Please press w---")
robotgo.EventHook(hook.KeyDown, []string{"w"}, func(e hook.Event) {
fmt.Println("w")
})
s:=robotgo.EventStart()
<-robotgo.EventProcess(s)
ok:=robotgo.AddEvents("q", "ctrl", "shift")
ifok {
fmt.Println("add events...")
}
keve:=robotgo.AddEvent("k")
ifkeve {
fmt.Println("you press... ", "k")
}
mleft:=robotgo.AddEvent("mleft")
ifmleft {
fmt.Println("you press... ", "mouse left button")
}
}

Window

package main
import (
"fmt""github.com/go-vgo/robotgo"
)
funcmain() {
fpid, err:=robotgo.FindIds("Google")
iferr==nil {
fmt.Println("pids... ", fpid)
iflen(fpid) >0 {
robotgo.ActivePID(fpid[0])
robotgo.Kill(fpid[0])
}
}
robotgo.ActiveName("chrome")
isExist, err:=robotgo.PidExists(100)
iferr==nil&&isExist {
fmt.Println("pid exists is", isExist)
robotgo.Kill(100)
}
abool:=robotgo.ShowAlert("test", "robotgo")
ifabool==0 {
fmt.Println("ok@@@ ", "ok")
}
title:=robotgo.GetTitle()
fmt.Println("title@@@ ", title)
}

CrossCompiling

Windows64 to win32

SETCGO_ENABLED=1SETGOARCH=386gobuildmain.go

Other to windows

GOOS=windowsGOARCH=amd64CGO_ENABLED=1CC=x86_64-w64-mingw32-gccCXX=x86_64-w64-mingw32-g++gobuild-x ./

// CC=mingw-w64\x86_64-7.2.0-win32-seh-rt_v5-rev1\mingw64\bin\gcc.exe
// CXX=mingw-w64\x86_64-7.2.0-win32-seh-rt_v5-rev1\mingw64\bin\g++.exe

Some discussions and questions, please see issues/228, issues/143.

Authors

• The author is vz
• Maintainers
• Contributors

Plans

• Update Find an image on screen, read pixels from an image
• Update Window Handle
• Try support Android, maybe support IOS

Donate

Supporting robotgo, buy me a coffee.

Paypal

Donate money by paypal to my account vzvway@gmail.com

Contributors

• See contributors page for full list of contributors.
• See Contribution Guidelines.

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, LICENSE-MIT.