(New Feature) Added colorblind mode to all overlays (#634)

Author: chrizzocb

README.md

@@ -107,6 +107,7 @@ The config folder in `C:/Users/<WINDOWS_USER>/.d4lf` contains:
 | minimum_overlay_font_size                         | The minimum font size for the vision overlay, specifically the green text that shows which filter(s) are matching. Note: For small profile names, the font may actually be larger than this size but will never go below this size.                                                                                                                                                                                                      |
 | move_to_inv_item_type<br/>move_to_stash_item_type | Which types of items to move when using fast move functionality. Will only affect tabs defined in check_chest_tabs. You can select more than one option. <br>- `favorites`: Move favorites only <br>- `junk`: Move junk only <br>- `unmarked`: Only items not marked as favorite or junk <br>- `everything`: Move everything                                                                                                             |
 | run_vision_mode_on_startup                        | If the vision mode should automatically start when starting d4lf. Otherwise has to be started manually with the vision button or the hotkey                                                                                                                                                                                                                                                                                              |
+| colorblind_mode                                   | Enable a colorblind friendly palette for loot filter and paragon overlays                                                                                                                                                                                                                                                                                                                                                                |
 | vision_mode_type                                  | Which vision mode you would like to use?. `highlight_matches` does the classic green highlighting of affixes on screen, but is slightly slower. `fast` just puts green text on screen but is very fast and works with controllers.                                                                                                                                                                                                       |
 
 | [char]    | Description                       |

src/config/models.py

@@ -373,6 +373,9 @@ class GeneralModel(_IniBaseModel):
     )
     run_vision_mode_on_startup: bool = Field(default=True, description="Whether to run vision mode on startup or not")
     theme: ThemeType = Field(default=ThemeType.dark, description="Choose between light and dark theme for the GUI")
