nut.js icon indicating copy to clipboard operation
nut.js copied to clipboard

OCR `saveSearchImageToFile` parameter

Open joel-duffie opened this issue 8 months ago • 0 comments

Short overview Provide the ability to save an image of the search area from a screen.find(singleWord/textLine) call.

Use case To more easily debug OCR match fails.

Detailed description Just like screen.find(image) can be given providerData: { saveSearchImageToFile } to save the search area and input images to disk, OCR should have the same ability, but because there is no search input image, it would just save the search area image.

Additional content The call would look like this:

await nut.screen.find(textLine("this is a test"), { 
   searchRegion: myRegion, 
   providerData: { 
      saveSearchImageToFile: true 
   }
}

And it would save the search area (bounded by myRegion) to the current working directory, OR, if specified, to a different provided directory under a given filename.

joel-duffie avatar Jun 06 '24 14:06 joel-duffie