Added additional warnings if TTS is not connected to guide people to the setup guide

.github/workflows/release.yml

@@ -75,13 +75,14 @@ jobs:
           } | ConvertTo-Json
           Invoke-RestMethod -Uri $webhookUrl -Method Post -ContentType "application/json" -Body $payload
 
-      # From: https://github.com/SethCohen/github-releases-to-discord
-      - name: Github Releases To Discord
-        uses: SethCohen/github-releases-to-discord@master
-        with:
-          webhook_url: ${{ secrets.DISCORD_WEBHOOK }}
-          color: "2105893"
-          username: "D4LF Release"
+# Also not working, have a request out here: https://github.com/SethCohen/github-releases-to-discord/issues/29
+#      # From: https://github.com/SethCohen/github-releases-to-discord
+#      - name: Github Releases To Discord
+#        uses: SethCohen/github-releases-to-discord@master
+#        with:
+#          webhook_url: ${{ secrets.DISCORD_WEBHOOK }}
+#          color: "2105893"
+#          username: "D4LF Release"
 
 # Not currently working, but I have an issue out for it: https://github.com/nhevia/discord-styled-releases/issues/12
 #      - name: Sending message to Discord with release notes

src/main.py

@@ -20,13 +20,12 @@
 from src.item.filter import Filter
 from src.logger import LOG_DIR
 from src.overlay import Overlay
+from src.scripts.common import SETUP_INSTRUCTIONS_URL
 from src.scripts.handler import ScriptHandler
 from src.utils.window import WindowSpec, start_detecting_window
 
 LOGGER = logging.getLogger(__name__)
 
-SETUP_INSTRUCTIONS_URL = "https://github.com/d4lfteam/d4lf/blob/main/README.md#how-to-setup"
-
 
 def main():
     # Create folders for logging stuff
@@ -105,22 +104,25 @@ def check_for_proper_tts_configuration():
 
 
 def get_d4_local_prefs_file() -> Path | None:
-    documents_file = pathlib.Path.home() / "Documents" / "Diablo IV" / "LocalPrefs.txt"
-    onedrive_file = pathlib.Path.home() / "OneDrive" / "Documents" / "Diablo IV" / "LocalPrefs.txt"
+    all_potential_files: list[Path] = [
+        pathlib.Path.home() / "Documents" / "Diablo IV" / "LocalPrefs.txt",
+        pathlib.Path.home() / "OneDrive" / "Documents" / "Diablo IV" / "LocalPrefs.txt",
+        pathlib.Path.home() / "OneDrive" / "MyDocuments" / "Diablo IV" / "LocalPrefs.txt",
+    ]
 
-    if documents_file.exists() and onedrive_file.exists():
-        # Return the newest of the two
-        if documents_file.stat().st_mtime > onedrive_file.stat().st_mtime:
-            return documents_file
-        return onedrive_file
+    existing_files: list[Path] = [file for file in all_potential_files if file.exists()]
 
-    if documents_file.exists():
-        return documents_file
+    if len(existing_files) == 0:
+        return None
 
-    if onedrive_file.exists():
-        return onedrive_file
+    if len(existing_files) == 1:
+        return existing_files[0]
 
-    return None
+    most_recently_modified_file = existing_files[0]
+    for existing_file in existing_files[1:]:
+        if existing_file.stat().st_mtime > most_recently_modified_file.stat().st_mtime:
+            most_recently_modified_file = existing_file
+    return most_recently_modified_file
 
 
 if __name__ == "__main__":

src/scripts/common.py

@@ -8,6 +8,8 @@
 
 LOGGER = logging.getLogger(__name__)
 
+SETUP_INSTRUCTIONS_URL = "https://github.com/d4lfteam/d4lf/blob/main/README.md#how-to-setup"
+
 
 def mark_as_junk():
     keyboard.send("space")

src/scripts/handler.py

@@ -16,6 +16,7 @@
 from src.config.loader import IniConfigLoader
 from src.config.models import ItemRefreshType, UseTTSType
 from src.loot_mover import move_items_to_inventory, move_items_to_stash
+from src.scripts.common import SETUP_INSTRUCTIONS_URL
 from src.ui.char_inventory import CharInventory
 from src.ui.chest import Chest
 from src.utils.custom_mouse import mouse
@@ -55,7 +56,13 @@ def setup_key_binds(self):
 
     def filter_items(self, force_refresh=ItemRefreshType.no_refresh):
         if IniConfigLoader().general.use_tts in [UseTTSType.full, UseTTSType.mixed]:
-            self._start_or_stop_loot_interaction_thread(run_loot_filter, (force_refresh, True))
+            if src.tts.CONNECTED:
+                self._start_or_stop_loot_interaction_thread(run_loot_filter, (force_refresh, True))
+            else:
+                LOGGER.warning(
+                    f"TTS connection has not been made yet. Have you followed all of the instructions in {SETUP_INSTRUCTIONS_URL}? "
+                    f"If so, it's possible your Windows user does not have the correct permissions to allow Diablo 4 to connect to a third party screen reader."
+                )
         else:
             self._start_or_stop_loot_interaction_thread(run_loot_filter, (force_refresh, False))
 

src/scripts/loot_filter_tts.py

@@ -46,6 +46,7 @@ def check_items(inv: InventoryBase, force_refresh: ItemRefreshType):
             try:
                 item_descr = src.item.descr.read_descr_tts.read_descr()
                 LOGGER.debug(f"Attempt {retry_count} to parse item based on TTS: {item_descr}")
+                retry_count += 1
             except Exception:
                 screenshot("tts_error", img=img)
                 LOGGER.exception(f"Error in TTS read_descr. {src.tts.LAST_ITEM=}")

src/tts.py

@@ -10,6 +10,7 @@
 from src.config.helper import singleton
 
 LAST_ITEM = []
+CONNECTED = False
 LOGGER = logging.getLogger(__name__)
 _DATA_QUEUE = queue.Queue(maxsize=100)
 TO_FILTER = ["Champions who earn the favor of"]
@@ -73,6 +74,8 @@ def read_pipe() -> None:
 
         win32pipe.ConnectNamedPipe(handle, None)
         LOGGER.debug("TTS client connected")
+        global CONNECTED
+        CONNECTED = True
 
         while True:
             try:
@@ -93,6 +96,7 @@ def read_pipe() -> None:
 
         win32file.CloseHandle(handle)
         print("TTS client disconnected")
+        CONNECTED = False
 
 
 def find_item_start(data: list[str]) -> int | None: