@regolithco/ocr

OCR utilities using PaddleOCR, designed for RegolithCo applications. This library provides OCR capabilities for parsing specific game assets like Mining Orders and Rocks, with support for Browser environments.

Installation

yarn add @regolithco/ocr

Usage

This library exports specific parsers for game entities.

Parsing Shipping Orders

import { parseShipMiningOrder } from '@regolithco/ocr'

// In Node.js environment
const result = await parseShipMiningOrder('path/to/image.png')
console.log(result)

Parsing Rocks

import { parseShipRock } from '@regolithco/ocr'

const result = await parseShipRock('path/to/image.png')
console.log(result)

Development

Clone the repository and install dependencies:

yarn install

Scripts

• yarn build: Compile TypeScript to dist/.
• yarn test: Run unit tests using Jest.
• yarn debug: Run the PaddleOCR debug script on test images.
• yarn debug:choose: Run the debug script with an interactive file chooser.

Adding a new image

1. add it to the appropriate folder.
2. Run yarn debug:choose to see if it works.
3. If it doesn't, you can run yarn debug to see the raw output and adjust the parser.

License

ISC