Languages Support in MAGES™ SDK

Warning

Note that this feature is still under development.

MAGES™ SDK provides multilingual capabilities. Any application that is created with MAGES™ SDK can support different languages. It is up to the developers to provide the languages of their choice, as well as the possible translations for the text(s) they desire in each language.

MAGES™ SDK Languages Setup

In order to be able to utilize MAGES™ SDK languages support, a MAGES Languages asset file must be created. To create a MAGES Languages asset file, navigate to the MAGES menu and click Generate MAGES Languages File as shown in the following image.

../../../_images/LanguagesGeneration.PNG

Warning

Please make sure that the MAGESLanguages asset file is also correctly setup in the MAGESSetup component (usually located in the SCENE_MANAGEMENT GameObject).

../../../_images/MAGESSetup.PNG

Choose the asset file location and save it. Once it is created, you will be presented with the following settings:

../../../_images/LanguagesSettings.PNG

Option

Description

Languages Management

Expand this to present options regarding the addition/removal of a language.

Keys Management

Expand this to present options regarding the addition/removal of a key.

Add Message

Expand this to present options regarding the addition/removal of a message.

View Messages

Expand this to view added messages.

View Messages Import settings

Expand this to present options regarding the import of already existing messages from a .json file (older version of MAGES)

Adding/Removing a Language

To add a new language to the application, expand the Languages Management section.

../../../_images/AddLanguage.PNG

Type in the text field the name of the new language.

Warning

Note that only the first three letters of your input will be kept, so if you type, for instance, ENGLISH, then ENG will be saved.

Finally, click the Submit button.

Following the same procedure, to remove a language expand the Languages Management section.

../../../_images/RemoveLanguage.PNG

Click the Remove Language button.

Select the language you wish to remove from the dropdown list and click the Submit button.

Adding/Removing a Key

To add a new key to the application, expand the Keys Management section.

../../../_images/AddKey.PNG

Click the Add Key button.

Type in the text field the name of the new key.

Finally, click the Submit button.

Following the same procedure, to remove a key expand the Keys Management section.

../../../_images/RemoveKey.PNG

Click the Remove Key button.

Select the key you wish to remove from the dropdown list and click the Submit button.

Adding a Message

To add a new message, expand the Add Message section.

../../../_images/AddMessage.PNG

You will be presented with two dropdown lists and a text field.

Select the language for this message (first dropdown list) and the key that this message corresponds to (second dropdown list).

Type the desired message in the text field.

Click the Submit button.

Viewing a Message

To view all the registered messages for a specific key, expand the View Messages section.

../../../_images/ViewMessage.PNG

Select a key from the dropdown list, to view its registered messages for each language.

Messages Import

Note

This option is mainly for importing saved messages/lanuages/keys created with an earlier version of MAGES, that was utilizing .json files to keep this data.

To import messages/languages/keys from an earlier version of MAGES, you will need its corresponding .json file (its default name is LanguageTranslationMsg).

Expand the View Messages Import Settings section.

../../../_images/ImportFile.PNG

Set the .json file reference to the corresponding field.

Click the Import File button.

Warning

This action will overwrite all your previous messages/languages/keys.