Skip to main content

Rigi Documentation

Advanced scan settings

You can fine-tune how Rigi Snapshot interprets snapshots for each project. To access advanced scan settings, perform the following steps:

  1. Select the required project from the project menu in the top left-hand corner of the display.

  2. Click the Settings.png icon next to the project menu, then select the Project Settings option.

    Scan_settings.png

  3. In the Edit Project popup, click the Settings button. The Settings popup is displayed.

    Scan_settings_all.png

Scroll down to the bottom of the Settings popup to display the following buttons:

  • Open Folder. Click to open the project folder on your local machine.

  • Export Debug. Click to create a debug package that can be sent to the Rigi team for troubleshooting. For details, see the Debug Settings section below.

  • Settings Reference. Click to display detailed information about advanced scan settings.

Advanced scan settings are managed in the following expandable sections:

Capture_settings.png

This section contains the most frequently adjusted settings:

  • Scan Text Markers. This setting defines which delimiters are to be used to identify translatable texts on snapshots:

    • Auto (recommended): when you select this option, delimiters are automatically detected from the strings defined on the Rigi server.

      Select this option when your Rigi strings already include delimiters. The app will derive the pair from the longest common prefix and suffix.

    • macOS: [#   #].

    • Windows: {{ ... }}.

    • Custom: when you select this option, additional fields in which you can enter custom start and end markers are displayed in the Scan Text Markers section below.

      Select this option when you need a different pattern, or need to add OCR-specific corrections.

  • Text Alignment. This setting defines how text alignment is detected for each translatable text:

    • Neighbours (recommended, best for mixed layouts): when you select this option, the Rigi Snapshot app scans left and right from the text edges to identify changes in background color, then compares distances to determine the alignments.

    • Left: when you select this option, Rigi Snapshot classifies texts as left-aligned unless their right edge clearly aligns with neighbors.

    • Center: when you select this option, Rigi Snapshot classifies text as center-aligned if its midpoint is near the screen center.

  • Auto Sync Strings. This setting specifies whether Rigi strings are downloaded automatically when you open or switch to the project.

    Automatic string synchronization is only possible when the URL of the corresponding Rigi project and API key have been defined in the project.

  • Auto-Expand Text Areas. When enabled, this setting expands translatable text regions to provide more space for translations, which are often longer than the source text.

  • Imported Image Scaling. This setting specifies the multiplier applied to imported images before OCR. This functionality is especially useful when your source screenshots are larger than the target device resolution.

  • Show large preview warnings. This setting specifies whether the warning about overlarge images is displayed when using the drag-and-drop image import.

Image_preprocessing.png

In this section, you can adjust text contrast so that even faint, low-contrast text can be read correctly by OCR. The Increase Image Contrast setting darkens the text for scanning purposes, without changing how the preview looks. Increase the value gradually until the missing faint text is recognized.

Scan_text_markers.png

This section displays the delimiters for scan text markers selected in the Capture Settings section. Here, you can add a custom list of common misreadings (Start and End Corrections), for example, T# → [#, so the matching still works when OCR misreads the delimiter.

In the Excluded Patterns field, you can enter patterns that should be skipped during matching, for example, [# %@. #].

When the Custom option is selected for scan text markers, two additional fields, Start Markers and End Markers, are displayed, in which you can enter your own delimiter pair.

Text_Alignment.png

In this section, you can fine-tune how Rigi Snapshot defines translatable text alignment in the generated preview for unusual UIs.

Important

Most projects do not require any additional adjustments. Only adjust the text alignment settings if alignment looks wrong in the preview.

  • Alignment Sensitivity. This setting defines the maximum pixel difference between left and right neighbor distances for edges that are to be considered aligned. Lower values result in stricter, more precise alignment detection. For imperfect layouts, higher values might work better.

  • Background Sensitivity. This setting defines how strictly background is distinguished from content when scanning for alignment neighbors. Increase the value for noisy or gradient backgrounds. Decrease for clean images for which precision matters.

  • Scan Range. This setting defines the maximum number of pixels around text edges, after which scanning for neighbors must stop. Increase the value for wide layouts with distant neighbors. Decrease to speed up the processing for narrow layouts.

Auto_expand.png

In this section, you can specify how Rigi Snapshot creates additional space for translated texts in previews.

  • Expand Direction. This setting defines the expansion direction:

    • Alignment (recommended): expand opposite to the text's alignment anchor.

    • Left / Right: always expand in one of the selected directions.

    • Both: expand equally in both directions.

  • Expand Padding. This setting defines how far from neighboring labels or color changes expansion will stop.

Screenshot_boundaries.png

In this section, you can exclude parts of the screenshot from scanning. This option is useful when the app's chrome (a status bar, a device frame, a debug overlay) contains text you don't want to treat as translatable.

We highly recommend keeping the default settings.

Text_Matching.png

In this section, you can define how aggressively Rigi Snapshot matches detected text to strings in your Rigi project. By relaxing strict text matching or adjusting texts that the OCR keeps reading incorrectly, you can prevent visual text recognition mistakes.

  • Tolerate OCR Errors. When enabled, this setting tolerates common OCR confusions such as I/l/1, O/0, S/5, rn/m. Default: on. Only turn this setting off when you specifically need to tell these characters apart.

  • Case-Insensitive Matching. When enabled, this setting converts all text to lowercase before matching (recommended for OCR). Default: on. Only turn this setting off for case-sensitive content, such as code snippets or identifiers.

  • Character Matching. This setting defines how closely a scan must match a lookup string. At 0%, only exact matches count. Increase the value to permit approximate matches, such as typos or OCR slips. We recommend starting at 5%.

    Numbered prefixes such as 1. and 2. always match exactly.

    When two strings are equally close, the result is flagged as ambiguous rather than guessed.

  • Strip Leading Symbols. Use this setting when OCR adds a stray character at the start of a line, which stops the line matching (for example, when a triangular icon is read as the letter “A”). List the characters that should be dropped, separated by commas. The listed characters will be removed from the start of every scanned line, for example, turning A {{Text}} into {{Text}}.

    Matching is case-sensitive, so standard words like “Account” are not affected.

  • Ignore Characters. Use this setting to remove specific characters from both OCR text and lookup strings before matching. List the characters that are used in your app but should be ignored, for example, formatting markers, such as *, _, or stray symbols, such as |.

    Keep this list short to avoid stripping necessary characters.

  • Placeholders from Server. This setting is read-only and displays the regex patterns set on your RIGI server.

  • Custom Placeholders. Use this setting to list your own regex patterns, separated by commas. If your app uses Apple style specifiers, add them to this list.

  • Skip Placeholders-Only Strings. When enabled, this setting ignores strings that only contain placeholders and punctuation. Default: on.

Preview_styling.png

In this section, you can fine-tune how the generated HTML previews will look, so they match your app's rendering style.

  • Preview Font. In this section, you can check which font type is applied to the Rigi previews, select another one from the list of built-in preset fonts, or upload your own font.

    Default font

    The default option Auto (match scan markers) applies the 'Segoe UI' font for Windows markers ({{ }}) and 'San Francisco' for all other markers. The currently applied font is displayed in the Resolved field below.

    • To apply another built-in font, open the dropdown menu and select the required platform and font pair: iOS/macOS (San Francisco), Windows (Segoe UI), or Android (Roboto).

    • To use a custom font, open the dropdown menu and select the Custom... option. Two additional fields will be displayed below.

      • In the Font Head HTML field, paste the <link> tags from any web-font provider (Google Fonts, Adobe Fonts, etc.) or add your own @font-face <style> block.

      • In the Font Family field, enter the CSS font-family stack that selects the font you defined above.

      Example 33. Adding JetBrains Mono from Google Fonts
      1. Open the Settings menu in the Rigi Snapshot app, as described in steps 1-3 above.

      2. Open the Preview Styling section.

      3. In the Preview Font dropdown menu, select the Custom... option.

      4. Open the JetBrains Mono font page on Google Fonts.

      5. Click the Get font button in the top right-hand corner of the screen, then click the <> Get embed code button.

        Important

        Make sure you only add the single font needed for the Rigi previews.

      6. In the Web tab, select the <link> radio button.

        Add_font.png

      7. Copy the code from the Embed code in the<head> of your html field. In the Rigi Snapshot app, paste this code into the Font Head HTML field.

      8. Copy the font-family value from the JetBrains Mono: CSS class for a variable style field. In the Rigi Snapshot app, paste this value into the Font Family field.

        Add_font_1.png

      9. In the Rigi Snapshot app, click the Save button at the bottom of the Settings popup.

      Rigi previews now render translated text in JetBrains Mono font.


  • Font Size. This setting adjusts text size in the preview relative to the detected size in the screenshot. Increase the value if the text on the preview appears smaller than the original. Decrease if the text appears too large.

  • Font Weight. This setting adjusts how bold or light text appears in the preview. Increase the value if the bold text appears too light. Decrease if regular text appears bold.

  • Line Height. This setting adjusts vertical spacing between lines of text on the preview.

  • Letter Spacing. This setting adjusts the spacing between individual characters on the preview.

  • Vertical Offset. This setting adjusts vertical text shifting on the preview. Use it if the text appears shifted vertically compared to the original.

  • Horizontal Offset. This setting adjusts horizontal text shifting on the preview. Use it if the text appears shifted horizontally compared to the original.

  • Region Border Width. This setting defines the borders drawn around each text region on the preview. Increase for more visible region outlines. Set to 0 to hide borders entirely.

Debug.png

In this section, you can manage the following settings:

  • Enable Debug Mode. When enabled, Rigi Snapshot generates additional debug overlays for each capture, enables the Screenshot and Debug layers in the viewer, logs additional details to the console, and creates a debug.png file with analysis overlays next to each preview. Switch this toggle on when investigating a bad capture, or leave it off for regular use.

  • Keep Uploaded Files. When enabled, Rigi Snapshot retains uploaded ZIP files in the rigi_uploads folder instead of deleting them. Switch this toggle on to verify what was sent to the server, or leave it off to save disk space.