GameSentenceMiner 2.2.0__py3-none-any.whl → 2.2.1__py3-none-any.whl

GameSentenceMiner-2.2.1.dist-info/METADATA

@@ -0,0 +1,229 @@
+Metadata-Version: 2.2
+Name: GameSentenceMiner
+Version: 2.2.1
+Summary: A tool for mining sentences from games. Update: Use ffprobe from GSM Directory
+Author-email: Beangate <bpwhelan95@gmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/bpwhelan/GameSentenceMiner
+Project-URL: Repository, https://github.com/bpwhelan/GameSentenceMiner
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: requests~=2.32.3
+Requires-Dist: watchdog~=5.0.2
+Requires-Dist: DateTime~=5.5
+Requires-Dist: pyperclip~=1.9.0
+Requires-Dist: vosk~=0.3.45
+Requires-Dist: soundfile~=0.12.1
+Requires-Dist: toml~=0.10.2
+Requires-Dist: psutil~=6.0.0
+Requires-Dist: rapidfuzz~=3.9.7
+Requires-Dist: obs-websocket-py~=1.0
+Requires-Dist: plyer~=2.1.0
+Requires-Dist: keyboard~=0.13.5
+Requires-Dist: websockets~=13.0.1
+Requires-Dist: stable-ts~=2.17.5
+Requires-Dist: silero-vad~=5.1.2
+Requires-Dist: ttkbootstrap~=1.10.1
+Requires-Dist: dataclasses_json~=0.6.7
+Requires-Dist: numpy
+Requires-Dist: pystray
+Requires-Dist: pywin32
+
+# Game Sentence Miner
+
+This project automates the recording of game sentence audio to help with Anki Card Creation.
+
+This allows us to create cards from texthooker/yomitan, and automatically get screenshot and sentence audio from the
+game we are playing.
+
+Short Demo (Watch this first): https://www.youtube.com/watch?v=J2At52oWieU
+
+Installation: https://www.youtube.com/watch?v=b-L4g9tA508
+
+## Features:
+
+- **OBS Replay Buffer**: Constantly records the last X seconds of gameplay.
+- **Voice Activity Detection**: Automatically cuts the end of the clip to the exact moment the voice ended.
+- **Clipboard Interaction**: Automatically monitors the clipboard for dialogue events.
+- **Websocket Listening**: Listens to a websocket uri for text-events from stuff like Agent/Textractor.
+- **Hotkey Automation**: Single hotkey to trigger video recording, screenshot, and transcription.
+- **1-Click Card Creation**: Monitors anki for new cards from Yomitan, and automatically gets audio from games.
+
+## Prerequisites
+
+- [Python 3.11+](https://www.python.org/downloads/release/python-3119/)
+- Important: 3.13 is [NOT supported](https://stackoverflow.com/questions/79175945/keyerror-version-installing-openai-whisper-on-python-3-13).
+
+---
+
+## 1. Installing and Running the Script
+
+https://pypi.org/project/GameSentenceMiner/
+
+Python + pip needs to be installed, make sure you install 3.11 or higher, since older versions may not be supported.
+
+Install:
+```commandline
+pip install gamesentenceminer
+```
+
+Run:
+```commandline
+gamesentenceminer
+```
+
+On first run, this will download OBS and FFMPEG, and do some basic configuration. You will need to edit the GSM config for your specific Anki fields and whatnot.
+
+---
+
+## 2. Setting Up OBS Replay Buffer
+
+1. Go to Settings > Output > Replay Buffer, and make sure OBS Replay Buffer is enabled, I recommend setting it to 60 seconds, but shorter and longer buffers should also work.
+2. Set Scene/Source. I recommend using "Game Capture" with "Capture Audio" Enabled. And then mute Desktop/microphone
+    1. If "Game Capture" Does not work, use "Window Capture".
+    2. I recommend having a Scene PER Game, with the name of the scene labeled as the game, this makes it easier for the
+       script to know (with a config option) what game you are playing.
+3. In Output Settings, set "Recording Format" to mkv, and "Audio Encoder" to Opus. Alternate Audio Encoder settings are supported, but will be re-encoded to Opus by default.
+
+Here are the Settings I use in OBS. Make sure the recordings folder is the same as the "folder_to_watch" in the config.
+![image](https://github.com/user-attachments/assets/0056816d-af3c-4a3c-bc6a-4aff5c28cadb)
+![image](https://github.com/user-attachments/assets/dd2f95a6-f546-41d9-8136-de7b1b035a5d)
+
+---
+
+## 3. Configuring the App.
+
+### Configuration GUI
+
+The `GameSentenceMiner` project now includes a graphical interface to simplify configuration. With default values
+already set, this GUI lets you adjust settings as needed. Here’s how to get started:
+
+#### Running the Configuration GUI
+
+To open the GUI, you have two options:
+
+1. **Tray Icon**: Right Click the Tray Icon and Click `Open Settings`
+
+#### Default Settings and Customization
+
+The GUI loads with default values for each setting, so if you’re just getting started, you may only need to change options
+in the "path" config. If you make changes, remember to click **Save Settings** to apply them.
+Please take a second to look through the config to see what is available, there is a lot of extra functionality hidden
+behind config options.
+
+![image](https://github.com/user-attachments/assets/ffac9888-de0a-412b-817f-e22a55ce7b55)![image](https://github.com/user-attachments/assets/981c112a-1ddc-4e07-9c39-57fe46644ff5)![image](https://github.com/user-attachments/assets/29470a97-6013-4ca8-9059-48af735eb3a8)![image](https://github.com/user-attachments/assets/8e9c8f03-dc43-4822-a3c5-43f36ca65364)
+
+
+---
+
+
+## 4. One Click Card Creation
+
+This is the flagship feature of this script, so here is a section explaining it. It is possible to do full 1-click card
+creation with this tool + Yomitan/JL. The relevant settings are located in `Features` and `OBS` section in the config.
+
+Demo: https://www.youtube.com/watch?v=9dmmXO2CGNw
+
+Screenshots to help with setup (THIS IS ALREADY DONE FOR YOU IN NEWER VERSIONS):
+
+![image](https://github.com/user-attachments/assets/7de031e9-ce28-42eb-a8fd-0e60ef70dc3d)
+
+![image](https://github.com/user-attachments/assets/b0c70a1a-65b5-4fe7-a7e4-ccb0b9a5b249)
+
+![image](https://github.com/user-attachments/assets/4cf492eb-12a2-429f-aa0e-f87fc0fa6270)
+
+## 4. Example Process
+
+1. Start script: `gamesentenceminer`
+2. Start game
+3. Hook Game with Agent (or textractor) with clipboard enabled
+4. Create Anki Card with target word (through a texthooker page/Yomitan)
+5. When finished gaming, End script (not required)
+
+Once the Anki card is created:
+
+1. **OBS** will save the last X seconds of gameplay.
+2. The Python script will trim the audio based on last clipboard event, and the end of voice line detected in VAD if
+   enabled.
+3. Will attempt to update the LAST anki card created.
+
+---
+
+## How to Update the Script
+
+### PIP Install (Preferred)
+
+If you installed the script via pip, you can update it with the following command:
+```bash
+pip install --upgrade gamesentenceminer
+```
+
+
+### Source (For if you want to make edits to the script)
+
+I will probably remove this section at a later date. If you want to make edits to the script, you should know how to do this.
+
+To ensure you always have the latest version of this script, you can use `git pull` to update your local repository with
+the latest changes from the remote repository.
+
+#### Step-by-Step Instructions
+
+1. Open your terminal and navigate to the directory where you cloned the repository:
+    ```bash
+    cd path/to/script
+    ```
+
+2. Run the following command to fetch and integrate the latest changes:
+    ```bash
+    git pull origin main
+    ```
+
+    - **`origin`** refers to the remote repository from which you cloned the code.
+    - **`main`** refers to the main branch of the repository. I~~~~f your default branch has a different name (
+      e.g., `master` or `dev`), replace `main` with that branch name.
+
+3. The `git pull` command will download and apply any updates from the remote repository to your local version.
+
+### Example:
+
+```bash
+$ cd path/to/script
+$ git pull origin master
+```
+
+---
+
+## Disclaimer/Troubleshooting
+
+Every game/hook is different, so it's really impossible that any script can get it perfect every time. Also OBS is
+sometimes a bit finicky if running for too long. If the audio timing is off, please first try some troubleshooting
+steps before making an issue:
+
+- Try Restarting OBS
+- Make sure your hook is the best you can find. (Preferably it gives you the text RIGHT when the voice line starts)
+- Try Adjusting Offset Configuration in `config.toml` to better match your situation. (i.e. if the hook is late, add a
+  negative beginning offset)
+- Try using "Trim beginning" in `VAD` settings.
+
+### Setup Troubleshooting
+
+Just going to continuously update this with issues that I have helped users with. Look here first if you have issues
+setting it up.
+
+- Make sure folder_to_watch is the same as your recordings path in OBS. It defaults to ~/Videos, but I recommend setting
+  it to ~/Videos/GSM.
+- If using clipboard, make sure Agent/Textractor sending to clipboard is enabled.
+- If using websocket, make sure the websocket server is running and the uri is correct in both GSM AND agent/textractor. Textractor uses a default of 6677, and I would recommend changing Agent to use 6677 as well.
+
+
+## Contact
+
+If you run into issues ask in my [Discord](https://discord.gg/yP8Qse6bb8), or make an issue here.
+
+## Donations
+
+If you've benefited from this or any of my other projects, please consider supporting my work
+via [Github Sponsors](https://github.com/sponsors/bpwhelan) or [Ko-fi.](https://ko-fi.com/beangate)

{GameSentenceMiner-2.2.0.dist-info → GameSentenceMiner-2.2.1.dist-info}/RECORD

@@ -1,15 +1,15 @@
 src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/anki.py,sha256=wf1_iUVHrEnzNtK2uL8FJBtAwihiwO_WkmgvqLExf5Q,9089
+src/anki.py,sha256=FfOxvozC4LBzhexiyY_uDSH3wgxzf4Uqvf8DZyyGlsQ,9138
 src/config_gui.py,sha256=oY397FO5WYHluPNOtfed3Eakw3TMpVStCaoEU60jw00,48963
-src/configuration.py,sha256=QVVe8_Pkiyxahgbabf0dpBeY1oIktypvOzBvlwyLEhI,14035
-src/ffmpeg.py,sha256=9WtP_ajm-nGWPRbuPMJAdnybsKyuAq8Uc_npK4NqGJE,10633
-src/gametext.py,sha256=3HN1imfcmecfGstqDjfKBZJL02tJfrZsZBTphXLVGh8,4010
-src/gsm.py,sha256=ip4NuMHwAgK_lC9-Y1fUGXYj_SAf-laNPY_nSsmLRYQ,16246
+src/configuration.py,sha256=Cw5vUF74ZKcSinbciNMiLKpMO8M6sf-0THokHO_31nE,14010
+src/ffmpeg.py,sha256=-P0ysDrBefYpu8JOV6-tu52zqg2wDMwVqSVeO5iFQxc,10836
+src/gametext.py,sha256=EGFGzNrkLX_YdUWbksE7bf_4P7O-zcbdhsgubpUt5xw,4025
+src/gsm.py,sha256=DTVkA-MxFq3zsxH1wl1TJPz-sQIrjZdxCtzMsE9YYW0,16250
 src/model.py,sha256=oh8VVT8T1UKekbmP6MGNgQ8jIuQ_7Rg4GPzDCn2kJo8,1999
-src/notification.py,sha256=sWgIIXhaB9WV1K_oQGf5-IR6q3dakae_QS-RuIvbcEs,1939
-src/obs.py,sha256=6XIsIRntr63cdpfNS2CanUWr3KyMHoQ8PxfKLZzSkVY,6495
+src/notification.py,sha256=4lteRvzizUb081t_87DpophOQceBnNerNq3ppq5POH8,1996
+src/obs.py,sha256=SAP-_JB-37ZjZIbpWs9-MYPJHtT0BpKLD-KQuvneHtg,6538
 src/package_updater.py,sha256=Yel-KWBHr5kgIJpHM1A1w5tcx_gDqrLrK0pqXRhinlI,1472
-src/util.py,sha256=eTMD5oqsDwem5C7GUG6-x3AQ884a1WLaJ1VVJgeHmA4,4491
+src/util.py,sha256=QRJMSEtnLaT4c2avQ0gZNn1oPtDfBbqcE8zuFHTzbd8,4569
 src/downloader/Untitled_json.py,sha256=RUUl2bbbCpUDUUS0fP0tdvf5FngZ7ILdA_J5TFYAXUQ,15272
 src/downloader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 src/downloader/download_tools.py,sha256=m1UV8EvWJdNn2cz11BCUI2mth46RhbVdVHXYYC318V8,6378
@@ -17,8 +17,8 @@ src/vad/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 src/vad/silero_trim.py,sha256=rcHzSNjAm_liiKBWsdywpIC1oUrM00I7kxmomXCQ-Io,1521
 src/vad/vosk_helper.py,sha256=4oaI7uesINu1sO7PA0-M4qSOmiEneRRN4Ae8ztmYCBE,5798
 src/vad/whisper_helper.py,sha256=N8-FZMIjLb5CiFeyY8pz050v7RguU39B6tnvsPTbSmc,3383
-GameSentenceMiner-2.2.0.dist-info/METADATA,sha256=LZH1a7NVyGPQTuHhed4yTGLtYV0K2nw6OV2epwDRa2Q,13408
-GameSentenceMiner-2.2.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-GameSentenceMiner-2.2.0.dist-info/entry_points.txt,sha256=hzWrryQzGBdqbVqzUIBbVZvvh7MBTUYvWiIs95QrfHE,51
-GameSentenceMiner-2.2.0.dist-info/top_level.txt,sha256=74rtVfumQlgAPzR5_2CgYN24MB0XARCg0t-gzk6gTrM,4
-GameSentenceMiner-2.2.0.dist-info/RECORD,,
+GameSentenceMiner-2.2.1.dist-info/METADATA,sha256=QZzBzJ6OpsODRoGaY52g3VQOQEfhKLhrlsmNmdKpVqs,9157
+GameSentenceMiner-2.2.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+GameSentenceMiner-2.2.1.dist-info/entry_points.txt,sha256=hzWrryQzGBdqbVqzUIBbVZvvh7MBTUYvWiIs95QrfHE,51
+GameSentenceMiner-2.2.1.dist-info/top_level.txt,sha256=74rtVfumQlgAPzR5_2CgYN24MB0XARCg0t-gzk6gTrM,4
+GameSentenceMiner-2.2.1.dist-info/RECORD,,

src/anki.py

@@ -168,15 +168,15 @@ def get_cards_by_sentence(sentence):
     card_ids = invoke("findCards", query=query)
 
     if not card_ids:
-        print(f"Didn't find any cards matching query:\n{query}")
+        logger.warning(f"Didn't find any cards matching query:\n{query}")
         return {}
     if len(card_ids) > 1:
-        print(f'Found more than 1, and not updating cards for query: \n{query}')
+        logger.warning(f'Found more than 1, and not updating cards for query: \n{query}')
         return {}
 
     last_notes = invoke('notesInfo', notes=[card_ids[0]])[0]
 
-    print(f"Found Card to backfill!: {card_ids[0]}")
+    logger.info(f"Found Card to backfill!: {card_ids[0]}")
 
     return last_notes
 
@@ -188,7 +188,7 @@ def check_for_new_cards():
     try:
         current_note_ids = get_note_ids()
     except Exception as e:
-        print(f"Error fetching Anki notes: {e}")
+        logger.error(f"Error fetching Anki notes: {e}")
         return
     new_card_ids = current_note_ids - previous_note_ids
     if new_card_ids and not first_run:
@@ -205,16 +205,16 @@ def update_new_card():
 
     use_prev_audio = util.use_previous_audio
     if util.lock.locked():
-        print("Audio still being Trimmed, Card Queued!")
+        logger.info("Audio still being Trimmed, Card Queued!")
         use_prev_audio = True
     with util.lock:
-        print(f"use previous audio: {use_prev_audio}")
+        logger.info(f"use previous audio: {use_prev_audio}")
         if get_config().obs.get_game_from_scene:
             obs.update_current_game()
         if use_prev_audio:
             update_anki_card(last_card, note=get_initial_card_info(last_card), reuse_audio=True)
         else:
-            print("New card(s) detected!")
+            logger.info("New card(s) detected!")
             obs.save_replay_buffer()
 
 

src/configuration.py

@@ -305,13 +305,11 @@ def load_config():
                     config = ProfileConfig.from_dict(config_file)
                     new_config = Config(configs = {DEFAULT_CONFIG : config}, current_profile=DEFAULT_CONFIG)
 
-                    print(new_config)
-
                     with open(config_path, 'w') as file:
                         json.dump(new_config.to_dict(), file, indent=4)
                     return new_config
         except json.JSONDecodeError as e:
-            print(f"Error parsing config.json: {e}")
+            logger.error(f"Error parsing config.json: {e}")
             return None
     elif os.path.exists('config.toml'):
         config = ProfileConfig().load_from_toml('config.toml')
@@ -334,7 +332,7 @@ def get_config():
         config = config_instance.get_config()
 
         if config.features.backfill_audio and config.features.full_auto:
-            print("Cannot have backfill_audio and obs_full_auto_mode turned on at the same time!")
+            logger.error("Cannot have backfill_audio and obs_full_auto_mode turned on at the same time!")
             exit(1)
 
     # print(config_instance.get_config())

src/ffmpeg.py

@@ -9,6 +9,9 @@ from src.util import *
 def get_ffmpeg_path():
     return os.path.join(get_app_directory(), "ffmpeg", "ffmpeg.exe") if util.is_windows() else "ffmpeg"
 
+def get_ffprobe_path():
+    return os.path.join(get_app_directory(), "ffmpeg", "ffprobe.exe") if util.is_windows() else "ffprobe"
+
 ffmpeg_base_command_list = [get_ffmpeg_path(), "-hide_banner", "-loglevel", "error", '-nostdin']
 
 
@@ -90,7 +93,7 @@ def process_image(image_file):
 
 def get_audio_codec(video_path):
     command = [
-        "ffprobe",
+        f"{get_ffprobe_path()}",
         "-v", "error",
         "-select_streams", "a:0",
         "-show_entries", "stream=codec_name",
@@ -151,12 +154,13 @@ def get_audio_and_trim(video_path, line_time, next_line_time):
 
 def get_video_duration(file_path):
     ffprobe_command = [
-        "ffprobe",
+        f"{get_ffprobe_path()}",
         "-v", "error",
         "-show_entries", "format=duration",
         "-of", "json",
         file_path
     ]
+    logger.debug(" ".join(ffprobe_command))
     result = subprocess.run(ffprobe_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     duration_info = json.loads(result.stdout)
     return float(duration_info["format"]["duration"])  # Return the duration in seconds

src/gametext.py

@@ -51,7 +51,7 @@ async def listen_websocket():
         try:
             async with websockets.connect(f'ws://{get_config().general.websocket_uri}', ping_interval=None) as websocket:
                 if reconnecting:
-                    print(f"Texthooker WebSocket connected Successfully!")
+                    logger.info(f"Texthooker WebSocket connected Successfully!")
                     reconnecting = False
                 while True:
                     message = await websocket.recv()
@@ -71,7 +71,7 @@ async def listen_websocket():
 
         except (websockets.ConnectionClosed, ConnectionError) as e:
             if not reconnecting:
-                print(f"Texthooker WebSocket connection lost: {e}. Attempting to Reconnect...")
+                logger.warning(f"Texthooker WebSocket connection lost: {e}. Attempting to Reconnect...")
             reconnecting = True
             await asyncio.sleep(5)
 

src/gsm.py

@@ -100,8 +100,7 @@ class VideoToAudioHandler(FileSystemEventHandler):
                     except Exception as e:
                         logger.error(f"Card failed to update! Maybe it was removed? {e}")
                 except FileNotFoundError as f:
-                    print(f)
-                    print("Something went wrong with processing, anki card not updated")
+                    logger.error("Something went wrong with processing, anki card not updated")
         except Exception as e:
             logger.error(f"Some error was hit catching to allow further work to be done: {e}", exc_info=1)
         if get_config().paths.remove_video and os.path.exists(video_path):
@@ -232,7 +231,7 @@ def open_log():
     """Open log file with the default application."""
     log_file_path = get_log_path()
     if not os.path.exists(log_file_path):
-        print("Log file not found!")
+        logger.error("Log file not found!")
         return
 
     if sys.platform.startswith("win"):  # Windows
@@ -242,13 +241,13 @@ def open_log():
     elif sys.platform.startswith("linux"):  # Linux
         subprocess.call(["xdg-open", log_file_path])
     else:
-        print("Unsupported platform!")
-    print("Log opened.")
+        logger.error("Unsupported platform!")
+    logger.info("Log opened.")
 
 
 def exit_program(icon, item):
     """Exit the application."""
-    print("Exiting...")
+    logger.info("Exiting...")
     icon.stop()
     cleanup()
 

src/notification.py

@@ -1,6 +1,8 @@
 import requests
 from plyer import notification
 
+from src.configuration import logger
+
 
 def open_anki_card(note_id):
     url = "http://localhost:8765"
@@ -17,11 +19,11 @@ def open_anki_card(note_id):
     try:
         response = requests.post(url, json=data, headers=headers)
         if response.status_code == 200:
-            print(f"Opened Anki note with ID {note_id}")
+            logger.info(f"Opened Anki note with ID {note_id}")
         else:
-            print(f"Failed to open Anki note with ID {note_id}")
+            logger.error(f"Failed to open Anki note with ID {note_id}")
     except Exception as e:
-        print(f"Error connecting to AnkiConnect: {e}")
+        logger.info(f"Error connecting to AnkiConnect: {e}")
 
 
 def send_notification(tango):

src/obs.py

@@ -111,9 +111,9 @@ def disconnect_from_obs():
 def toggle_replay_buffer():
     try:
         client.call(requests.ToggleReplayBuffer())
-        print("Replay buffer Toggled.")
+        logger.info("Replay buffer Toggled.")
     except Exception as e:
-        print(f"Error toggling buffer: {e}")
+        logger.error(f"Error toggling buffer: {e}")
 
 
 # Start replay buffer
@@ -122,16 +122,16 @@ def start_replay_buffer():
         client.call(requests.GetVersion())
         client.call(requests.StartReplayBuffer())
     except Exception as e:
-        print(f"Error starting replay buffer: {e}")
+        logger.error(f"Error starting replay buffer: {e}")
 
 
 # Stop replay buffer
 def stop_replay_buffer():
     try:
         client.call(requests.StopReplayBuffer())
-        print("Replay buffer stopped.")
+        logger.error("Replay buffer stopped.")
     except Exception as e:
-        print(f"Error stopping replay buffer: {e}")
+        logger.error(f"Error stopping replay buffer: {e}")
 
 
 # Save the current replay buffer
@@ -144,7 +144,7 @@ def save_replay_buffer():
         else:
             logger.error("Replay Buffer is not active, could not save Replay Buffer!")
     except Exception as e:
-        print(f"Error saving replay buffer: {e}")
+        logger.error(f"Error saving replay buffer: {e}")
 
 
 def get_current_scene():
@@ -153,7 +153,7 @@ def get_current_scene():
         scene_info = SceneInfo.from_dict(response.datain)
         return scene_info.sceneName
     except Exception as e:
-        print(f"Couldn't get scene: {e}")
+        logger.error(f"Couldn't get scene: {e}")
     return ''
 
 
@@ -161,10 +161,9 @@ def get_source_from_scene(scene_name):
     try:
         response = client.call(requests.GetSceneItemList(sceneName=scene_name))
         scene_list = SceneItemsResponse.from_dict(response.datain)
-        print(scene_list)
         return scene_list.sceneItems[0]
     except Exception as e:
-        print(f"Error getting source from scene: {e}")
+        logger.error(f"Error getting source from scene: {e}")
         return ''
 
 
@@ -176,13 +175,13 @@ def get_screenshot():
         current_source = get_source_from_scene(get_current_game())
         current_source_name = current_source.sourceName
         if not current_source_name:
-            print("No active scene found.")
+            logger.error("No active scene found.")
             return
         client.call(
             requests.SaveSourceScreenshot(sourceName=current_source_name, imageFormat='png', imageFilePath=screenshot))
         return screenshot
     except Exception as e:
-        print(f"Error getting screenshot: {e}")
+        logger.error(f"Error getting screenshot: {e}")
 
 
 def update_current_game():

src/util.py

@@ -9,6 +9,8 @@ from sys import platform
 
 from rapidfuzz import process
 
+from src.configuration import logger
+
 SCRIPTS_DIR = r"E:\Japanese Stuff\agent-v0.1.4-win32-x64\data\scripts"
 
 # Global variables to control script execution
@@ -56,7 +58,7 @@ def get_file_modification_time(file_path):
 def get_process_id_by_title(game_title):
     powershell_command = f"Get-Process | Where-Object {{$_.MainWindowTitle -like '*{game_title}*'}} | Select-Object -First 1 -ExpandProperty Id"
     process_id = subprocess.check_output(["powershell", "-Command", powershell_command], text=True).strip()
-    print(f"Process ID for {game_title}: {process_id}")
+    logger.info(f"Process ID for {game_title}: {process_id}")
     return process_id
 
 
@@ -101,21 +103,21 @@ def find_script_for_game(game_title):
     best_script, matched_game_name, confidence = find_most_similar_script(game_title, steam_scripts)
 
     if best_script:
-        print(f"Found Script: {best_script}")
+        logger.info(f"Found Script: {best_script}")
         return best_script
     else:
-        print("No similar script found.")
+        logger.warning("No similar script found.")
 
 
 def run_agent_and_hook(pname, agent_script):
     command = f'agent --script=\"{agent_script}\" --pname={pname}'
-    print("Running and Hooking Agent!")
+    logger.info("Running and Hooking Agent!")
     try:
         dos_process = subprocess.Popen(command, shell=True)
         dos_process.wait()  # Wait for the process to complete
-        print("Agent script finished or closed.")
+        logger.info("Agent script finished or closed.")
     except Exception as e:
-        print(f"Error occurred while running agent script: {e}")
+        logger.error(f"Error occurred while running agent script: {e}")
 
     keep_running = False
 

GameSentenceMiner-2.2.0.dist-info/METADATA

@@ -1,348 +0,0 @@
-Metadata-Version: 2.2
-Name: GameSentenceMiner
-Version: 2.2.0
-Summary: A tool for mining sentences from games.
-Author-email: Beangate <bpwhelan95@gmail.com>
-License: MIT License
-Project-URL: Homepage, https://github.com/bpwhelan/GameSentenceMiner
-Project-URL: Repository, https://github.com/bpwhelan/GameSentenceMiner
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: requests~=2.32.3
-Requires-Dist: watchdog~=5.0.2
-Requires-Dist: DateTime~=5.5
-Requires-Dist: pyperclip~=1.9.0
-Requires-Dist: vosk~=0.3.45
-Requires-Dist: soundfile~=0.12.1
-Requires-Dist: toml~=0.10.2
-Requires-Dist: psutil~=6.0.0
-Requires-Dist: rapidfuzz~=3.9.7
-Requires-Dist: obs-websocket-py~=1.0
-Requires-Dist: plyer~=2.1.0
-Requires-Dist: keyboard~=0.13.5
-Requires-Dist: websockets~=13.0.1
-Requires-Dist: stable-ts~=2.17.5
-Requires-Dist: silero-vad~=5.1.2
-Requires-Dist: ttkbootstrap~=1.10.1
-Requires-Dist: dataclasses_json~=0.6.7
-Requires-Dist: numpy
-Requires-Dist: pystray
-Requires-Dist: pywin32
-
-# Sentence Mining Game Audio Trim Helper
-
-## WARNING
-
-This project is in process of a major overhaul, and this README will be updated soon with the new process.
-
----
-
-This project automates the recording of game sentence audio to help with Anki Card Creation.
-
-This allows us to create cards from texthooker/yomitan, and automatically get screenshot and sentence audio from the
-game we are playing.
-
-## Features:
-
-- **Voice Activity Detection**: Automatically cuts the end of the clip to the exact moment the voice ended.
-- **OBS Replay Buffer**: Constantly records the last X seconds of gameplay.
-- **Clipboard Interaction**: Automatically monitors the clipboard for dialogue events.
-- **Websocket Listening**: Listens to a websocket uri for text-events from stuff like Agent/Textractor.
-- **Hotkey Automation**: Single hotkey to trigger video recording, screenshot, and transcription.
-- **1-Click Card Creation**: Monitors anki for new cards from Yomitan, and automatically gets audio from games.
-
-## Prerequisites
-
-- [Python 3.11+](https://www.python.org/downloads/)
-- [OBS Studio](https://obsproject.com/)
-
----
-
-### Quick Disclaimer/Troubleshooting
-
-Every game/hook is different, so it's really impossible that any script can get it perfect everytime. Also OBS is
-sometimes a bit finnicky if running for too long. If the audio timing is off, please first try some troubleshooting
-steps before making an issue:
-
-- Try Restarting OBS
-- Make sure your hook is the best you can find. (Preferrably it gives you the text RIGHT when the voiceline starts)
-- Try Adjusting Offset Configuration in `config.toml` to better match your situation. (i.e. if the hook is late, add a
-  negative beginning offset)
-- Try using "Trim beginning" in `VAD` settings.
-
-#### Setup Troubleshooting
-
-Just going to continuously update this with issues that I have helped users with. Look here first if you have issues
-setting it up.
-
-- Make sure folder_to_watch is the same as your recordings path in OBS. It defaults to ~/Videos, but I recommend setting
-  it to ~/Videos/OBS.
-- if it says something about a missing library, attempt to run `pip install -r requirements.txt` again
-- If using clipboard, make sure agent/textractor sending to clipboard is enabled.
-
-## 1. Setting Up OBS 60-Second Replay Buffer
-
-1. **Install OBS Studio**: Download and install OBS from [here](https://obsproject.com/).
-2. **Enable Replay Buffer**:
-    1. Open OBS and navigate to **Settings → Output → Replay Buffer**.
-    2. Enable the **Replay Buffer** and set the duration to **60 seconds**, this can be lower, or higher, but 60 works
-       for a very simple setup.
-3. **Set a Hotkey for the Replay Buffer**:
-    1. Go to **Settings → Hotkeys** and find **Save Replay Buffer**.
-    2. Assign a hotkey for saving the replay.
-4. Set Scene/Source. I recommend using "Game Capture" with "Capture Audio" Enabled. And then mute Desktop/microphone
-    1. If "Game Capture" Does not work, use "Window Capture".
-    2. I recommend having a Scene PER Game, with the name of the scene labeled as the game, this makes it easier for the
-       script to know (with a config option) what game you are playing.
-5. In Output Settings, set "Recording Format" to mkv, and "Audio Encoder" to Opus. Alternative Settings may be supported
-   at a later date.
-6. **Set up obs websocket** (HIGHLY RECOMMENDED see #5)
-    1. Can allow my script to automatically start (and stop) the replay buffer, as well as automatically add
-       audio/screenshot to card created from yomi.
-
-Here are the Settings I use in OBS. Make sure the recordings folder is the same as the "folder_to_watch" in the config.
-![image](https://github.com/user-attachments/assets/0056816d-af3c-4a3c-bc6a-4aff5c28cadb)
-![image](https://github.com/user-attachments/assets/dd2f95a6-f546-41d9-8136-de7b1b035a5d)
-
-
----
-
-## 2. Configuring the App.
-
-### Configuration GUI
-
-The `GameSentenceMiner` project now includes a graphical interface to simplify configuration. With default values
-already set, this GUI lets you adjust settings as needed. Here’s how to get started:
-
-#### Running the Configuration GUI
-
-To open the GUI, you have two options:
-
-1. **Tray Icon**: Right Click the Tray Icon and Click `Open Settings`
-2. **Directly Run the Script**: Open a terminal in your project directory and enter:
-   \\\bash
-   python config_gui.py
-   \\\
-
-#### Default Settings and Customization
-
-The GUI loads with default values for each setting, so if you’re just getting started, you may only need to change stuff
-in the "path" config. If you make changes, remember to click **Save Settings** to apply them.
-Please take a second to look through the config to see what is available, there is a lot of extra functionality hidden
-behind config options.
-
-![image](https://github.com/user-attachments/assets/ffac9888-de0a-412b-817f-e22a55ce7b55)![image](https://github.com/user-attachments/assets/981c112a-1ddc-4e07-9c39-57fe46644ff5)![image](https://github.com/user-attachments/assets/29470a97-6013-4ca8-9059-48af735eb3a8)![image](https://github.com/user-attachments/assets/8e9c8f03-dc43-4822-a3c5-43f36ca65364)
-
-
-
-
-
----
-
-## 2. Configuring `config.toml` **DEPRECATED** Only used if running an older version.
-
-I redid the config parsing cause `config.py` is not ideal, especially when distributing a script via git.
-
-Your `config.toml` file allows you to configure key settings for the automation process, file paths, and other behavior.
-Here are the configurable options:
-
-Duplicate/rename config_EXAMPLE.toml to get started
-
-```toml
-# Path configurations
-[paths]
-folder_to_watch = "~/Videos/OBS"
-audio_destination = "~/Videos/OBS/Audio/"
-screenshot_destination = "~/Videos/OBS/SS/"
-
-# Anki Fields
-[anki]
-url = 'http://127.0.0.1:8765'
-sentence_field = "Sentence"
-sentence_audio_field = "SentenceAudio"
-picture_field = "Picture"
-word_field = "Word"
-current_game = "Japanese Game"
-custom_tags = ['JapaneseGameMiner', "Test Another Tag"] # leave Empty if you dont want to add tags
-add_game_tag = true
-polling_rate = 200 # This is how often the script asks anki if it has new cards. Change at your own peril.
-
-# Feature Flags
-[features]
-do_vosk_postprocessing = true
-update_anki = true
-remove_video = true
-remove_screenshot = false
-remove_audio = false
-notify_on_update = true
-open_anki_edit = false
-backfill_audio = false # Strictly to fill audio for cards that you already have in your anki db. CANNOT BE USED WITH FULL_AUTO_MODE
-
-# Vosk Model
-[vosk]
-url = "https://alphacephei.com/vosk/models/vosk-model-small-ja-0.22.zip"
-# If you have a high-performance PC, with 16GB+ of RAM, you can uncomment and use this model:
-# url = "https://alphacephei.com/vosk/models/vosk-model-ja-0.22.zip"
-log-level = -1
-
-[screenshot]
-width = 0 # Desired Width of Screenshot, 0 to disable scaling (Default 0)
-quality = 85 # Quality of image, 100 is lossless (Default 85)
-extension = "webp" # Codec of screenshot, Recommend Keeping this as webp (Default webp)
-
-[audio]
-extension = "opus" # Desired Extension/codec of Trimmed Audio, (Default opus)
-beginning_offset = 0.0 # Negative Value = More time at the beginning (i.e. -1 is 1 extra second at the beginning)
-end_offset = 0.5 # Positive Value = More time at the end (i.e. 1 is 1 extra second at the end)
-vosk_trim_beginning = false # Only change If you run into issues with clipboard timing, add a negative beginning_offset as well, Warning: You may end up with audio from previous line depending on your setup!
-reset_hotkey = 'f4' # Hotkey to initiate Offset Updater.
-
-[obs]
-enabled = true
-start_buffer = true
-full_auto_mode = false # Automatically Create Cards when you Create in Yomi. REQUIRED for multi-card-per-voiceline
-host = "localhost"
-port = 4455
-password = "your_password_here"
-get_game_from_scene = false
-
-[websocket]
-enabled = true # Recommended/Default, with this enabled, this script does not interact with your clipboard at all.
-uri = 'localhost:6677'
-
-#[anki_custom_fields]
-#IsTargetedSentenceCard = 1
-#Comment = "Nice!"
-```
-
----
-
-## 3. Install Requirements
-
-If you know what you are doing, do this in a venv, but I'm not going to explain that here.
-
-`pip install -r requirements.txt`
-
-## 4. Installing FFmpeg
-
-To run this script, you will need to have **FFmpeg** installed. If you don't have FFmpeg installed on your system, you
-can easily install it via **Chocolatey** (Preferred), or install it yourself and ensure it's in the PATH.
-
-#### Step-by-Step Instructions:
-
-1. First, ensure you have **Chocolatey** installed. If you don't have it installed, follow the instructions on
-   the [Chocolatey installation page](https://chocolatey.org/install) or run the following command in an **elevated**
-   PowerShell window (run as Administrator):
-
-   ```bash
-   Set-ExecutionPolicy Bypass -Scope Process -Force; `
-   [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; `
-   iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
-   ```
-
-2. Once Chocolatey is installed, open a **new** PowerShell or Command Prompt window (with administrator rights).
-
-3. Run the following command to install FFmpeg:
-
-   ```bash
-   choco install ffmpeg
-   ```
-
-4. After the installation is complete, verify that FFmpeg is correctly installed by running the following command:
-
-   ```bash
-   ffmpeg -version
-   ```
-
-   If the installation was successful, you should see the version information for FFmpeg.
-
-Now you're ready to use FFmpeg in the script!
-
----
-
-## 5. One Click Card Creation
-
-This is the flagship feature of this script, so here is a section explaining it. It is possible to do full 1-click card
-creation with this tool + Yomitan. The relevant settings are located in `Features` and `OBS` section in the config.
-
-Demo: https://www.youtube.com/watch?v=9dmmXO2CGNw
-
-Screenshots to help with setup:
-
-![image](https://github.com/user-attachments/assets/7de031e9-ce28-42eb-a8fd-0e60ef70dc3d)
-
-![image](https://github.com/user-attachments/assets/b0c70a1a-65b5-4fe7-a7e4-ccb0b9a5b249)
-
-![image](https://github.com/user-attachments/assets/4cf492eb-12a2-429f-aa0e-f87fc0fa6270)
-
-## 6. Example Process
-
-1. Start game
-2. Hook Game with Agent (or textractor) with clipboard enabled
-3. start script: `python -m src.GameSentenceMiner.gsm`
-    1. Create Anki Card with target word (through a texthooker page/Yomitan)
-    2. (If full-auto-mode not on) Trigger Hotkey to record replay buffer
-4. When finished gaming, end script
-
-Once the hotkey is triggered:
-
-1. **OBS** will save the last X seconds of gameplay.
-2. The Python script will trim the audio based on last clipboard event, and the end of voiceline detected in Vosk if
-   enabled.
-3. Will attempt to update the LAST anki card created.
-
----
-
-## How to Update the Script
-
-### Updater (Preferred)
-
-There is now an Update script included! running `python update.py` in the directory will attempt to update your scripts
-to the latest release. If you have made changes to any of the files, they will be safely backed up before being
-replaced.
-
----
-
-### Manual
-
-To ensure you always have the latest version of this script, you can use `git pull` to update your local repository with
-the latest changes from the remote repository.
-
-#### Step-by-Step Instructions
-
-1. Open your terminal and navigate to the directory where you cloned the repository:
-    ```bash
-    cd path/to/script
-    ```
-
-2. Run the following command to fetch and integrate the latest changes:
-    ```bash
-    git pull origin main
-    ```
-
-    - **`origin`** refers to the remote repository from which you cloned the code.
-    - **`main`** refers to the main branch of the repository. If your default branch has a different name (
-      e.g., `master` or `dev`), replace `main` with that branch name.
-
-3. The `git pull` command will download and apply any updates from the remote repository to your local version.
-
-### Example:
-
-```bash
-$ cd path/to/script
-$ git pull origin master
-```
-
----
-
-## Contact
-
-If you run into issues ask in my [discord](https://discord.gg/yP8Qse6bb8), or make an issue here.
-
-## Donations
-
-If you've benefited from this or any of my other projects, please consider supporting my work
-via [Github Sponsors](https://github.com/sponsors/bpwhelan) or [Ko-fi.](https://ko-fi.com/beangate)