Release prep; Renamed ITHVNR tab to Text Hooking.

Zoltanar · Zoltanar · commit 64305a661326 · 2021-06-05T21:31:48.000+01:00
diff --git a/DatabaseDumpReader/Properties/AssemblyInfo.cs b/DatabaseDumpReader/Properties/AssemblyInfo.cs
@@ -31,5 +31,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion("2.4.0.0")]
+[assembly: AssemblyFileVersion("2.4.0.0")]
diff --git a/Goals-Latest.md b/Goals-Latest.md
@@ -5,15 +5,13 @@
 - option to do this automatically: remove translations from cache if not used recently or originally cached too long ago.
 - apply translate stage 4 to pre-romaji
 #### Filters
-- Priority: Add producer filter
 - staff filter by name instead of id
 - add seiyuu filter to character
 - set default filter (different from permanent filter)
 #### Test Tab
 - show if translation was cached or not and give option to re-fetch
 - list entries used per stage.
-#### ITHVNR
-- rename tab to Text Hooking
+#### Text Hooking
 - use ithvnr tab to also show captured clipboard text format like: \[process/pid] \[outputted] \[text]
 - let user name threads and delete saved
 - text thread panel max height (scrollbar if needed)
@@ -34,6 +32,7 @@
 - DatabaseDumpReader: Icon
 - Logs: Link to folder, show size taken, option to clear.
 - Information Tab: Show Size of Vndb Images, show total size.
+- Use Screenshot Thumbnails when full-size is not found.
 
 ## Issues  
 - can't show outputwindow on top of some fullscreen games, steals focus on games where it works (might need direct draw)
diff --git a/Goals.md b/Goals.md
@@ -1,10 +1,7 @@
-﻿# For Version 2.3.0
+﻿# For Latest Committed
 ## Future Features  
