Automatic Tutorial Maker for Unity: in-game tips
  • AUTOMATIC TUTORIAL MAKER DOCS 🔰
  • ⚙️ Unity Asset Store Page
  • ▶️ Official YouTube playlist
  • 🤝 Discord support
  • DATA
    • Core Components
    • Supported Input
    • Supported Input (Joystick)
    • Supported Languages
    • Supported Visuals (UI)
    • Supported Visuals (World)
    • Visuals Prefabs
  • Usage Guide
    • Setup
    • Tutorial Creation
    • Step Customization
    • Advanced: Creating Visual Prefab
    • Advanced: Manual Step Calls
    • Advanced: Localization
    • Advanced: Adaptive Tutorial
    • Tutorials Gallery
  • Additional
  • HELP
    • Prompting & PDF
    • Contacts
Powered by GitBook
On this page
  1. Usage Guide

Advanced: Localization

Translate!

PreviousAdvanced: Manual Step CallsNextAdvanced: Adaptive Tutorial

Last updated 1 month ago

This describes the principle of working with tutorial translations in different languages. The system involves:

  • The InputStringsScriptableObject object (TSR > TipTextData)

  • A CSV table with translations (TSR > TipTextData > CSVFile)

  • The texts from here are embedded in the tutorial steps and can be edited from both locations

Adding translations

To translate, you need to have text hints available in at least one language. To add translations:

  1. Open TSR > TipTextData. This is where all text hints for all scenes and tutorials are stored.

  2. Press "Export current strings to CSV" button.

  3. Edit CSV. Copies of your current strings were created in the "Default" column. Pass them through a translator and insert the translations into the corresponding language columns.

  4. Done. Now, when switching between languages in runtime or edit mode, the strings change according to the translations. The string and its translations are searched by matching text, not tied to specific indices.

Switching language (4 ways)

Changing the language seamlessly updates all text hints both at runtime and in edit mode.

In inspector
Via script

Change the language via TSR > TipTextData by simply selecting a different value from the dropdown list.

Call TSR > TranslateAllTutorial() method. Use one of the existing languages from the dropdown list for it. sceneReferences.TranslateAllTutorial(InputStringsScriptableObject.Language.Italian);

Change the language via ATM by simply selecting a different value from the dropdown list.

Call TSR > TranslateAllTutorialByString() method. Specify any language declared in the first row of the CSV file, even one that is not listed in the dropdown menu. sceneReferences.TranslateAllTutorialByString("Polish");

Adding new language

As Enum for the list (found by column number)
Simplified (found by string)

  1. Open InputStringsScriptableObject.cs

  2. Find "public enum Language" > "AddCustomLanguage = 11" and replace it with your language, f.e. "Romanian = 11"

  3. Open CSV file and fill 11th column (L) with Romanian translations

  4. Done. To create new languages, use the indices of unused columns, f.e. "CustomLanguage = 16"

  1. Open CSV file and fill any empty column with translations

  2. Make sure line 0 in column is named after used language, f.e. "Romanian"

  3. Done. However, calling this language for translation is only possible via TranslateAllTutorialByString("Romanian") method. Link it to a flag button, for example.

Tutorial localization