# XUnity Auto Translator

Index

• Introduction
• Plugin Frameworks
• Installation
• Key Mapping
• Translators
• Text Frameworks
• Configuration
• IL2CPP Support
• Frequently Asked Questions
• Translating Mods
• Manual Translations
• Regarding Redistribution
• Texture Translation
• Integrating with Auto Translator
• Implementing a Translator
• Implementing a Resource Redirector

Introduction

This is an advanced translator plugin that can be used to translate Unity-based games automatically and also provides the tools required to translate games manually.

It does (obviously) go to the internet, in order to provide the automated translation, so if you are not comfortable with that, don't use it.

If you intend on redistributing this plugin as part of a translation suite for a game, please read this section and the section regarding manual translations so you understand how the plugin operates.

Plugin Frameworks

The mod can be installed without any external dependencies or as a plugin to the following Plugin Managers/Mod Loaders: * BepInEx (recommended) * MelonLoader * IPA * UnityInjector

Installation instructions for all methods can be found below.

Installation

The plugin can be installed in following ways:

Standalone Installation (ReiPatcher)

REQUIRES: Nothing, ReiPatcher is provided by this download.

VERY IMPORTANT NOTE: Using this method is a certain way to get the plugin working in most Unity games with two simple clicks. Do note that if one of the supported Plugin Managers is used, this installation method should be avoided as it will cause problems.

0. Read the VERY IMPORTANT NOTE above.
1. Download XUnity.AutoTranslator-ReiPatcher-{VERSION}.zip from releases.
2. Extract directly into the game directory, such that "SetupReiPatcherAndAutoTranslator.exe" is placed alongside other exe files.
3. Execute "SetupReiPatcherAndAutoTranslator.exe". This will setup up ReiPatcher correctly.
4. Execute the shortcut {GameExeName} (Patch and Run).lnk that was created besides existing executables. This will patch and launch the game.
5. From now on you can launch the game from the {GameExeName}.exe instead.
6. Due to various considerations, not all text hooks are enabled by default, so if you find that the game or parts of the game are not being properly translated it may be worth going into the configuration file and enable some of the disabled text frameworks! The configuration file is created when the game is launched.

The file structure should like like this

