One Click Localization (OCL) is a Localization Tool for Unity designed to be easy and fast to use.
The aim of OCL is that... you don't think about localization... OCL is based on values instead of keys like most of the localization systems, that's why you don't need to take care of it until you really want localize your project.

Its customizable automatic setup and its generic component adapter will let you localize a project in minutes, whithout a single line of code.

Quick Start Video - Unity Standard Assets

Example - Survival Shooter localized in 2min

Test App

Use the Test App in Editor

1. Download OCL from the Unity Asset Store
OCL in Asset Store
2. Import OCL Package

All OCL content is located in a single directory "OneClickLocalization"


3. Open Setup Window : Window / OneClickLocalization / Setup
4. Be sure to have the scenes you want to parse in your Build Settings/Scenes In Build project's configuration
5. Click on the Start Automatic setup button (this is the One Click ;))
6. Voilà! Youre project is Localization Ready!
7. Now you can add languages and start localize your texts from the Localization Window
8. Finally, you can run your project to test localization (if your default language equals your system's language, uncheck Use system's language and select the right language)

The Setup Window is used to configure OCL and start automatic setups.

Save / Load

OCL saves all its configuration data and localizations (used at runtime) in a single asset file OCLSetup.asset located in "Assets/OneClickLocalization/Resources" folder.
Be sure to add this file to your Source Control, to use Cloud Build and keep setup and localizations.

• Save Setup

Saves the current configuration and localizations to the specified path.
You can't save outside of the project Assets folder

• Load Setup

Load the specified setup asset and replaces the current one.
You will lose current configuration and localizations.

Settings

This options can be modified during runtime via the Script API

• Activate localization

If unchecked, OCL is deactivated.

• Use system's language

If checked, OCL automatically detects language by using Application.systemLanguage

• Force language

Available if Use system's language is unchecked. Select the language used by OCL.

• Default language for nulls

If checked, OCL API will return default language value when translation is null.

Usefull when you don't want check null values by yourself and avoid blank texts in your UI.

Automatic Setup

• Add OCL Component

If checked, setup process will add OCLComponentAdapter to GameObjects found with a supported type.

• Extract Data

If checked, setup process will extract data from the supported types to the localization list. You can then edit this localizations with the Localization Window

• Configure Includes / Exlude

Specify lists of components to include or exclude from setup process.
By default, only components supported by OCLComponentAdapter are in the include list :
UnityEngine.UI.Text, UnityEngine.UI.Image, UnityEngine.UI.RawImage, UnityEngine.TextMesh, UnityEngine.AudioSource, UILabel (NGui)

• Parse Scene objects

If checked, setup process will parse objects from scenes

• Selected scenes
List of scenes to parse. Only scenes from the build settings Scenes in build are available.
• Parse inactives
If unchecked, inactive objects will be skipped
• Parse Prefab assets

If checked, setup process will parse prefabs from the Assets folder.

• Assets subpath
Let you define a subpath of prefabs to parse.
• Parse inactives
If unchecked, inactive objects will be skipped
• Parse Scriptable Objects assets (disabled by default)

If checked, setup process will parse ScriptableObjects from the Assets folder. It will extract strings from field (going recursively though lists, arrays and objects) and though root object properties (no recursivity here).

• Assets subpath
Let you define a subpath of ScriptableObject to parse. You should always specify this option when using this parsing, as it avoids all ScriptableObject from other packages (TextMeshPro, etc.).

Languages

• Default

The language of your content before localization.

• Languages table

The table displays all the selected languages, the ratio of ids localized and the option to add/remove a language.
When you remove a language, you lose all the OCL data related to it, use carefully.

• Edit Localizations

Opens the Localization Window

Microsoft Azure Translator

Add your Resource key from Azure portal in the Key input (key is something like "adf86b4e3d1a488f84db076092e19f16", you can grab it from the "Manage keys" section in Azure portal)

Translator can be used though the Localization Window :

You can also use the "Translate all" button, it will translate all the entries visible in the table (based on the filters)

WARNING : be sure to use "global" configuration when you create a new Azure Translator cognitive service on the portal, or you could get "401 errors"

Reset

The reset will :

• Search for ALL OCLComponentAdapter in the project (from build scenes and prefabs) to remove them.
• Reset Setup Window data
• Reset languages configuration
• Reset all localizations

The Localization Window is an integrated editor for all your localizations : string, Sprite, Texture or AudioClip

A localization can have two states for a language :

• null : if GetLocalization is called for this id, it will answer null.
• not null : the value will be returned when GetLocalization is called

When using OCL from script API, be sure to check if returned value is null.

For strings : null and empty are differenciated, if you want a string to be null : use the Reset button

Edit Localizations Window supports Undo / Redo and line returns.

Filters

• Untranslated only : If checked, the table only show localization with a null value
• Search : Filters the table with the specified string
• Languages : Table displays only localizations for the selected languages
• Apply : Apply the current filter values to Ids
• Reset : Reverts filter values to default

String Parameters

