Merge branch 'master' of https://github.com/bbepis/XUnity.AutoTranslator

CHANGELOG.md

@@ -1,3 +1,13 @@
+### 2.4.0 - coming soon
+ * CHANGE - Completely reworked configuration for more organization
+ * FEATURE - Added support for BaiduTranslate. User must provide AppId/AppSecret for API . Use "BaiduTranslate" as endpoint
+ * FEATURE - Force splitting translated texts into newlines, if configured
+ * BUG FIX - Fixed broken feature that allowed disabling the online Endpoint
+ * BUG FIX - Eliminated potential concurrency issues that could cause a translated string to be retranslated.
+ * BUG FIX - Better support for other 'from' languages than japanese, as the japanese symbol check has been replaced with a more generic one
+ * BUG FIX - Fixed a bug where hot key actions (toggle translation, etc.) would often fail
+ * BUG FIX - Multiline translations now partially supported. However, all texts considered dialogue will still be translated as a single line
+
 ### 2.3.1
  * Fixed bug that caused the application to quit if any hooks were overriden.
 

README.md

@@ -17,23 +17,41 @@ The mod can be installed into the following Plugin Managers:
 Installations instructions for both methods can be found below.
 
 ## Configuration
-The default configuration file, looks as such:
+The default configuration file, looks as such (2.4.0+):
 
 ```ini
-[AutoTranslator]
-Endpoint=GoogleTranslate                                          ;the endpoint to use to translate
-Language=en                                                       ;the language to translate into
-FromLanguage=ja                                                   ;the language to translate fromm
-Delay=0                                                           ;a delay to be applied before attempting to translate a text, if the text framework supports it. Measured in seconds
-Directory=Translation                                             ;the directory that the plugin will look for cached translations in
-OutputFile=Translation\_AutoGeneratedTranslations.{lang}.txt      ;the file that the plugin will write auto translated texts to
-MaxCharactersPerTranslation=150                                   ;the max number of characters that a text may contain in order to be translated
-EnableIMGUI=True                                                  ;specify if IMGUI should be translated
-EnableUGUI=True                                                   ;specify if UGUI should be translated
-EnableNGUI=True                                                   ;specify if NGUI should be translated
-EnableTextMeshPro=True                                            ;specify if TextMeshPro should be translated
-AllowPluginHookOverride=True                                      ;specify whether to allow other plugins to override this plugins code hooks
-
+[Service]
+Endpoint=GoogleTranslate         ;Endpoint to use. Can be ["GoogleTranslate", "BaiduTranslate"]
+EnableSSL=False                  ;Whether or not to use HTTPS endpoint over standard HTTP
+
+[General]
+Language=en                      ;The original language of the game
+FromLanguage=ja                  ;The language to translate into
+
+[Files]
+Directory=Translation                                          ;Directory to search for cached translation files
+OutputFile=Translation\_AutoGeneratedTranslations.{lang}.txt   ;File to insert generated translations into
+
+[TextFrameworks]
+EnableIMGUI=True                 ;Enable or disable IMGUI translation
+EnableUGUI=True                  ;Enable or disable UGUI translation
+EnableNGUI=True                  ;Enable or disable NGUI translation
+EnableTextMeshPro=True           ;Enable or disable TextMeshProp translation
+AllowPluginHookOverride=True     ;Allow other text translation plugins to override this plugin's hooks
+
+[Behaviour]
+Delay=0                          ;Delay to wait before attempting to translate a text in seconds
+MaxCharactersPerTranslation=150  ;Max characters per text to translate
+IgnoreWhitespaceInDialogue=True  ;Whether or not to ignore whitespace, such as newlines, in dialogue keys
+MinDialogueChars=20              ;The length of the text for it to be considered a dialogue
+ForceSplitTextAfterCharacters=0  ;Split text into multiple lines once the translated text exceeds this number of characters
+
+[Baidu]
+BaiduAppId=                      ;OPTIONAL, needed if BaiduTranslate is configured
+BaiduAppSecret=                  ;OPTIONAL, needed if BaiduTranslate is configured
+
+[Debug]
+EnablePrintHierarchy=False       ;Used for debugging
 ```
 
 ## Key Mapping