OpenCV Integration

sikuli-go includes OpenCV-backed matcher backends for image search.

Backend Selection

• default build (go build ./...): uses pure Go matcher backend.
• OpenCV build (-tags "opencv gocv_specific_modules"): uses OpenCV matcher backend by default.

The OpenCV backend is wired through:

• internal/cv/opencv_matcher_opencv.go
• internal/cv/orb_matcher_opencv.go
• internal/cv/default_matcher_opencv.go
• pkg/sikuli/finder.go
• internal/observe/backend_polling.go

Build with OpenCV

go test -tags "opencv gocv_specific_modules" ./...
go build -tags "opencv gocv_specific_modules" ./...

Native Requirements

• OpenCV libraries and headers installed on the host
• CGO enabled

On macOS (Homebrew), a typical setup is:

brew install opencv pkg-config
export HOMEBREW_PREFIX="$(brew --prefix)"
export PKG_CONFIG_PATH="$HOMEBREW_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH"

Notes

• When -tags "opencv gocv_specific_modules" is enabled, Finder and observe polling automatically use the OpenCV matcher backend.
• Existing pure-Go matchers (NCC, SAD) remain available.
• Matcher engine is selected via proto fields:
  • FindRequest.matcher_engine
  • ScreenQueryOptions.matcher_engine values: TEMPLATE, ORB, HYBRID.
• Node/Python clients expose this as session defaults (matcherEngine / matcher_engine) and per-call overrides.