GameSentenceMiner 2.4.7__py3-none-any.whl → 2.4.9__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -187,6 +187,10 @@ class ConfigApp:
187
187
  )
188
188
  )
189
189
 
190
+ if config.features.backfill_audio and config.features.full_auto:
191
+ messagebox.showerror("Configuration Error", "Cannot have Full Auto and Backfill mode on at the same time! Note: Backfill is a very niche workflow.")
192
+ return
193
+
190
194
  current_profile = self.profile_combobox.get()
191
195
  prev_config = self.master_config.get_config()
192
196
  if profile_change:
@@ -356,8 +356,8 @@ def get_config():
356
356
  config = config_instance.get_config()
357
357
 
358
358
  if config.features.backfill_audio and config.features.full_auto:
359
- logger.error("Cannot have backfill_audio and obs_full_auto_mode turned on at the same time!")
360
- exit(1)
359
+ logger.warning("Backfill audio is enabled, but full auto is also enabled. Disabling backfill...")
360
+ config.features.backfill_audio = False
361
361
 
362
362
  # print(config_instance.get_config())
363
363
  return config_instance.get_config()
@@ -369,8 +369,8 @@ def reload_config():
369
369
  config = config_instance.get_config()
370
370
 
371
371
  if config.features.backfill_audio and config.features.full_auto:
372
- print("Cannot have backfill_audio and obs_full_auto_mode turned on at the same time!")
373
- exit(1)
372
+ logger.warning("Backfill is enabled, but full auto is also enabled. Disabling backfill...")
373
+ config.features.backfill_audio = False
374
374
 
375
375
  def get_master_config():
376
376
  return config_instance
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: GameSentenceMiner
3
- Version: 2.4.7
3
+ Version: 2.4.9
4
4
  Summary: A tool for mining sentences from games. Update: Multi-Line Mining! Fixed!
5
5
  Author-email: Beangate <bpwhelan95@gmail.com>
6
6
  License: MIT License
@@ -64,96 +64,13 @@ There are settings in GSM that may help accomodate for a poor hook, but if you e
64
64
  - **Hotkey Automation**: Single hotkey to trigger video recording, screenshot, and transcription.
65
65
  - **1-Click Card Creation**: Monitors anki for new cards from Yomitan, and automatically gets audio from games.
66
66
 
