XUnity.AutoTranslator  by bbepis

Advanced translator plugin for Unity games

created 7 years ago
2,555 stars

Top 18.8% on sourcepulse

GitHubView on GitHub
Project Summary

This project provides an advanced auto-translator for Unity-based games, enabling both automated and manual text translation. It's designed for gamers and modders seeking to localize games or mods that lack official language support. The plugin integrates with various mod loaders and offers extensive configuration for translation services, text handling, and UI adjustments.

How It Works

The plugin hooks into Unity's text rendering pipeline to intercept and translate text elements. It supports multiple text frameworks (UGUI, NGUI, TextMeshPro, etc.) and offers a wide array of translation services, including popular online providers like Google Translate, Bing, and DeepL, as well as options for API-key based services. Advanced features include text splitting, whitespace handling, UI resizing, font overriding, and a resource redirector for modifying game assets.

Quick Start & Requirements

  • Installation: Download the appropriate release zip (e.g., XUnity.AutoTranslator-BepInEx-{VERSION}.zip) and extract its contents into the game's root directory, following the specific instructions for your chosen mod loader (BepInEx, MelonLoader, IPA, UnityInjector, or standalone ReiPatcher).
  • Requirements: A Unity-based game. Specific mod loader installations may have their own prerequisites.
  • Configuration: Edit the config.ini file generated after the first game launch to select translation services, languages, and other behavior settings.
  • Documentation: https://github.com/bbepis/XUnity.AutoTranslator/blob/master/README.md

Highlighted Details

  • Supports over 15 translation services, including free and paid API options.
  • Features a robust resource redirector for modifying game assets like TextAssets and textures.
  • Includes extensive configuration options for fine-tuning translation behavior, whitespace handling, and UI resizing.
  • Offers manual translation capabilities through editable text files and a built-in translation cache.

Maintenance & Community

  • The project is actively maintained, with frequent updates and contributions.
  • Community support channels are available via Discord.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: Generally compatible with most Unity games. IL2CPP support is noted as experimental with some limitations.

Limitations & Caveats

  • Automated translation relies on internet connectivity.
  • Some translation services are marked as "unstable" due to reliance on unofficial APIs.
  • IL2CPP builds have reduced functionality, with text hooking, IMGUI translation, and plugin-specific translations being experimental or unsupported.
Health Check
Last commit

3 months ago

Responsiveness

1 week

Pull Requests (30d)
0
Issues (30d)
16
Star History
230 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.