https://github.com/j7mbo/helios
Helios is a GUI automation tool written in Go.
https://github.com/j7mbo/helios
golang gui sikuli
Last synced: about 1 month ago
JSON representation
Helios is a GUI automation tool written in Go.
- Host: GitHub
- URL: https://github.com/j7mbo/helios
- Owner: J7mbo
- License: mit
- Created: 2022-06-18T17:07:49.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-25T14:59:19.000Z (2 months ago)
- Last Synced: 2025-04-14T01:54:02.210Z (about 1 month ago)
- Topics: golang, gui, sikuli
- Language: Go
- Homepage:
- Size: 31 MB
- Stars: 9
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Helios
--
[](https://www.repostatus.org/#wip)
[](LICENSE.md)
Helios is a GUI automation tool written in Go - it automates anything that you can see on your screen. Helios uses
image recognition powered by OpenCV under-the-hood. You can use Helios to automate GUI testing, video games and more.
Example:
```go
package main
import (
. "github.com/j7mbo/helios"
"time"
)
func main() {
// Initialise helios without any configuration
app := NewApplication(nil)
// Load .gopher.png and expect to find it at 0.9 / 1.0 confidence
gopherImage, _ := NewImage("./gopher.png", 0.9)
// Find the gopher image on-screen
gopher := app.GetScreen().Find(gopherImage)
// Highlight it for two seconds
gopher.Highlight(2 * time.Second)
// Click at a random (X,Y) coordinate within the matched box
gopher.Click()
}
```
The Gopher from Goland, highlighted for 2 seconds:
Installation
---
### MacOS
```
brew install pkg-config
brew install opencv
```
Docs
---
**Those using a mac with a retina display**
When you take a screenshot of something you want to search for on MacOS, like the gopher icon, (use command, control,
shift, 4), you need to adjust the image size (if you're using a retina display). To do this, open the image in preview,
go to Tools > Adjust Size and then choose 200 per cent for the width and height. Then save. Your image should now be
findable.
Upcoming work
---
- [x] Ability to define `Region`s to search
- [x] Abstraction for `finder`
- [x] Works with any resolution
- [x] Wait X seconds for an image to appear
- [x] Offsets for regions
- [ ] Stable supported api
- [ ] Support and releases for Windows, Linux (MacOS already supported)
- [ ] Moving highlight box during highlighting
- [ ] Support for multiple screens
- [ ] Fix for issue #1 - no need to embed a highlighter binary
- [ ] Embedding OpenCV directly, 0 dependency binary (need help with this)
- [ ] API for interfacing with other languages
- [ ] OCR, text extraction
- [ ] GUI for region and image selection, scripting language (this'll be a fun one)
- [ ] Tests...