-#### Entries
-- allow saving to usergame instead of vn game
-- allow proxy mods with multiple proxies ([[m#1]]-[[m#2]])
 #### Translation
-- Offline dictionary for faster (mouseover?) word lookups
+- Make mouseover dictionary tooltip nicer
 - option to do this automatically: remove translations from cache if not used recently or originally cached too long ago.
 - apply translate stage 4 to pre-romaji
 #### Filters
@@ -14,25 +11,28 @@
 #### Test Tab
 - show if translation was cached or not and give option to re-fetch
 - list entries used per stage.
-#### ITHVNR
+#### Text Hooking
 - use ithvnr tab to also show captured clipboard text format like: \[process/pid] \[outputted] \[text]
-- better saving/loading game text threads, let user name threads and delete saved
-- once any thread has been saved as posting, change default for new threads to stop/hide.
+- let user name threads and delete saved
 - text thread panel max height (scrollbar if needed)
 - VnrHook: handle maximum threads either change limit or reset ability
 - look at global hooks for changing ITHVNR settings via global hotkeys [GlobalMouseKeyHook](https://github.com/gmamaladze/globalmousekeyhook)
 #### Output Window
-- check if output window is in visible area of screens, if not, reset it.
 - alternate colors between blocks
 #### User Games
-- option to always launch games with some locale if windows locale is not already set to that, and option to override it.
-- context option to launch without hooking.
+- see details should change to correct user game tab when multiple user games for one vn
 - allow keeping time played for multiple games/allow process monitor to keep running always/make process monitor only have one instance
 - launch title from VN context menu
 #### Other
 - warn if an instance is already running (maybe show database file for opening instance) 
 - show written tag description on tooltip
 - MainWindow: allow scrolling on main window tab control when too many tabs and add close all tabs button
 - Settings: if login response is error with id 'needlogin' show user that credentials are wrong
+- DatabaseDumpReader: Parallelise?
+- DatabaseDumpReader: Icon
+- Logs: Link to folder, show size taken, option to clear.
+- Information Tab: Show Size of Vndb Images, show total size.
+- Use Screenshot Thumbnails when full-size is not found.
+
 ## Issues  
-- can't show Output Window on top of some fullscreen games, steals focus on games where it works (might need direct draw)
+- can't show outputwindow on top of some fullscreen games, steals focus on games where it works (might need direct draw)
diff --git a/HRGoogleTranslate/GoogleTranslateApi.cs b/HRGoogleTranslate/GoogleTranslateApi.cs
@@ -26,7 +26,7 @@ public class GoogleTranslateApi : ITranslator
 
 		private TranslationClient _client;
 
-		public string Version => "1.0";
+		public string Version => "1.1";
 		public string SourceName => "Google Translate API";
 		public string Error { get; set; }
 		public IReadOnlyDictionary<string, Type> Properties { get; } = new ReadOnlyDictionary<string, Type>(new Dictionary<string, Type>()
diff --git a/HRGoogleTranslate/Properties/AssemblyInfo.cs b/HRGoogleTranslate/Properties/AssemblyInfo.cs
@@ -31,5 +31,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion("1.1.0.0")]
+[assembly: AssemblyFileVersion("1.1.0.0")]
diff --git a/Happy Reader/View/MainWindow.xaml b/Happy Reader/View/MainWindow.xaml
@@ -51,7 +51,7 @@
 			<TabItem Header="Games" >
 				<tabs:UserGamesTab x:Name="UserGamesTabItem" DataContext="{Binding UserGamesViewModel}"/>
 			</TabItem>
-			<TabItem Header="ITHVNR" x:Name="IthTabItem">
+			<TabItem Header="Text Hooking" x:Name="IthTabItem">
 				<tabs:IthVnrTab DataContext="{Binding IthViewModel}"/>
 			</TabItem>
 			<TabItem Header="Entries" x:Name="EntriesTabItem">
diff --git a/HappySearchObjectClasses/StaticHelpers.cs b/HappySearchObjectClasses/StaticHelpers.cs
@@ -43,7 +43,7 @@ public static class StaticHelpers
 		#endregion
 
 		public const string ClientName = "Happy Reader";
-		public const string ClientVersion = "2.3.0";
+		public const string ClientVersion = "2.4.0";
 		private const string PasswordRegistryKey = "SOFTWARE\\" + ClientName;
 		private const string PasswordRegistryCipherValueName = "Data1";
 		private const string PasswordRegistryEntropyValueName = "Data2";
diff --git a/IthVnrSharpLib b/IthVnrSharpLib
@@ -1 +1 @@
-Subproject commit f8b591b855a60cec7b39784b6619f0da49c2e613
+Subproject commit e3dfbf995b612aeaff5cb807d0937fc8a51d344f
diff --git a/Kakasi.NET.Interop/Properties/AssemblyInfo.cs b/Kakasi.NET.Interop/Properties/AssemblyInfo.cs
@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.2.0.0")]
-[assembly: AssemblyFileVersion("2.2.0.0")]
+[assembly: AssemblyVersion("2.4.0.0")]
+[assembly: AssemblyFileVersion("2.4.0.0")]
diff --git a/README-Latest.md b/README-Latest.md
@@ -1,5 +1,6 @@
 ﻿# Happy Reader
 WPF Program to search for data from VNDB.org via API and data dump files, also a 'game launcher' for visual novels with ability to extract text from visual novels and translate to English on-the-fly, using translation APIs and user-entered text substitutions.
+Has 'mouseover dictionary' functionality for Japanese text in output window.
   
 Supported by [JetBrains](https://www.jetbrains.com/?from=HappyReaderByZoltanar)
 
@@ -19,18 +20,18 @@ Before reporting issues or requesting features, please see [Goals](https://githu
 - Enter /H Hook Code if available
 - Back on `Games` Tab, launch Game by clicking `Off` button, or right-click and choose specific launch mode
 - In launched game, progress to dialog section
-- Back on Happy Reader, switch to 'ITHVNR' tab
+- Back on Happy Reader, switch to `Text Hooking` tab
 - Look for dialog text in the text thread panels or
 - use the command ':s' or :sa' followed by the text to search for Happy Reader to search for the text
-  - example: ':s おはよう！' to search for 'おはよう！' in each text thread, in the encodings that each thread is set to
-  - example: ':sa おはよう！' to search for 'おはよう！' in each text thread, in all 3 encodings possible (Unicode, UTF-8, Shift-JIS) (can take longer)
+  - example: `:s おはよう！` to search for `おはよう！` in each text thread, in the encodings that each thread is set to
+  - example: `:sa おはよう！` to search for `おはよう！` in each text thread, in all 3 encodings possible (Unicode, UTF-8, Shift-JIS) (can take longer)
   - Results will appear in Console thread at the top
   - If :sa is used and text is is a different encoding to the one selected in text thread panel, you can change the encoding with the drop-down on the right
 - On the relevant text thread panel, tick the 'Posting' checkbox, to allow text to appear in Output Window.
 - Advance in game to next dialog
 - A window should pop up on top of the Game Window
-  - If it does not, it may have appeared out of screen, click 'Reset Output Window' in ITHVNR tab to reset it to a visible location
-  - If it still does not appear, click 'Show Output Window' in ITHVNR tab.
+  - If it does not, it may have appeared out of screen, click `Reset Output Window` in Text Hooking tab to reset it to a visible location
+  - If it still does not appear, click 'Show Output Window' in Text Hooking tab.
 - Window should contain captured text (by default, romaji and Translation is shown)
 - Change location, size, and settings of Output Window to your preference
   - Output Window stays on top and will re-appear if closed when new text is captured
@@ -39,6 +40,7 @@ Before reporting issues or requesting features, please see [Goals](https://githu
   - Select the 'Posting' panel (click on thread name and not text box) then click 'Toggle Display Others'/'Toggle Post Others'/'Toggle Pause Others' or
   - You can also click 'Clear Others' to clear existing text from threads other than selected or
   - You can click `Ignore Other Threads` if you are sure that no other text threads are required
+- Note: in some games, the text thread identifiers change every time it is launched, when this is the case and you have identified a hook code, it is best to save this hook code to the game, and tick the `Capture By Hook Code` option, to automatically post text from threads matching that hook code instead of using thread identifiers to store user settings.
 - Play game
 - Settings for which thread to capture should be saved so next time you launch the game, you should not have to set that up.
 
@@ -84,11 +86,11 @@ Before you run this application, you can log in with your VNDB credentials in Ha
 this will ensure information about the user's labeled titles and votes is saved to the local database.  
 The user can also save all VNDB images and keep it synced, by changing the Image Sync options,  
 select the corresponding image types, the Screenshots type is the largest one at around 17GB, see https://vndb.org/d14 for more information.  
+(Currently, screenshot thumbnails are not used, they will be used as fallbacks to when full-size screenshots are not found.)  
 After changing the settings as preferred, close Happy Reader and then run DatabaseDumpReader, this can take a few minutes (5~10).  
 After it finishes, launch Happy Reader again and you should see VNDB data in Visual Novels and Characters sections.  
 You can filter this information by clicking 'Filters' in the right, a permanent filter can be set that will always be active, and you can also create custom filters to switch through.
 
-
 Translation Plugins can be created by inheriting from ITranslator interface in Happy_Apps_Core and placed (along their dependencies) in Translation Plugins folder which lies beside Happy Reader.
 
 Personal settings and VNDB data is saved to '%appdata%/Happy Reader'  
diff --git a/README.md b/README.md
@@ -1,43 +1,46 @@
 ﻿# Happy Reader
 WPF Program to search for data from VNDB.org via API and data dump files, also a 'game launcher' for visual novels with ability to extract text from visual novels and translate to English on-the-fly, using translation APIs and user-entered text substitutions.
+Has 'mouseover dictionary' functionality for Japanese text in output window.
   
 Supported by [JetBrains](https://www.jetbrains.com/?from=HappyReaderByZoltanar)
 
 Before reporting issues or requesting features, please see [Goals](https://github.com/Zoltanar/Happy-Reader/blob/master/Goals.md)
 
-# Basic Guide
+# Basic Guide (v2.4.0)
 
 - Launch Happy Reader.exe  
 - (To close the application, you must right click the icon in the Windows tray section, next to the time)
 - Click 'Settings' Tab, on the left
 - Change Translator to use and enter/modify settings as needed.
 - Enter path to Locale Emulator if required (LEProc.exe)
 - Switch to 'Games' tab
-- Drag executable to area in 'Games' tab
+- Drag executable to area in `Games` tab, or click `Add New` to select executable
 - Double-click or 'right-click > See Details' on Game to open Game Settings
 - Change 'Hook Mode' as necessary (usually VnrHook)
 - Enter /H Hook Code if available
-- Back on Games Tab, launch Game by clicking 'Off' button, or 'right-click > Launch with LE (Japan)' if required
+- Back on `Games` Tab, launch Game by clicking `Off` button, or right-click and choose specific launch mode
 - In launched game, progress to dialog section
-- Back on Happy Reader, switch to 'ITHVNR' tab
+- Back on Happy Reader, switch to `Text Hooking` tab
 - Look for dialog text in the text thread panels or
 - use the command ':s' or :sa' followed by the text to search for Happy Reader to search for the text
-  - example: ':s おはよう！' to search for 'おはよう！' in each text thread, in the encodings that each thread is set to
-  - example: ':sa おはよう！' to search for 'おはよう！' in each text thread, in all 3 encodings possible (Unicode, UTF-8, Shift-JIS) (can take longer)
+  - example: `:s おはよう！` to search for `おはよう！` in each text thread, in the encodings that each thread is set to
+  - example: `:sa おはよう！` to search for `おはよう！` in each text thread, in all 3 encodings possible (Unicode, UTF-8, Shift-JIS) (can take longer)
   - Results will appear in Console thread at the top
   - If :sa is used and text is is a different encoding to the one selected in text thread panel, you can change the encoding with the drop-down on the right
 - On the relevant text thread panel, tick the 'Posting' checkbox, to allow text to appear in Output Window.
 - Advance in game to next dialog
 - A window should pop up on top of the Game Window
-  - If it does not, it may have appeared out of screen, click 'Reset Output Window' in ITHVNR tab to reset it to a visible location
-  - If it still does not appear, click 'Show Output Window' in ITHVNR tab.
+  - If it does not, it may have appeared out of screen, click `Reset Output Window` in Text Hooking tab to reset it to a visible location
+  - If it still does not appear, click 'Show Output Window' in Text Hooking tab.
 - Window should contain captured text (by default, romaji and Translation is shown)
 - Change location, size, and settings of Output Window to your preference
   - Output Window stays on top and will re-appear if closed when new text is captured
-- At this point, everything should be ready to go, you can stop/hide other text threads to save memory and increase performance
+- At this point, everything should be ready to go, you can stop/hide other text threads to save memory and increase performance:
   - use 'Stop/Hide' buttons in each text thread panel or
-  - Select the 'Posting' panel (click on thread name and not text box) then click 'Toggle Display Others'/'Toggle Post Others'/'Toggle Pause Others'
-  - You can also click 'Clear Others' to clear existing text from threads other than selected.
+  - Select the 'Posting' panel (click on thread name and not text box) then click 'Toggle Display Others'/'Toggle Post Others'/'Toggle Pause Others' or
+  - You can also click 'Clear Others' to clear existing text from threads other than selected or
+  - You can click `Ignore Other Threads` if you are sure that no other text threads are required
+- Note: in some games, the text thread identifiers change every time it is launched, when this is the case and you have identified a hook code, it is best to save this hook code to the game, and tick the `Capture By Hook Code` option, to automatically post text from threads matching that hook code instead of using thread identifiers to store user settings.
 - Play game
 - Settings for which thread to capture should be saved so next time you launch the game, you should not have to set that up.
 
@@ -50,12 +53,18 @@ Entries can be added in different ways
 3. Import Names from VNDB title.  
 
 Once in the Add Entries tab, you can change various parameters.  
-Example of a name substitution: Type=Name, Game=Game Name (only VNDB titles currently), Role=m, Input=桜子, Output=Ouko, Series-Specific=True.  
+Example of a name substitution:  
+Type=Name, Game=User or VNDB Game Name, Role=m, Input=桜子, Output=Ouko, Series-Specific=True.  
 These can be tested in the 'Test' tab.  
 Entries of type Name and Translation use 'Proxy' entries, which will be used in the translation process.  
 The text in the entry's 'Role' dictates what kind of proxies to use.  
 If the entry has Role 'm', it will try to use a Proxy with role 'm'.
-Some proxies will be created by default (with Role 'm') but more may be needed (and will be added by default in the future).  
+Some proxies will be created by default but more may be needed if a sentence has a lot of separate names.  
+These can be added by creating entries of type `Proxy` which have an output that should match what a translator returns, when the input is provided.  
+This can be text that is unlikely to be changed by the translators such as `ZBXC > ZBXC`  
+or proper nouns without many alternative readings, which can help with context,  
+like `由紀子>Yukiko`, as it is a female name, it should return translation in a female context.  
+By creating proxies with specific Roles (like the above with role `m.f`) and then creating entries that use said roles (`アリス>Arisu with role m.f`), translation quality should improve.  
 Proxy Role suggestions:
 - m = Name
 - m.f = Female Name (defaults to 'm' if 'm.f' proxies are not found)
@@ -77,11 +86,11 @@ Before you run this application, you can log in with your VNDB credentials in Ha
 this will ensure information about the user's labeled titles and votes is saved to the local database.  
 The user can also save all VNDB images and keep it synced, by changing the Image Sync options,  
 select the corresponding image types, the Screenshots type is the largest one at around 17GB, see https://vndb.org/d14 for more information.  
+(Currently, screenshot thumbnails are not used, they will be used as fallbacks to when full-size screenshots are not found.)  
 After changing the settings as preferred, close Happy Reader and then run DatabaseDumpReader, this can take a few minutes (5~10).  
 After it finishes, launch Happy Reader again and you should see VNDB data in Visual Novels and Characters sections.  
 You can filter this information by clicking 'Filters' in the right, a permanent filter can be set that will always be active, and you can also create custom filters to switch through.
 
-
 Translation Plugins can be created by inheriting from ITranslator interface in Happy_Apps_Core and placed (along their dependencies) in Translation Plugins folder which lies beside Happy Reader.
 
 Personal settings and VNDB data is saved to '%appdata%/Happy Reader'  
