lm
/
ICRA
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: use new config.toml with detailed comments and update readme

This commit is contained in:
lukas 2026-03-24 23:23:00 +01:00
parent 46e1eb0925
commit e13bef7f52
3 changed files with 12 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -44,7 +44,7 @@ To ensure accurate statistics, ICRA automatically filters out the image backgrou
Use the **Exclusion Tool** to draw rectangles or polygons over areas you want to ignore. This is essential for focusing your analysis on specific parts of a complex image while ignoring background noise or irrelevant details.
### 5. Configuration (`config.toml`)
The application is highly customizable via `config.toml`. A `config.toml.example` file is included in the repository—simply copy it to `config.toml` to gain fine control over default application sliders, language selection, UI masking colors, and initial background exclusion tolerances.
The application is highly customizable via `config.toml`. This file is included in the repository and contains detailed comments explaining each available setting—from default sliders and language selection to UI masking colors and initial background exclusion tolerances.
## Typical Workflow

13
config.toml
View File

@ -3,17 +3,26 @@
language = "en"
[options]
# Set to true to clear exclusion shapes whenever the image changes.
# Set to true to clear exclusion shapes whenever the image changes in the preview viewer.
reset_exclusions_on_image_change = false
# Hex color code for the match overlay (e.g. "#ff0000" for Red, "#00ff00" for Green)
# This is the color that paints over pixels that successfully match your HSV ranges.
overlay_color = "#ff0000"
# Hex color code for the background to be excluded (default #1f2937)
# This is useful for automatically removing flat background colors from UI screenshots
# or web scrapings before the analysis runs.
exclude_bg_color = "#1f2937"
# Tolerance for background color matching (0-255, default 5)
# A higher value will exclude pixels that are "close" to the hex color above, allowing
# you to bypass slight compression artifacts or noise in the image background.
exclude_bg_tolerance = 5
[defaults]
# Override any of the following keys to tweak the initial slider values:
# Override any of the following keys to tweak the initial slider values whenever
# the application starts.
# hue_min, hue_max, sat_min, val_min, val_max accept floating point numbers.
# alpha accepts an integer between 0 and 255.
hue_min = 250.0

34
config.toml.example
View File

@ -1,34 +0,0 @@
# Optional global settings
# language must correspond to a file name in app/lang (e.g. "en", "de").
language = "en"
[options]
# Set to true to clear exclusion shapes whenever the image changes in the preview viewer.
reset_exclusions_on_image_change = false
# Hex color code for the match overlay (e.g. "#ff0000" for Red, "#00ff00" for Green)
# This is the color that paints over pixels that successfully match your HSV ranges.
overlay_color = "#ff0000"
# Hex color code for the background to be excluded (default #1f2937)
# This is useful for automatically removing flat background colors from UI screenshots
# or web scrapings before the analysis runs.
exclude_bg_color = "#1f2937"
# Tolerance for background color matching (0-255, default 5)
# A higher value will exclude pixels that are "close" to the hex color above, allowing
# you to bypass slight compression artifacts or noise in the image background.
exclude_bg_tolerance = 5
[defaults]
# Override any of the following keys to tweak the initial slider values whenever
# the application starts.
# hue_min, hue_max, sat_min, val_min, val_max accept floating point numbers.
# alpha accepts an integer between 0 and 255.
hue_min = 250.0
hue_max = 310.0
sat_min = 15.0
sat_max = 100.0
val_min = 15.0
val_max = 100.0
alpha = 150