{GameDirectory}/ReiPatcher/Patches/XUnity.AutoTranslator.Patcher.dll
{GameDirectory}/ReiPatcher/ExIni.dll
{GameDirectory}/ReiPatcher/Mono.Cecil.dll
{GameDirectory}/ReiPatcher/Mono.Cecil.Inject.dll
{GameDirectory}/ReiPatcher/Mono.Cecil.Mdb.dll
{GameDirectory}/ReiPatcher/Mono.Cecil.Pdb.dll
{GameDirectory}/ReiPatcher/Mono.Cecil.Rocks.dll
{GameDirectory}/ReiPatcher/ReiPatcher.exe
{GameDirectory}/{GameExeName}_Data/Managed/ReiPatcher.exe
{GameDirectory}/{GameExeName}_Data/Managed/XUnity.Common.dll
{GameDirectory}/{GameExeName}_Data/Managed/XUnity.ResourceRedirector.dll
{GameDirectory}/{GameExeName}_Data/Managed/XUnity.AutoTranslator.Plugin.Core.dll
{GameDirectory}/{GameExeName}_Data/Managed/XUnity.AutoTranslator.Plugin.ExtProtocol.dll
{GameDirectory}/{GameExeName}_Data/Managed/MonoMod.RuntimeDetour.dll
{GameDirectory}/{GameExeName}_Data/Managed/MonoMod.Utils.dll
{GameDirectory}/{GameExeName}_Data/Managed/Mono.Cecil.dll
{GameDirectory}/{GameExeName}_Data/Managed/0Harmony.dll
{GameDirectory}/{GameExeName}_Data/Managed/ExIni.dll
{GameDirectory}/{GameExeName}_Data/Managed/Translators/{Translator}.dll
{GameDirectory}/AutoTranslator/Translation/AnyTranslationFile.txt (these files will be auto generated by plugin!)
 ```

**NOTE:** The `Mono.Cecil.dll` file placed in the ReiPatcher directory is not the same file as is placed in the Managed directory.

### BepInEx Plugin
REQUIRES: [BepInEx plugin manager](https://github.com/BepInEx/BepInEx) (follow its installation instructions first!). 

 1. Download XUnity.AutoTranslator-BepInEx-{VERSION}.zip from [releases](https://github.com/bbepis/XUnity.AutoTranslator/blob/HEAD/../../releases).
 2. Extract directly into the game directory, such that the plugin dlls are placed in BepInEx folder.
 3. Launch the game.
 4. Due to various considerations, not all text hooks are enabled by default, so if you find that the game or parts of the game are not being properly translated it may be worth going into the configuration file and enable some of the disabled text frameworks! The configuration file is created when the game is launched.

The file structure should like like this:

{GameDirectory}/BepInEx/core/XUnity.Common.dll {GameDirectory}/BepInEx/plugins/XUnity.ResourceRedirector/XUnity.ResourceRedirector.dll {GameDirectory}/BepInEx/plugins/XUnity.ResourceRedirector/XUnity.ResourceRedirector.BepInEx.dll {GameDirectory}/BepInEx/plugins/XUnity.AutoTranslator/XUnity.AutoTranslator.Plugin.Core.dll {GameDirectory}/BepInEx/plugins/XUnity.AutoTranslator/XUnity.AutoTranslator.Plugin.BepInEx.dll {GameDirectory}/BepInEx/plugins/XUnity.AutoTranslator/XUnity.AutoTranslator.Plugin.ExtProtocol.dll {GameDirectory}/BepInEx/plugins/XUnity.AutoTranslator/ExIni.dll {GameDirectory}/BepInEx/plugins/XUnity.AutoTranslator/Translators/{Translator}.dll {GameDirectory}/BepInEx/core/MonoMod.RuntimeDetour.dll {GameDirectory}/BepInEx/core/MonoMod.Utils.dll {GameDirectory}/BepInEx/core/Mono.Cecil.dll {GameDirectory}/BepInEx/Translation/AnyTranslationFile.txt (these files will be auto generated by plugin!)

#### BepInEx IL2CPP Plugin
The instructions for installation for IL2CPP are the same as for the standard version except that you must install BepInEx 6 for IL2CPP, which as of this writing are only available as bleeding edge builds [right here](https://builds.bepis.io/projects/bepinex_be) and you must use the `BepInEx-IL2CPP` package of this plugin instead.

The current version (5.4.0) was built against bleeding edge build 704.

### MelonLoader Plugin
REQUIRES: [Melon Loader](https://melonwiki.xyz) (follow its installation instructions first!).

 1. Download XUnity.AutoTranslator-MelonMod-{VERSION}.zip from [releases](https://github.com/bbepis/XUnity.AutoTranslator/blob/HEAD/../../releases).
 2. Extract directly into the game directory, such that the plugin dlls are placed in Mods and UserLibs folders.
 3. Launch the game.
 4. Due to various considerations, not all text hooks are enabled by default, so if you find that the game or parts of the game are not being properly translated it may be worth going into the configuration file and enable some of the disabled text frameworks! The configuration file is created when the game is launched.

The file structure should like like this:

{GameDirectory}/Mods/XUnity.AutoTranslator.Plugin.MelonMod.dll {GameDirectory}/UserLibs/XUnity.Common.dll {GameDirectory}/UserLibs/XUnity.ResourceRedirector.dll {GameDirectory}/UserLibs/XUnity.AutoTranslator.Plugin.Core.dll {GameDirectory}/UserLibs/XUnity.AutoTranslator.Plugin.ExtProtocol.dll {GameDirectory}/UserLibs/ExIni.dll {GameDirectory}/UserLibs/Translators/{Translator}.dll {GameDirectory}/AutoTranslator/Translation/AnyTranslationFile.txt (these files will be auto generated by plugin!)

The current version (5.4.0) was built against v0.6.1 Open-Beta.

#### MelonLoader IL2CPP Plugin
The instructions for installation for IL2CPP are the same as for the standard version except that you must use the `MelonMod-IL2CPP` package of this plugin instead.

### IPA Plugin
REQUIRES: [IPA plugin manager](https://github.com/Eusth/IPA) (follow its installation instructions first!).

 1. Download XUnity.AutoTranslator-IPA-{VERSION}.zip from [releases](https://github.com/bbepis/XUnity.AutoTranslator/blob/HEAD/../../releases).
 2. Extract directly into the game directory, such that the plugin dlls are placed in Plugins folder.
 3. Launch the game.
 4. Due to various considerations, not all text hooks are enabled by default, so if you find that the game or parts of the game are not being properly translated it may be worth going into the configuration file and enable some of the disabled text frameworks! The configuration file is created when the game is launched.

The file structure should like like this

{GameDirectory}/Plugins/XUnity.Common.dll {GameDirectory}/Plugins/XUnity.ResourceRedirector.dll {GameDirectory}/Plugins/XUnity.AutoTranslator.Plugin.Core.dll {GameDirectory}/Plugins/XUnity.AutoTranslator.Plugin.IPA.dll {GameDirectory}/Plugins/XUnity.AutoTranslator.Plugin.ExtProtocol.dll {GameDirectory}/Plugins/MonoMod.RuntimeDetour.dll {GameDirectory}/Plugins/MonoMod.Utils.dll {GameDirectory}/Plugins/Mono.Cecil.dll {GameDirectory}/Plugins/0Harmony.dll {GameDirectory}/Plugins/ExIni.dll {GameDirectory}/Plugins/Translators/{Translator}.dll {GameDirectory}/Plugins/Translation/AnyTranslationFile.txt (these files will be auto generated by plugin!) ```

UnityInjector Plugin

REQUIRES: UnityInjector (follow its installation instructions first!).

1. Download XUnity.AutoTranslator-UnityInjector-{VERSION}.zip from releases.
2. Extract directly into the game directory, such that the plugin dlls are placed in UnityInjector folder. This may not be game root directory!
3. Launch the game.
4. Due to various considerations, not all text hooks are enabled by default, so if you find that the game or parts of the game are not being properly translated it may be worth going into the configuration file and enable some of the disabled text frameworks! The configuration file is created when the game is launched.

The file structure should like like this ``` {GameDirectory}/UnityInjector/XUnity.Common.dll {GameDirectory}/UnityInjector/XUnity.ResourceRedirector.dll {GameDirectory}/UnityInjector/XUnity.AutoTranslator.Plugin.Core.dll {GameDirectory}/UnityInjector/XUnity.AutoTranslator.Plugin.UnityInjector.dll {GameDirectory}/UnityInjector/XUnity.AutoTranslator.Plugin.ExtProtocol.dll {GameDirectory}/UnityInjector/0Harmony.dll {GameDirectory}/UnityInjector/Translators/{Translator}.dll {GameDirectory}/UnityInjector/Config/Translation/AnyTranslationFile.txt (these files will be auto ge