Strings support parameters for dynamic content.
Use bracket numbered ids : ${#}

Example :

OCL will then automatically replace parameters using regular expressions.

String Import/Export

You can import and export your strings to xml and csv formats

<?xml version="1.0" encoding="UTF-8"?>
<localization>
  <strings>
    <string stringId="String to localize 1">
      <value lang="French">String à localiser 1</value>
      <value lang="German">I can't speak German 1</value>
    </string>
    <string stringId="Another string to localize">
      <value lang="French">Une autre String à localiser</value>
      <value lang="German">I still can't speak German</value>
    </string>
  </strings>
</localization>

StringId,French,German
String to localize 1,String à localiser 1,I can't speak German 1
Another string to localize,Une autre String à localiser,I still can't speak German
"String to localize with, special ' characters","String avec caracteres speciaux,'",I can't speak German... really

Components are based on the OCL Script API, they apply the localization data to the GameObjects.

Only one component currently exist OCLComponentAdapter designed for ease of use and fast integration. More will come soon dedicated to performances

OCLComponentAdapter

Automatically localize supported components on the same GameObject, no configuration needed.

Localization is currently supported for the following components (with corresponding type)

• UnityEngine.UI.Text (string)
• UILabel (string) - NGui component, tested on free version 2.7.0
• UnityEngine.TextMesh (string)
• UnityEngine.Image (Sprite)
• UnityEngine.RawImage (Texture)
• UnityEngine.AudioSource (AudioClip)

To add it to a GameObject :

• Automatic : using Automatic Setup with the option Add OCL Component.
• Manual : you'll find it in the OneClickLocalization Category

You enable or disable types for the component. This is not dynamic during runtime for performance reasons.

Performances remarks

• OCLComponentAdapter test on each update if supported components values have changed and cache data to optimize the test as much as possible. String comparison is very fast and therefore has very low impact on performances. Texture, Sprite and AudioClip comparisons can impact performances when heavily used, they should be used wisely
• Impact on performances grows with the number of OCLComponentAdapter running, therefore adding OCLComponentAdapter automatically with Automatic Setup should be used carefully and its impact tested with the profiler.

OCL exposes full access to its configuration and data though a complete C# API

All the API is accessed from the static class OneClickLocalization.OCL

OCL only uses UnityEngine.SystemLanguage to determine language, no locale (en_En, fr_FR, etc...)

Delegates

delegate void ActiveChanged(bool isActive)
ActiveChanged onActiveChanged

delegate void LanguageChanged(SystemLanguage oldLang, SystemLanguage newLang)
LanguageChanged onLanguageChanged

delegate void LanguagesChanged()
LanguagesChanged onLanguagesChanged

delegate void LocalizationChanged(object id, SystemLanguage language, object newValue)
LocalizationChanged onLocalizationChanged

Methods

bool IsActive()

void SetActive(bool value)

void SetLanguage(SystemLanguage language)

SystemLanguage GetLanguage()

bool IsLanguageAuto()

void setLanguageAuto(bool isAuto)

void AddLanguage(SystemLanguage language)

void RemoveLanguage(SystemLanguage language)

List SystemLanguage GetLanguages(bool addDefaultLanguage = true)

object GetLocalization(object itemId)

string GetLocalization(string originalString)
Sprite GetLocalization(Sprite originalSprite)
Texture GetLocalization(Texture originalTexture)
AudioClip GetLocalization(AudioClip originalAudioClip)

string GetLocalization(string originalString, SystemLanguage language)

Sprite GetLocalization(Sprite originalSprite, SystemLanguage language)
Texture GetLocalization(Texture originalTexture, SystemLanguage language)
AudioClip GetLocalization(AudioClip originalAudioClip, SystemLanguage language)

void SetLocalization(object id, SystemLanguage language, object translation)

void SetLocalization(string id, SystemLanguage language, string translation)
void SetLocalization(Sprite id, SystemLanguage language, Sprite translation)
void SetLocalization(Texture id, SystemLanguage language, Texture translation)
void SetLocalization(AudioClip id, SystemLanguage language, AudioClip translation)

Examples

Get a localization for current language

string localization = OCL.GetLocalization("my text to localize");

Get a localization for a specific language

string localization = OCL.GetLocalization("my text to localize", SystemLanguage.German);

List languages in a Dropdown

// Languages list init
List<string> languagesStrings = new List<string>();
// Add supported languages
foreach (SystemLanguage supportedLanguage in OCL.GetLanguages())
{
    languagesStrings.Add(supportedLanguage.ToString());
}
languageDropdown.AddOptions(languagesStrings);

Change language from a Dropdown selection

string selectedLanguage = languageDropdown.options[languageDropdown.value].text;
OCL.SetLanguage((SystemLanguage) Enum.Parse(typeof(SystemLanguage), selectedLanguage));

Add new language

SystemLanguage language = SystemLanguage.German;
if (OCL.GetLanguages(false).Contains(language))
{
    Debug.Log("Selected language already there.");
}
else
{
    OCL.AddLanguage(language);
}

Set new localization value

if (OCL.GetLanguages().Contains(language))
{
    OCL.SetLocalization("localized text", language, "My new value for this localized text");
    Debug.Log("Localization updated");
}
else
{
    Debug.Log("Selected language is not supported, use AddLanguage()");
}

For complete examples, see the Demo App code shipped with OCL

Found a bug? Any question? Contact us 7/7, day and night! (but don't expect immediate answer at night... or on sunday... and saturday... And maybe not too early in the morning... at least not before first coffee)