> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/rtr46/meikipop/llms.txt
> Use this file to discover all available pages before exploring further.

# Basic usage

> Learn the core workflow of meikipop - from launching the app to looking up Japanese words anywhere on your screen

Meikipop provides instant Japanese dictionary lookups using OCR to read text directly from your screen. This guide covers the essential workflow to get you started.

## Getting started

<Steps>
  <Step title="Launch meikipop">
    Start the application by running the executable or using the command:

    ```bash theme={null}
    python -m src.main
    ```

    Once running, you'll see the meikipop icon in your system tray. A message confirms the app is ready:

    <Info>
      meikipop runs silently in the background. Look for the icon in your system tray (Windows/Linux) or menu bar (macOS).
    </Info>
  </Step>

  <Step title="Select your scan region (first run)">
    The first time you run meikipop in `region` mode, you'll be prompted to select a screen area to scan:

    * Click and drag to select the area containing Japanese text (like a game window or manga reader)
    * Release the mouse to confirm your selection
    * Press `Esc` to cancel

    <Tip>
      The selected region will be sent to the OCR provider. You can change this region anytime from the system tray menu.
    </Tip>
  </Step>

  <Step title="Position your mouse over Japanese text">
    Move your cursor over any Japanese text visible on your screen within the selected region.
  </Step>

  <Step title="Press and hold the hotkey">
    Press and hold the configured hotkey (default: **Shift**) to trigger OCR and display dictionary results.

    <Note>
      The first lookup may take a moment depending on your internet connection, as the screenshot is sent to the OCR provider.
    </Note>
  </Step>

  <Step title="View dictionary entries">
    A popup window appears near your cursor showing:

    * Written form (kanji/kana)
    * Reading in hiragana
    * English definitions
    * Optional: part of speech, tags, deconjugation info

    Keep holding the hotkey and move your mouse to look up additional words.
  </Step>

  <Step title="Release the hotkey">
    Release the hotkey to hide the popup window.
  </Step>
</Steps>

## Using the right-click menu

Right-click the system tray icon to access quick actions:

<Accordion title="Available menu options">
  * **Settings**: Open the full configuration dialog
  * **Reselect Scan Region**: Choose a new area of your screen to scan
  * **Toggle Scan Mode**: Switch between region and fullscreen modes
  * **Enable/Disable Auto Scan Mode**: Toggle continuous scanning
  * **Switch OCR Provider**: Choose between available OCR backends
  * **Quit**: Exit meikipop
</Accordion>

## Hotkey options

You can configure the trigger hotkey in Settings. Available options include:

* `shift` (default)
* `ctrl`
* `alt`
* `ctrl+shift`
* `ctrl+alt`
* `shift+alt`
* `ctrl+shift+alt`

<Warning>
  On macOS, you may need to grant Input Monitoring, Screen Recording, and Accessibility permissions in System Preferences > Security & Privacy.
</Warning>

## Understanding the popup display

The dictionary popup shows entries in this format:

### Vocabulary entries

```
食べる [たべる] [v1, vt]
(1) to eat; (2) to live on; to make a living
```

* **食べる**: Written form (kanji/kana)
* **\[たべる]**: Reading in hiragana
* **\[v1, vt]**: Tags (when enabled)
* Numbered definitions (when "Show All Glosses" is enabled)

### Kanji entries

When "Show Kanji Entries" is enabled:

```
食 [ショク, ジキ, く.う, く.らう, た.べる]
食, eat, food
```

* Large kanji character
* On-yomi and kun-yomi readings
* English meanings
* Optional: example words, radical components

## Tips for efficient lookups

<Tip>
  **Hold and move**: Keep the hotkey pressed while moving your mouse to quickly look up multiple words without repeatedly pressing the key.
</Tip>

<Tip>
  **Auto scan mode**: For even faster lookups, enable auto scan mode from the tray menu. This continuously scans your screen region, eliminating the need to press the hotkey.
</Tip>

<Tip>
  **Max lookup length**: Adjust this setting (default: 25 characters) to control how much text meikipop attempts to match against the dictionary.
</Tip>

## Troubleshooting common issues

<Accordion title="Popup doesn't appear">
  * Verify meikipop is running (check system tray)
  * Ensure you're pressing the correct hotkey
  * Check that your mouse is within the selected scan region
  * Try reselecting the scan region from the tray menu
</Accordion>

<Accordion title="Slow OCR response">
  * First lookup is always slower as it initializes the OCR connection
  * For Google Lens: Enable "Google Lens Compression" in Settings to improve speed on slow connections
  * Consider using auto scan mode for perceived latency improvements
</Accordion>

<Accordion title="Inaccurate OCR results">
  * Ensure text is clear and well-lit
  * Try selecting a more precise scan region
  * Google Lens compression may slightly reduce accuracy for better speed
  * Consider alternative OCR providers like owocr with local models
</Accordion>

## Next steps

<CardGroup cols={2}>
  <Card title="Configuration" icon="gear" href="/user-guide/configuration">
    Customize hotkeys, OCR providers, and lookup behavior
  </Card>

  <Card title="Auto scan mode" icon="radar" href="/user-guide/auto-scan-mode">
    Enable continuous scanning for instant lookups
  </Card>

  <Card title="Themes and appearance" icon="palette" href="/user-guide/themes-and-appearance">
    Personalize popup colors, fonts, and display options
  </Card>
</CardGroup>