+    colorblind_mode: bool = Field(
+        default=False, description="Enable a colorblind friendly palette for loot filter and paragon overlays"
+    )
     vision_mode_type: VisionModeType = Field(
         default=VisionModeType.highlight_matches,
         description="Should the vision mode use the slightly slower version that highlights matching affixes, or the immediate version that just shows text of the matches? Note: highlight_matches does not work with controllers.",

src/scripts/common.py

@@ -3,6 +3,7 @@
 import logging
 import sys
 import time
+from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -30,11 +31,47 @@
 
 SETUP_INSTRUCTIONS_URL = "https://github.com/d4lfteam/d4lf/blob/main/README.md#how-to-setup"
 
-COLOR_GREEN = "#23fc5d"  # Matched a profile
-COLOR_RED = "#fc2323"  # Matched no profiles at all
-COLOR_ORANGE = "#fca503"  # Matched a codex upgrade
-COLOR_GREY = "#888888"  # Still processing or can't find the info we expect
-COLOR_BLUE = "#00b3b3"  # We recognize this as an item, but it is not one we handle
+
+@dataclass(frozen=True, slots=True)
+class FilterColors:
+    """Color palette used by the loot filter / vision overlays."""
+
+    matched: str
+    no_match: str
+    codex_upgrade: str
+    processing: str
+    unhandled: str
+
+
+# Default palette.
+FILTER_COLORS_DEFAULT = FilterColors(
+    matched="#23fc5d",  # COLOR_GREEN-Matched a profile
+    no_match="#fc2323",  # COLOR_RED-Matched no profiles at all
+    codex_upgrade="#fca503",  # COLOR_ORANGE-Matched a codex upgrade
+    processing="#888888",  # COLOR_GREY-Still processing or can't find the info we expect
+    unhandled="#00b3b3",  # COLOR_BLUE-We recognize this as an item, but it is not one we handle
+)
+
+# Colorblind-friendly palette (Okabe-Ito inspired).
+FILTER_COLORS_COLORBLIND = FilterColors(
+    matched="#56B4E9",  # COLOR_BLUE-Matched a profile
+    no_match="#D55E00",  # COLOR_VERMILLION-Matched no profiles at all
+    codex_upgrade="#E69F00",  # COLOR_ORANGE-Matched a codex upgrade
+    processing="#888888",  # COLOR_GREY-Still processing or can't find the info we expect
+    unhandled="#CC79A7",  # COLOR_PURPLE-We recognize this as an item, but it is not one we handle
+)
+
+
+def get_filter_colors() -> FilterColors:
+    """Return the active palette (default vs. colorblind mode)."""
+    try:
+        if IniConfigLoader().general.colorblind_mode:
+            return FILTER_COLORS_COLORBLIND
+    except Exception:
+        # Fail-safe: if config isn't available yet, use defaults.
+        LOGGER.debug("get_filter_colors(): config unavailable; using default palette", exc_info=True)
+    return FILTER_COLORS_DEFAULT
+
 
 ASPECT_UPGRADES_LABEL = "AspectUpgrades"
 

src/scripts/vision_mode_fast.py

@@ -12,7 +12,7 @@
 from src.config.ui import ResManager
 from src.item.data.rarity import ItemRarity
 from src.item.filter import Filter, MatchedFilter
-from src.scripts.common import ASPECT_UPGRADES_LABEL, COLOR_GREEN, COLOR_ORANGE, is_ignored_item
+from src.scripts.common import ASPECT_UPGRADES_LABEL, get_filter_colors, is_ignored_item
 from src.tts import Publisher
 from src.utils.custom_mouse import mouse
 from src.utils.window import screenshot
@@ -135,15 +135,15 @@ def on_tts(self, _):
             match = res.keep
 
             if match:
-                color = COLOR_GREEN
+                color = get_filter_colors().matched
                 if not res.matched:
                     if item_descr.rarity == ItemRarity.Unique:
                         text = ["Unique"]
                     elif item_descr.rarity == ItemRarity.Mythic:
                         text = ["Mythic (Always Kept)"]
                 else:
                     if any(res_matched.profile.endswith(ASPECT_UPGRADES_LABEL) for res_matched in res.matched):
-                        color = COLOR_ORANGE
+                        color = get_filter_colors().codex_upgrade
                     text = create_match_text(reversed(res.matched))
                 return self.request_draw("\n".join(text), color)
             self.request_clear()

src/scripts/vision_mode_with_highlighting.py

@@ -19,17 +19,7 @@
 from src.item.data.item_type import is_sigil
 from src.item.filter import Filter, FilterResult
 from src.item.find_descr import find_descr
-from src.scripts.common import (
-    ASPECT_UPGRADES_LABEL,
-    COLOR_BLUE,
-    COLOR_GREEN,
-    COLOR_GREY,
-    COLOR_ORANGE,
-    COLOR_RED,
-    is_ignored_item,
-    is_junk_rarity,
-    reset_canvas,
-)
+from src.scripts.common import ASPECT_UPGRADES_LABEL, get_filter_colors, is_ignored_item, is_junk_rarity, reset_canvas
 from src.tts import Publisher
 from src.ui.char_inventory import CharInventory
 from src.ui.stash import Stash
@@ -221,44 +211,46 @@ def draw_empty_outline(self, item_roi, color, text: str | None):
 
     def draw_match_outline(self, item_roi, should_keep_res, item_descr):
         x, y, w, h, off = self.get_coords_from_roi(item_roi)
-        self.create_signal_rect(self.canvas, w, self.thick, COLOR_GREEN)
+        self.create_signal_rect(self.canvas, w, self.thick, get_filter_colors().matched)
 
         # show all info strings of the profiles
         text_y = h
         for match in reversed(should_keep_res.matched):
-            text_y = self.draw_text(self.canvas, match.profile, COLOR_GREEN, text_y, 5, w // 2)
+            text_y = self.draw_text(self.canvas, match.profile, get_filter_colors().matched, text_y, 5, w // 2)
         # Show matched bullets
         if item_descr and len(should_keep_res.matched) > 0:
             bullet_width = self.thick * 3
             for affix in should_keep_res.matched[0].matched_affixes:
                 if affix.loc:
-                    self.draw_rect(self.canvas, bullet_width, affix, off, COLOR_GREEN)
+                    self.draw_rect(self.canvas, bullet_width, affix, off, get_filter_colors().matched)
 
             if item_descr.aspect and item_descr.aspect.loc and any(m.did_match_aspect for m in should_keep_res.matched):
-                self.draw_rect(self.canvas, bullet_width, item_descr.aspect, off, COLOR_GREEN)
+                self.draw_rect(self.canvas, bullet_width, item_descr.aspect, off, get_filter_colors().matched)
 
         self.root.update_idletasks()
         self.root.update()
 
     def draw_no_match_outline(self, item_roi):
         x, y, w, h, off = self.get_coords_from_roi(item_roi)
-        self.create_signal_rect(self.canvas, w, self.thick, COLOR_RED)
+        self.create_signal_rect(self.canvas, w, self.thick, get_filter_colors().no_match)
         self.root.update_idletasks()
         self.root.update()
 
     def draw_codex_upgrade_outline(self, item_roi, should_keep_result: FilterResult):
         x, y, w, h, off = self.get_coords_from_roi(item_roi)
 
-        self.create_signal_rect(self.canvas, w, self.thick, COLOR_ORANGE)
+        self.create_signal_rect(self.canvas, w, self.thick, get_filter_colors().codex_upgrade)
 
         # show string indicating that this item upgrades the codex
         if len(should_keep_result.matched) == 1 and should_keep_result.matched[0].profile == ASPECT_UPGRADES_LABEL:
-            self.draw_text(self.canvas, "Codex Upgrade", COLOR_ORANGE, h, 5, w // 2)
+            self.draw_text(self.canvas, "Codex Upgrade", get_filter_colors().codex_upgrade, h, 5, w // 2)
         else:
             # This matched an Aspects section in a profile, write the profiles
             text_y = h
             for match in reversed(should_keep_result.matched):
-                text_y = self.draw_text(self.canvas, match.profile, COLOR_ORANGE, text_y, 5, w // 2)
+                text_y = self.draw_text(
+                    self.canvas, match.profile, get_filter_colors().codex_upgrade, text_y, 5, w // 2
+                )
 
         self.root.update_idletasks()
         self.root.update()
@@ -346,12 +338,12 @@ def evaluate_item_and_queue_draw(self, item_descr: Item):
                         if ignored_item:
                             if item_descr.sanctified:
                                 self.request_empty_outline(
-                                    item_descr, item_roi, COLOR_BLUE, "Sanctified (Not Supported)"
+                                    item_descr, item_roi, get_filter_colors().unhandled, "Sanctified (Not Supported)"
                                 )
                             else:
-                                self.request_empty_outline(item_descr, item_roi, COLOR_BLUE)
+                                self.request_empty_outline(item_descr, item_roi, get_filter_colors().unhandled)
                         else:
-                            self.request_empty_outline(item_descr, item_roi, COLOR_GREY)
+                            self.request_empty_outline(item_descr, item_roi, get_filter_colors().processing)
 
                         # Since we've now drawn something we kick off a thread to remove the drawing
                         # if the item is unselected. It is also automatically removed if a different