Skip to content

Tego Bot API Documentation v0.2.0


Tego Bot API Documentation / MatchConfig

Interface: MatchConfig ​

Defined in: botjs/src/image-match.ts:34

Configuration options for image template matching

Properties ​

searchMultipleScales? ​

optional searchMultipleScales: boolean

Defined in: botjs/src/image-match.ts:40

Search at multiple scales to find scaled versions of the template. Useful when UI elements may be displayed at different sizes.

Default ​

ts
true

useGrayscale? ​

optional useGrayscale: boolean

Defined in: botjs/src/image-match.ts:47

Convert images to grayscale before matching. Can improve matching for color-independent patterns.

Default ​

ts
false

scaleSteps? ​

optional scaleSteps: number[]

Defined in: botjs/src/image-match.ts:54

Scale factors to search at when searchMultipleScales is true. Values less than 1.0 search for smaller versions of the template.

Default ​

ts
[1.0, 0.9, 0.8, 0.7, 0.6, 0.5]

confidence? ​

optional confidence: number

Defined in: botjs/src/image-match.ts:62

Minimum confidence threshold (0.0 to 1.0). Higher values require closer matches but may miss valid results. Lower values find more matches but may include false positives.

Default ​

ts
0.8

limit? ​

optional limit: number

Defined in: botjs/src/image-match.ts:69

Maximum number of results to return. Results are sorted by confidence descending.

Default ​

ts
100

Released under the MIT License.