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 in 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 will be displayed.

    Scan_settings_all.png

At the bottom of the Settings popup, three buttons are located:

  • 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 divided into 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 the snapshots:

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

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

    • macOS: [#   #].

    • Windows: {{ ... }}.

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

      Select this option when you need a different pattern, or 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: classifies texts as left-aligned unless their right edge clearly aligns with neighbors.

    • Center: classifies text as center-aligned if its midpoint is near the screen center.

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

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

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

  • Imported Image Scaling. This setting defines 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 determines whether the warning about overlarge images is displayed when using the drag-and-drop image import.

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 / 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 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 where precision matters.

  • Scan Range. This setting defines the maximum number of pixels around text edges, after reaching 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 direction.

    • Both: expand equally in both directions.

  • Expand Padding. This setting defines how far from neighboring labels or color changes the 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.

We highly recommend keeping the default settings.

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.

We highly recommend keeping the default settings.

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; leave it off for regular use.

  • Keep Uploaded Files. When enabled, Rigi Snapsh Eot 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; leave it off to save disk space.