> For the complete documentation index, see [llms.txt](https://docs.vntranslator.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vntranslator.com/gx-project/ocr.md).

# OCR

{% embed url="<https://www.youtube.com/watch?v=1b3l6RLM0_Q>" %}

## Introduction

GX-OCR was originally planned as a new feature for VNTranslator. However, during development, we found that integrating it would make the configuration overly complex and potentially confusing for users. As a result, we decided to develop GX-OCR as a standalone application with several specialized features.

Key Features of GX-OCR:

* Optimized for Window Capture with multi-region support
* Region positions automatically adjust to the game window (e.g., when the window is moved or resized)
* Translated text appears in an overlay above the original text and can be customized (similar to the Hyper Overlay feature in VNTranslator)
* Only supports modern OCR engines with priority given to offline OCR engines
* Only supports translation services officially through API integration

## Download

* Patreon: <https://www.patreon.com/collection/1931982>
* Itch: <https://fazx.itch.io/gx-ocr>

***

## Interface

<figure><img src="https://4121582948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKz66WcKqTPRwdFrHi4mM%2Fuploads%2FIS9wJel9BHLdPNEiCMej%2Fgx-banner-1500.jpg?alt=media&amp;token=0f99936f-1ce8-4c69-b6ab-33063bee11c2" alt=""><figcaption></figcaption></figure>

#### Dock Buttons

1. **Capture** (Double click to enable/disable auto capture)
2. **Region** (Double click to show/hide region)
3. **Image Source**
4. **OCR Mode**
5. **Settings**

***

## Quick Start

### 1. Screen and Window Scaling

{% hint style="info" %}
If your monitor is set to a scale greater than 100%, you need to adjust the screen capture and window capture scale settings
{% endhint %}

* Go to **Settings -> General**
* In the **Screen Capture** section, adjust the **Scale** value
* In the **Window Capture** section, adjust the **Scale** value

### 2. OCR Engine & Translation Service

Before using GX-OCR, configure your OCR Engine for text recognition and set up your preferred Translation Service.

{% hint style="info" %}
By default, the OCR Engine is set to `Rapid OCR - OpenVino (English, Chinese, Japanese)`
{% endhint %}

{% embed url="<https://app.guideflow.com/player/6kwjv5lczp>" fullWidth="false" %}

### 3. Game Overlay (Basic)

{% embed url="<https://app.guideflow.com/player/dr9lm5ecor>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.vntranslator.com/gx-project/ocr.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.