67
- ## Prerequisites
68
-
69
- - [Python 3.11+](https://www.python.org/downloads/release/python-3119/)
70
- - Important: 3.13 is [NOT supported](https://stackoverflow.com/questions/79175945/keyerror-version-installing-openai-whisper-on-python-3-13).
71
-
72
- ---
73
-
74
- ## 1. Installing and Running the Script
75
-
76
- ### New Way as of 2.4.0
77
-
78
- Grab the latest Installer from [Releases](https://github.com/bpwhelan/GameSentenceMiner/releases).
79
-
80
- ### Old Way - Will still work for the forseeable future
81
-
82
- https://pypi.org/project/GameSentenceMiner/
83
-
84
- Python + pip needs to be installed, make sure you install 3.11 or higher, since older versions may not be supported.
85
-
86
- Install:
87
- ```commandline
88
- pip install gamesentenceminer
89
- ```
90
-
91
- Run:
92
- ```commandline
93
- gamesentenceminer
94
- ```
95
-
96
- 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.
97
-
98
- ---
99
-
100
- ## 2. Setting Up OBS Replay Buffer
101
-
102
- 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.
103
- 2. Set Scene/Source. I recommend using "Game Capture" with "Capture Audio" Enabled. And then mute Desktop/microphone
104
- 1. If "Game Capture" Does not work, use "Window Capture".
105
- 2. I recommend having a Scene PER Game, with the name of the scene labeled as the game, this makes it easier for the
106
- script to know (with a config option) what game you are playing.
107
- 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.
108
-
109
- Here are the Settings I use in OBS. Make sure the recordings folder is the same as the "folder_to_watch" in the config.
110
- ![image](https://github.com/user-attachments/assets/0056816d-af3c-4a3c-bc6a-4aff5c28cadb)
111
- ![image](https://github.com/user-attachments/assets/dd2f95a6-f546-41d9-8136-de7b1b035a5d)
112
-
113
- ---
114
-
115
- ## 3. Configuring the App.
116
-
117
- ### Configuration GUI
118
-
119
- The `GameSentenceMiner` project now includes a graphical interface to simplify configuration. With default values
120
- already set, this GUI lets you adjust settings as needed. Here’s how to get started:
121
-
122
- #### Running the Configuration GUI
123
-
124
- To open the GUI, you have two options:
125
-
126
- 1. **Tray Icon**: Right Click the Tray Icon and Click `Open Settings`
127
-
128
- #### Default Settings and Customization
129
-
130
- The GUI loads with default values for each setting, so if you’re just getting started, you may only need to change options
131
- in the "path" config. If you make changes, remember to click **Save Settings** to apply them.
132
- Please take a second to look through the config to see what is available, there is a lot of extra functionality hidden
133
- behind config options.
134
-
135
- ![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)
136
-
137
-
138
67
  ---
139
68
 
69
+ ## Documentation
140
70
 
141
- ## 4. One Click Card Creation
142
-
143
- This is the flagship feature of this script, so here is a section explaining it. It is possible to do full 1-click card
144
- creation with this tool + Yomitan/JL. The relevant settings are located in `Features` and `OBS` section in the config.
145
-
146
- Demo: https://www.youtube.com/watch?v=9dmmXO2CGNw
147
-
148
- Screenshots to help with setup (THIS IS ALREADY DONE FOR YOU IN NEWER VERSIONS):
71
+ Help with Installation, Setup, and other information can be found in the project's [Wiki](https://github.com/bpwhelan/GameSentenceMiner/wiki).
149
72
 
150
- ![image](https://github.com/user-attachments/assets/7de031e9-ce28-42eb-a8fd-0e60ef70dc3d)
151
-
152
- ![image](https://github.com/user-attachments/assets/b0c70a1a-65b5-4fe7-a7e4-ccb0b9a5b249)
153
-
154
- ![image](https://github.com/user-attachments/assets/4cf492eb-12a2-429f-aa0e-f87fc0fa6270)
155
-
156
- ## 4. Example Process
73
+ ## Example Process
157
74
 
158
75
  1. Start script: `gamesentenceminer`
159
76
  2. Start game
@@ -170,50 +87,6 @@ Once the Anki card is created:
170
87
 
171
88
  ---
172
89
 
173
- ## How to Update the Script
174
-
175
- ### PIP Install (Preferred)
176
-
177
- If you installed the script via pip, you can update it with the following command:
178
- ```bash
179
- pip install --upgrade gamesentenceminer
180
- ```
181
-
182
-
183
- ### Source (For if you want to make edits to the script)
184
-
185
- 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.
186
-
187
- To ensure you always have the latest version of this script, you can use `git pull` to update your local repository with
188
- the latest changes from the remote repository.
189
-
190
- #### Step-by-Step Instructions
191
-
192
- 1. Open your terminal and navigate to the directory where you cloned the repository:
193
- ```bash
194
- cd path/to/script
195
- ```
196
-
197
- 2. Run the following command to fetch and integrate the latest changes:
198
- ```bash
199
- git pull origin main
200
- ```
201
-
202
- - **`origin`** refers to the remote repository from which you cloned the code.
203
- - **`main`** refers to the main branch of the repository. I~~~~f your default branch has a different name (
204
- e.g., `master` or `dev`), replace `main` with that branch name.
205
-
206
- 3. The `git pull` command will download and apply any updates from the remote repository to your local version.
207
-
208
- ### Example:
209
-
210
- ```bash
211
- $ cd path/to/script
212
- $ git pull origin master
213
- ```
214
-
215
- ---
216
-
217
90
  ## Disclaimer/Troubleshooting
218
91
 
219
92
  Every game/hook is different, so it's really impossible that any script can get it perfect every time. Also OBS is
@@ -1,7 +1,7 @@
1
1
  GameSentenceMiner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
2
  GameSentenceMiner/anki.py,sha256=YSz5gUTsKOdbogwHKtgFM7v7pREjdAwl7A0Wa_CXnKg,10918
3
- GameSentenceMiner/config_gui.py,sha256=-V-GPyHFiN0EI-ZQLXq2yDVfCR_sP7afcjOZKsnGiO8,52312
4
- GameSentenceMiner/configuration.py,sha256=mbyIs0h9xh85_ZJkuqTgspkdfl7jeifpvlYofu1e0mE,15001
3
+ GameSentenceMiner/config_gui.py,sha256=6DPJjzP-cHVU9q4j9UP1uF1z0o0z-mq0cuNqjZSIHdo,52566
4
+ GameSentenceMiner/configuration.py,sha256=bvU2XCOjCtHiTtCI1t5r986QznEKfTmH--i3YPE1Q-Y,15072
5
5
  GameSentenceMiner/electron_messaging.py,sha256=fBk9Ipo0jg2OZwYaKe1Qsm05P2ftrdTRGgFYob7ZA-k,139
6
6
  GameSentenceMiner/ffmpeg.py,sha256=vLBmQgkh23BS2vE5u7bli_1_3wFN5cB3VCgrAZ1VAL8,11197
7
7
  GameSentenceMiner/gametext.py,sha256=VjWNdjHwWXWIwNOfYxud7EwIyg7t6zZ3IkmMhh8Vc0c,6819
@@ -19,9 +19,9 @@ GameSentenceMiner/vad/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
19
19
  GameSentenceMiner/vad/silero_trim.py,sha256=syDJX_KbFmdyFFtnQqYTD0tICsUCJizYhs-atPgXtxA,1549
20
20
  GameSentenceMiner/vad/vosk_helper.py,sha256=HifeXKbEMrs81ZuuGxS67yAghu8TMXUP6Oan9i9dTxw,5938
21
21
  GameSentenceMiner/vad/whisper_helper.py,sha256=bpR1HVnJRn9H5u8XaHBqBJ6JwIjzqn-Fajps8QmQ4zc,3411
22
- gamesentenceminer-2.4.7.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
23
- gamesentenceminer-2.4.7.dist-info/METADATA,sha256=dI3esUztI0x36z--5cvgZWQo0dKKH2vz_tlPXC-qy08,10309
24
- gamesentenceminer-2.4.7.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
25
- gamesentenceminer-2.4.7.dist-info/entry_points.txt,sha256=2APEP25DbfjSxGeHtwBstMH8mulVhLkqF_b9bqzU6vQ,65
26
- gamesentenceminer-2.4.7.dist-info/top_level.txt,sha256=V1hUY6xVSyUEohb0uDoN4UIE6rUZ_JYx8yMyPGX4PgQ,18
27
- gamesentenceminer-2.4.7.dist-info/RECORD,,
22
+ gamesentenceminer-2.4.9.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
23
+ gamesentenceminer-2.4.9.dist-info/METADATA,sha256=S1bYWp1jUPpluIsgLldFPvvQydDmOH2Ue6aMqZ2Ca9M,5387
24
+ gamesentenceminer-2.4.9.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
25
+ gamesentenceminer-2.4.9.dist-info/entry_points.txt,sha256=2APEP25DbfjSxGeHtwBstMH8mulVhLkqF_b9bqzU6vQ,65
26
+ gamesentenceminer-2.4.9.dist-info/top_level.txt,sha256=V1hUY6xVSyUEohb0uDoN4UIE6rUZ_JYx8yMyPGX4PgQ,18
27
+ gamesentenceminer-2.4.9.dist-info/RECORD,,