Image Detection

The Image Detection plugin watches your screen while you play. It can spot an image, follow a health bar or other meter, and read text or numbers, then react with its own shocker actions or start a flow. This page describes version 1.4.0, which runs on Windows only. Install it from Manage plugins → Browse. See how nodes work for how to read the node diagrams.

Setup

Plugin pages are hidden from the sidebar until you turn them on; see showing a plugin's pages.

Open Image Detection in the sidebar.

1. Choose the Monitor your game is on. Leave Backend on Auto (recommended). Windows Graphics Capture works with fullscreen and hardware-accelerated games; Legacy GDI sees black frames in many games.

2. Click + New Module and give it a name. A module is a set of things to detect, usually one per game.

3. Click Configure on the module and add targets:

   • Upload Image or Capture Template adds an image to look for.
   • + Health Detection follows a health bar or other meter.
   • + Text/Number Detection reads text or a number with Windows' built-in text recognition, which needs a Windows language pack with OCR support.

   Health and text targets need a screen region: click Arm Region Picker and drag over the area, or enter the coordinates by hand. Each target has a Test Now button.

4. Click Start Detection at the top of the page.

The Delay setting on the page controls how long detection waits between captures, in milliseconds. Lower values react faster but use more CPU.

Each target also has its own Action Settings: a shock, vibrate, or beep that runs whenever the target is detected, without any flow, as long as shockers are selected there. Leave Shockers empty to use flows only.

Modules can be exported and imported to share them. In the plugin's settings under Manage plugins, you can turn on Auto-start background detection and a global hotkey for the region picker.

Names in filters

The trigger filters match these IDs, ignoring capitalization:

• Module ID: the module name in lowercase, with spaces and underscores replaced by -. "Boss Fight" becomes boss-fight.
• Image: the uploaded file's name, such as boss-icon.png, or the same name without the extension.
• Target: a health or text target's name, "Health Bar" and "Text Detector" by default, or its ID.

Triggers

Image Detection triggers only fire while detection is running, and only for enabled modules and targets.

Image Detected

Fires when an image target is found on screen.

It fires once the target has matched as many times in a row as its Consecutive matches to trigger setting, and not during the target's cooldown. For a target limited to a region, Match X and Y are measured from the region's corner.

Meter Changed

Fires when a health bar or meter goes up or down.

The first reading only sets the starting point. The target's own settings decide what counts as a change: Min Change % (2% by default) and Decreases only (damage), which is on by default. While that target setting is on, increases never reach this node, so turn it off to react to healing.

Damage Taken

Fires when a health bar or meter drops.

Delta % is negative. To use the damage as an intensity, make it positive first: add a Math node set to Subtract, wire Delta % to its B input, and leave A unconnected so it counts as 0.

OCR Detected

Fires when a text target sees one of its keywords, or its number changes.

A keyword fires once when it appears, and not again until it has disappeared and come back. For keyword matches, Previous Number and Delta Number are empty. New text targets look for the keyword "Eliminated" until you change it.

Actions

The two screenshot actions let a flow check the screen on demand instead of using background detection. They continue through Done even when they fail; check Success, Found, or Error.

Take Screenshot

Captures the screen.

Detect Image

Looks for an image file inside a screenshot.

Found is false when nothing matched well enough; Error explains other failures, such as a missing file or an image larger than the screenshot.

Start Detection

Starts background detection, as if you clicked Start Detection on the page.

Stop Detection

Stops background detection.

Contributors

Thank you to everyone who has helped improve this documentation.

bwmp