This page has been translated automatically.
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Unigine Material Library
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.


The current article describes how to localize the GUI of your project.


Fonts files are used to correctly display characters of local languages in the Unigine-based project. The font file has a True Type font format and contains all of the local language characters.

To avoid incorrect display of language characters, you should add all of the required font files to your project folder and use the engine.gui.setFont() function when it is necessary to change the font. For example, to translate into Chinese, you should load your English-Chinese dictionary and set the corresponding font as follows:

Source code (UnigineScript)

If the project supports your local language only, you can simply replace 2 font files font.ttf (for GUI widgets) and console.ttf (for console) in the data/core/gui directory with the font files containing the local language characters. The names of Unigine files should be preserved.

Character Encoding

All of the project files should be saved in UTF-8 encoding.

The encoding must be UTF-8 without BOM (Byte Order Mark).

Translation Dictionaries

To support several languages in your project, you need to use dictionaries, which are stored in the XML format. They are used to translate the GUI from one language into another.

File Format

Source code (XML)
<?xml version="1.0" encoding="utf-8"?>
<dictionary version="1.00">
		<src>Source string</src>
		<tr>Translated string</tr>
The root tag dictionary contains the msg child tag, which is used to define a word or phrase to be translated and has the following children:
  • src - a source string to be translated.
    The punctuation marks should be included to the string; otherwise the string won't be translated.
  • tr - a translation.

Managing Locale

To add the dictionary, use the engine.gui.addDictionary() function. To save the last loaded dictionary, use the engine.gui.saveDictionary() function. This function also allows you to save the currently loaded dictionary into another file. If you want to modify the dictionary, you can edit the XML file manually or by using the Xml class functions and then load it.

Dictionaries cannot be changed in run-time.
Source code (UnigineScript)
engine.gui.addDictionary("my_project/locale/"); // load English-Chinese dictionary
The updateWidgets() function is called to change the language after the required dictionary is added.

Input Methods

Unigine supports IMEs (Input Method Editors) that allow entering Chinese, Japanese and Korean characters by using the Latin keyboard.

Unigine doesn't support right-to-left and top-to-bottom languages.

To enter Chinese, Japanese or Korean characters, simply change your keyboard layout and start typing.

Last update: 2017-07-03
Build: ()