Skip to content

J7mbo/helios

Repository files navigation

Helios

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. License: MIT

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:

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:

Found Gopher

Installation

MacOS

brew install pkg-config
brew install opencv

Docs

TBD...

Upcoming work

  • Ability to define Regions to search
  • Abstraction for finder
  • Works with any resolution
  • Wait X seconds for an image to appear
  • 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...

About

Helios is a GUI automation tool written in Go.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published