Localization - Revision history

151.229.136.200 at 23:01, 21 March 2017

2017-03-21T23:01:02Z

151.229.136.200 at 23:00, 21 March 2017

2017-03-21T23:00:34Z

188.222.158.94: /* Auto-Translate */

2017-03-13T00:35:17Z

‎Auto-Translate

188.222.158.94: /* Modular Grouping */

2017-03-13T00:31:09Z

‎Modular Grouping

188.222.158.94: Created page with "Games are now extremely easy to distribute around the world. This means people of all languages can potentially see, and read, your game. To help with this, PowerUI makes loca..."

2017-03-13T00:23:32Z

Created page with "Games are now extremely easy to distribute around the world. This means people of all languages can potentially see, and read, your game. To help with this, PowerUI makes loca..."

New page

Games are now extremely easy to distribute around the world. This means people of all languages can potentially see, and read, your game. To help with this, PowerUI makes localization easy - that's the process of translating your project and making it multi-lingual.

''As a getting started example, check out the localization example scene.''

== Your Supported Languages ==

You'll need to declare the languages that your HTML supports. That's done with the languages meta tag:

<syntaxhighlight lang="html">


<meta name='languages' content='en,fr,de'/>

</syntaxhighlight>

Note that it's also inherited by all child iframes on the document too so you won't need to repeatedly define this. Here's the attributes that can be used on this meta tag:

{| class="wikitable"
|-
! Attribute
! What it's for
! Example
! Default value
|-
| content
| The lowercase ISO 639-1 language codes.
| en,de,it
| ''none''
|-
| src
| A path to a folder containing the [[#Language_Files|language files]].
| /CustomLocation/
| resources://Languages/
|}

== Language Files ==

[[File:Localisation-Files.png]]

Language files contain the actual text. They're xml files which go inside any '''Resources/Languages''' folder by default ''(change this with the above src attribute)''. You can have as many of those folders as you want. There's one file per language that you support. So for example:

* Languages/en.xml
* Languages/fr.xml
* Languages/de.xml

To match the meta tag above. Each file contains a list of ''variables''.

== Variables in language files ==

An example en.xml language file might look like this:

<syntaxhighlight lang="html">

<var name='Title'>
Welcome to the localization system!
</var>

<var name='Intro'>
Localization is an easy way to make your game <i>inclusive</i>.
</var>

</syntaxhighlight>

Note that they fully support HTML (including displaying other variables - typically something dynamic like a username).

== Displaying a variable ==

[[File:Localisation-VariableDisplay.png]]

To display a variable on your UI, you simply use &TheName; like this:

<syntaxhighlight lang="html">
<h1>&Title;</h1>
&Intro;
</syntaxhighlight>

== Dynamic variables ==

[[File:Localisation-Custom.png]]

If you have some value which is often displayed throughout the UI, like a username, setting a variable at runtime can be a great way to avoid needing to go updating all corners of your UI - every use of the variable will be updated automatically when the variable changes. Plus, you could use &Username; inside other variable values and word order just works.

<syntaxhighlight lang="csharp">

// Simply apply it to UI.Variables:
UI.Variables["Username"]="Jerry";

// &Username; will now appear as 'Jerry'.

</syntaxhighlight>

== Changing the language ==

[[File:Localisation-LanguageChange.png]]

To change the language via scripting, simply set UI.Language (a static property):

<syntaxhighlight lang="csharp">

// Change to french:
UI.Language="fr";

</syntaxhighlight>

== Gender specific ==

[[File:Localisation-Gender.png]]

Dialogue very often includes the gender of the user. Add gender attributes to your variables and then change UI.Gender:

<syntaxhighlight lang="html">

<var name='ItsASecret' gender='boy'>
Nobody tell &Username; - he won't be happy!
</var>

<var name='ItsASecret' gender='girl'>
Nobody tell &Username; - she won't be happy!
</var>

</syntaxhighlight>

<syntaxhighlight lang="csharp">

// Change to female:
UI.Gender=Gender.Girl;

</syntaxhighlight>

== Modular Grouping ==

[[File:Localisation-Grouping.png]]

Having all of your text in just one file would get difficult to manage for larger projects very quickly. So, you can group variables together (typically by UI, but that's up to you).

Groups simply go into sub-folders:

* Languages/Bank/en.xml

<syntaxhighlight lang="html">

<var name='Title'>
Welcome to your bank &Username;!
</var>

</syntaxhighlight>

You then just use a dot when you're displaying it:

<syntaxhighlight lang="html">

<h1>&Bank.Title;</h1>

</syntaxhighlight>

== Passing Parameters ==

[[File:Localisation-Parameters.png]]

Lets say you wanted the text "14 players online." You could do "14 &PlayersOnline;" which will work ok for most, but some languages like Hindi have a word order that is more like "Online, there are 14 players". ''The 14 is in a different spot.'' It might be even worse too - this could be a list of game rooms, for example. Bring on parameters!

<syntaxhighlight lang="html">



<div>&PlayersOnline(14);</div>
<div>&PlayersOnline(9);</div>
<div>&PlayersOnline(110);</div>

</syntaxhighlight>

To display the parameter you then use the special & arg group:

<syntaxhighlight lang="html">

<var name='PlayersOnline'>
There's &arg.0; players online.
</var>

</syntaxhighlight>

More than one parameter is supported too. Just use &arg.1; etc and separate with commas as shown in the image above.

== Auto-Translate ==

PowerUI uses a collection of standardised textual formats making it easy to automatically translate. However, PowerUI helps even more by providing a free '''auto translate API'''.

← Older revision		Revision as of 23:01, 21 March 2017
Line 1:		Line 1:
−	Your projects are now extremely easy to distribute around the world. This means people of all languages can potentially see, and read~~, your game~~. To help with this, PowerUI makes localization easy - that's the process of translating your project and making it multi-lingual.	+	Your projects are now extremely easy to distribute around the world. This means people of all languages can potentially see and read it. To help with this, PowerUI makes localization easy - that's the process of translating your project and making it multi-lingual.

	''As a getting started example, check out the localization example scene.''		''As a getting started example, check out the localization example scene.''

← Older revision		Revision as of 23:00, 21 March 2017
Line 1:		Line 1:
−	~~Games~~ are now extremely easy to distribute around the world. This means people of all languages can potentially see, and read, your game. To help with this, PowerUI makes localization easy - that's the process of translating your project and making it multi-lingual.	+	Your projects are now extremely easy to distribute around the world. This means people of all languages can potentially see, and read, your game. To help with this, PowerUI makes localization easy - that's the process of translating your project and making it multi-lingual.

	''As a getting started example, check out the localization example scene.''		''As a getting started example, check out the localization example scene.''

← Older revision		Revision as of 00:35, 13 March 2017
Line 183:		Line 183:
	== Auto-Translate ==		== Auto-Translate ==

−	PowerUI uses a collection of standardised textual formats making it easy to automatically translate. ~~However, PowerUI helps even more by providing~~ a free ~~'''~~auto translate API~~'''~~.	+	PowerUI uses a collection of standardised textual formats making it easy to automatically translate. We provide a free [[Translation\|auto translate API]] (powered by Google Translate).

← Older revision		Revision as of 00:31, 13 March 2017
Line 129:		Line 129:

	== Modular Grouping ==		== Modular Grouping ==
−
−	~~[[File:Localisation-Grouping.png]]~~

	Having all of your text in just one file would get difficult to manage for larger projects very quickly. So, you can group variables together (typically by UI, but that's up to you).		Having all of your text in just one file would get difficult to manage for larger projects very quickly. So, you can group variables together (typically by UI, but that's up to you).