|
|
@@ -1,18 +1,20 @@
|
|
|
# XUnity Auto Translator
|
|
|
|
|
|
## Index
|
|
|
- * Notice
|
|
|
- * Text Frameworks
|
|
|
- * Plugin Frameworks
|
|
|
- * Configuration
|
|
|
- * Key Mapping
|
|
|
- * Installation
|
|
|
- * Translating Mods
|
|
|
- * Texture Translation
|
|
|
- * Integrating with Auto Translator
|
|
|
+ * [Notice](#notice)
|
|
|
+ * [Text Frameworks](#text-frameworks)
|
|
|
+ * [Plugin Frameworks](#plugin-frameworks)
|
|
|
+ * [Configuration](#configuration)
|
|
|
+ * [Key Mapping](#key-mapping)
|
|
|
+ * [Installation](#installation)
|
|
|
+ * [Translating Mods](#translating-mods)
|
|
|
+ * [Texture Translation](#texture-translation)
|
|
|
+ * [Integrating with Auto Translator](#integrating-with-auto-translator)
|
|
|
|
|
|
## Notice
|
|
|
-The latest version (3.0.0) now also supports basic image loading/dumping. These are not automatically translated and the feature is disabled by default. Please see 'Texture Translation' for further instructions.
|
|
|
+The latest version (3.0.0) now also supports basic image loading/dumping. These are not automatically translated and the feature is disabled by default.
|
|
|
+
|
|
|
+If you are going to make use of this feature, please make sure you read and understand the [Texture Translation](#texture-translation) section!
|
|
|
|
|
|
## Text Frameworks
|
|
|
This is an auto translation mod that hooks into the unity game engine and attempts to provide translations for the following text frameworks for Unity:
|
|
|
@@ -52,7 +54,7 @@ OutputFile=Translation\_AutoGeneratedTranslations.{lang}.txt ;File to insert g
|
|
|
[TextFrameworks]
|
|
|
EnableUGUI=True ;Enable or disable UGUI translation
|
|
|
EnableNGUI=True ;Enable or disable NGUI translation
|
|
|
-EnableTextMeshPro=True ;Enable or disable TextMeshProp translation
|
|
|
+EnableTextMeshPro=True ;Enable or disable TextMeshPro translation
|
|
|
EnableIMGUI=False ;Enable of disable IMGUI translation
|
|
|
AllowPluginHookOverride=True ;Allow other text translation plugins to override this plugin's hooks
|
|
|
|
|
|
@@ -80,7 +82,7 @@ EnableTextureTranslation=False ;Indicates whether the plugin will attempt to r
|
|
|
EnableTextureDumping=False ;Indicates whether the plugin will dump texture it is capapble of replacing to the TextureDirectory. Has significant performance impact
|
|
|
EnableTextureToggling=False ;Indicates whether or not toggle the translation with the ALT+T hotkey will also affect textures. Not guaranteed to work for all textures. Has significant performance impact
|
|
|
EnableTextureScanOnSceneLoad=True ;Indicates whether or not the plugin should scan for textures on scene load. This enables the plugin to find and replace more texture
|
|
|
-LoadUnmodifiedTextures=False ;Indicates whether or not unmodified textures should be loaded. Modifications are determined based on the hash in the file name
|
|
|
+LoadUnmodifiedTextures=False ;Indicates whether or not unmodified textures should be loaded. Modifications are determined based on the hash in the file name. Only enable this for debugging purposes as it is likely to cause oddities
|
|
|
TextureHashGenerationStrategy=FromImageName ;Indicates how the mod identifies pictures through hashes. Can be ["FromImageName", "FromImageData", "FromImageNameThenData"]
|
|
|
|
|
|
[Http]
|
|
|
@@ -196,7 +198,7 @@ The file structure should like like this
|
|
|
Often other mods UI are implemented through IMGUI. As you can see above, this is disabled by default. By changing the "EnableIMGUI" value to "True", it will start translating IMGUI as well, which likely means that other mods UI will be translated.
|
|
|
|
|
|
## Texture Translation
|
|
|
-From version 3.0.0+ this mode provides basic capabilities to replace images. It is a feature that is disabled by default. There is no automatic translation of these images though.
|
|
|
+From version 3.0.0+ this mod provides basic capabilities to replace images. It is a feature that is disabled by default. There is no automatic translation of these images though.
|
|
|
|
|
|
It is controlled by the following configuration:
|
|
|
|
|
|
@@ -206,34 +208,47 @@ TextureDirectory=Translation\Texture
|
|
|
EnableTextureTranslation=False
|
|
|
EnableTextureDumping=False
|
|
|
EnableTextureToggling=False
|
|
|
+EnableTextureScanOnSceneLoad=True
|
|
|
+LoadUnmodifiedTextures=False
|
|
|
TextureHashGenerationStrategy=FromImageName
|
|
|
```
|
|
|
|
|
|
-`TextureDirectory=Translation\Texture` specifies the directory where textures are dumped to and loaded from. Loading will happen from all subdirectories of the specified directory as well, so you can move dumped images to whatever folder structure you desire.
|
|
|
+`TextureDirectory` specifies the directory where textures are dumped to and loaded from. Loading will happen from all subdirectories of the specified directory as well, so you can move dumped images to whatever folder structure you desire.
|
|
|
|
|
|
-`EnableTextureTranslation=True` enables texture translation. This basically means that textures will be loaded from the `TextureDirectory` and it's subsdirectories. These images will replace the in-game images used by the game.
|
|
|
+`EnableTextureTranslation` enables texture translation. This basically means that textures will be loaded from the `TextureDirectory` and it's subsdirectories. These images will replace the in-game images used by the game.
|
|
|
|
|
|
-`EnableTextureDumping=True` enables texture dumping. This means that the mod will dump any images it has not already dumped to the `TextureDirectory`. **NEVER REDISTRIBUTE THIS MOD WITH THIS ENABLED.**
|
|
|
+`EnableTextureDumping` enables texture dumping. This means that the mod will dump any images it has not already dumped to the `TextureDirectory`. **NEVER REDISTRIBUTE THIS MOD WITH THIS ENABLED.**
|
|
|
|
|
|
-`EnableTextureScanOnSceneLoad=True` allows the plugin to scan for texture objects on the sceneLoad event. This enables the plugin to find more texture at a tiny performance cost.
|
|
|
+`EnableTextureScanOnSceneLoad` allows the plugin to scan for texture objects on the sceneLoad event. This enables the plugin to find more texture at a tiny performance cost. However, because of the way Unity works not all of these are guaranteed to be replacable. If you find an image that is dumped but cannot be translated, please report it. However, please recognize this mod is primarily intended for replacing UI textures, not textures for 3D meshes.
|
|
|
|
|
|
-`LoadUnmodifiedTextures=False` enabldes whether or not the plugin should load textures that has not been modified. This is only useful for debugging. **NEVER REDISTRIBUTE THIS MOD WITH THIS ENABLED.**
|
|
|
+`LoadUnmodifiedTextures` enables whether or not the plugin should load textures that has not been modified. This is only useful for debugging, and likely to cause various visual glitches, especially if `EnableTextureScanOnSceneLoad` is also enabled. **NEVER REDISTRIBUTE THIS MOD WITH THIS ENABLED.**
|
|
|
|
|
|
-`EnableTextureToggling=False` enables toggle textures with the ALT+T hotkey. **NEVER REDISTRIBUTE THIS MOD WITH THIS ENABLED.**
|
|
|
+`EnableTextureToggling` enables whether the ALT+T hotkey will also toggle textures. Also this by no means guaranteed to work, especially if `EnableTextureScanOnSceneLoad` is also enabled. **NEVER REDISTRIBUTE THIS MOD WITH THIS ENABLED.**
|
|
|
|
|
|
-`TextureHashGenerationStrategy=FromImageName` specifies how images are identified. When images are stored, the game will need some way of associating them with the image that it has to replace.
|
|
|
-This is done through a hash-value that is stored in square brackets in each image file name. This configuration specifies how these hash-values are generated.
|
|
|
-`FromImageName` means that the hash is generated from the internal resource name that the game uses for the image, which may not exist for all images.
|
|
|
-`FromImageData` means that the hash is generated from the data stored in the image, which is guaranteed to exist for all images.
|
|
|
-`FromImageNameThenData` means that it should use the name, if available, otherwise use the data.
|
|
|
+`TextureHashGenerationStrategy` specifies how images are identified. When images are stored, the game will need some way of associating them with the image that it has to replace.
|
|
|
+This is done through a hash-value that is stored in square brackets in each image file name, like this: `file_name [0223B639-6E698E92].png`. This configuration specifies how these hash-values are generated:
|
|
|
+ * `FromImageName` means that the hash is generated from the internal resource name that the game uses for the image, which may not exist for all images or even be unique. However, it is generally fairly reliable.
|
|
|
+ * `FromImageData` means that the hash is generated from the data stored in the image, which is guaranteed to exist for all images. However, generating the hash comes at a performance cost.
|
|
|
+ * `FromImageNameThenData` means that it should use the name, if available, otherwise use the data.
|
|
|
|
|
|
There's an important catch you need to be aware when dealing with these options and that is if ANY of these options exists: `EnableTextureDumping=True`, `EnableTextureToggling=True`, `TextureHashGenerationStrategy=FromImageData|FromImageNameThenData`, then the game will need to read the raw data from all images it finds in game in order to replace the image and this is an expensive operation.
|
|
|
|
|
|
-It is therefore recommended to use `TextureHashGenerationStrategy=FromImageName`. Most likely, images without a resource name wont be interesting to translate anyway.
|
|
|
+It is therefore recommended to use `TextureHashGenerationStrategy=FromImageName`. Most likely, images without a resource name won't be interesting to translate anyway.
|
|
|
+
|
|
|
+If you redistribute this mod with translated images, it is recommended you delete all images you either have no intention of translating or are not translated at all.
|
|
|
+
|
|
|
+You can also change the file name to whatever you desire, as long as you keep the hash appended to the end of the file name.
|
|
|
+
|
|
|
+If you take anything away from this section, it should be these two points:
|
|
|
+ * **NEVER REDISTRIBUTE THIS MOD WITH `EnableTextureDumping=True`, `EnableTextureToggling=True` OR `LoadUnmodifiedTextures=True`**
|
|
|
+ * **ONLY DISTRIBUTE THIS MOD WITH `TextureHashGenerationStrategy=FromImageData|FromImageNameThenData` ENABLED IF ABSOLUTELY REQUIRED BY THE GAME.**
|
|
|
|
|
|
-If you redistribute this mod with translated images then you **must delete all images that you do not translate to avoid resource waste**, as they are all loaded into memory on mod startup.
|
|
|
+### Technical details about Hash Generation in file names
|
|
|
+There are actually two hashes in the generated file name, separated by a dash (-):
|
|
|
+ * The first hash is a SHA1 (only first 4 bytes) based on the `TextureHashGenerationStrategy` used. If `FromImageName` is specified, then it is based on the UTF8 representation.
|
|
|
+ * The second hash is a SHA1 (only first 4 bytes) based on the data in the image. This is used to determine whether or not the image has been modified, so images that has not been edited are not loaded. Unless `LoadUnmodifiedTextures` is specified.
|
|
|
|
|
|
-**NEVER REDISTRIBUTE THIS MOD WITH `EnableTextureDumping=True`, `EnableTextureToggling=True`, `LoadUnmodifiedTextures=False` OR `TextureHashGenerationStrategy=FromImageData|FromImageNameThenData` ENABLED.**
|
|
|
+If `TextureHashGenerationStrategy=FromImageData` is specified, only a single hash will appear in each file name, as that single hash can be used both to identify the image and to determine whether or not it has been edited.
|
|
|
|
|
|
## Integrating with Auto Translator
|
|
|
|
randoman