This tool is designed for both beginners and experts to make localization process as effortless and straight forward as possible.

Structure:

Swift Key Localization requires a settings asset and at least one library asset. To create them you can follow the Localization Settings window or SKLoc wizard, both available at the Tools>>Localization menu.

1.Settings asset:

The settings file contains list of available locales and the active locale name. It also contains reference to a default library asset if exists. The default library is used for any smart string for which a library is not assigned.

ℹ️ Once created SKLoc settings file will be included to preloaded assets automatically for localization to work properly.

2.Library asset:

Library asset contains dictionaries for particular locales. However only one dictionary may be active at a time. Switching active locale at the settings asset will change the active dictionary in all libraries if those libraries contain a dictionary for the newly activated locale.

ℹ️ An active locale may be set only during Runtime. It can be set at Localization Setting window or In-Game locale dropdown menu.

Quick Method:

All localization can be performed without writing a single line of code. This method works if all text visualization is done through TextMeshPro or TextMeshProUGUI. All game objects that has one of these components are required SKLocCompanion to be attached as well. This can be done automatically using Tools>>Localization menu or using the SKLoc Wizard.

To localize using the Quick method, simply run SKLoc Wizard at Tools>>Localization menu and follow the instructions.

How SKLocCompanion-based Localization works is summarized below.

During Runtime, if the text field of TextMeshPro or TextMeshProUGUI is written, it is intercepted and translated using a preassigned library to current locale. The original text is stored in the SKLocCompanion component as the Key and the translation is written to text field of the TextMeshPro or TextMeshProUGUI.

Upon activation of another locale, the previously stored key is retranslated and written to the text field of the attached TextMeshPro or TextMeshProUGUI.

⚠️If the key doesn’t have a translation, then the key itself is used for the text.

In most cases the developer does not need to enter the keys manually. Scraping is the process of the SKLocGenie collecting all keys automatically during the gameplay. To activate, the SKLocCompanion components and their associated library must have scraping enabled. These can be enabled through the Localization Settings window or Wizard, that can be found at Tools>>Localization menu. During gameplay the keys are collected from the text property of TextMeshPro or TextMeshProUGUI as they were assigned. Scraping must be repeated for each scene.

Scraped keys are not directly added to the translation table. They developers must select which texts will be converted to keys at the aforementioned windows.

Once keys are defined, the empty translation table can be exported to an xlsx file per library and be shared with translators. Once translations are complete, the table maybe imported back to the library. The library will start working as soon as it is imported, even if it is at Runtime. ⚠️Translated excel file should not contain any formatting.

Expert Method:

Localization can also be performed by directly replacing strings in the code. This method does not need TextMeshPro components and can be used with any alternative. Once the settings and library files are set and locales are defined, any string that will be visualized or logged maybe replaced with smartStrings using one of the methods below. This will also work for composite formatting or string interpolation.