Orx Learning

User Tools

Site Tools

Trace:
en:tutorials:localization:localization

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
en:tutorials:localization [2018/12/24 02:42 (5 years ago)] – created sausageen:tutorials:localization:localization [2020/08/31 05:37 (4 years ago)] (current) – ↷ Links adapted because of a move operation sausage
Line 1: Line 1:
-<WRAP center round info 60%> 
-In Progress 
-</WRAP> 
- 
 ====== Localization and Multiple Languages ====== ====== Localization and Multiple Languages ======
  
Line 15: Line 11:
 This tutorial will be done in two steps: This tutorial will be done in two steps:
  
-1. Create a simple game with  characters with their own look, speech and music. +  - Create a simple game with  characters with their own look, speech and music. 
-2. Add in a second locale, and be able to switch between them.+  - Add in a second locale, and be able to switch between them.
  
 ===== Starting a new project ===== ===== Starting a new project =====
  
-Begin with a blank project created using the [[en:tutorials:creating_your_own_project|init tool]].+Begin with a blank project created using the [[en:tutorials:projects:creating_your_own_project|init tool]].
  
-Name your project something like the-conversation (or whatever you wish). +Name your project something like ''the-conversation'' (or whatever you wish). 
  
 Our game will be about two polite gentlemen having a conversation. They continually greet each other all day. Our game will be about two polite gentlemen having a conversation. They continually greet each other all day.
 +
 +{{ tutorials:localization:french-screenshot.png |}}
  
 Eventually, we want to be able to switch their nationality, as the player may prefer to play the game in their own country and language. Eventually, we want to be able to switch their nationality, as the player may prefer to play the game in their own country and language.
  
-===== Assets =====+===== French Assets =====
  
 Let's begin with the French assets, building the French version first. Let's begin with the French assets, building the French version first.
  
 +Frenchman sprite for the data/texture folder:
  
-Object+{{ tutorials:localization:typical-frenchman.png |}}
  
-Speech+Speech samples for the data/sound folder:
  
-Music+{{ tutorials:localization:bonjour1.ogg |}} 
 +{{ tutorials:localization:bonjour2.ogg |}}
  
 +Music for the same folder:
  
-Delete the default config object and FX sections. We wont need those.+{{ tutorials:localization:je-te-veux.ogg |}} 
 + 
 + 
 +Delete the default config ''Object'' and ''FX'' sections. We wont need those. 
 + 
 +Set up a smaller resolution for this demo by changing the Camera Frustum: 
 + 
 +<code ini> 
 +[MainCamera] 
 +FrustumWidth    = 800 
 +FrustumHeight   = 600 
 +</code> 
 + 
 +Also turn off the smoothing effect to suit our pixel graphic style: 
 + 
 +<code ini> 
 +[Display] 
 +Smoothing = false 
 +</code>
  
 Create the default ''Person'' object in the config with: Create the default ''Person'' object in the config with:
  
-[]+<code ini> 
 +[Person1] 
 +Graphic         = @ 
 +Texture         = typical-frenchman.png 
 +Pivot           = center 
 +Scale           = 5.0 
 +Position        = (-100, 0, 0) 
 +KeepInCache     = true 
 +</code> 
 + 
 +The above config uses section inheritance. You can [[en:orx:config:syntax#inheritance|read more about it here]].
  
 Create a second person from the first, but one that stands on the other side and faces the other way: Create a second person from the first, but one that stands on the other side and faces the other way:
  
-[]+<code ini> 
 +[Person2@Person1] 
 +Position        = (100, 0, 0) 
 +Scale = (-5, 5, 1) 
 +</code>
  
 Next, create a ''Scene'' object that will be the root to hold all the other objects. Then place both Person objects in it's Childlist. Next, create a ''Scene'' object that will be the root to hold all the other objects. Then place both Person objects in it's Childlist.
  
-[]+<code ini> 
 +[Scene] 
 +ChildList = Person1 # Person2 
 +</code>
  
 Create the scene in the game in code. This will create all the child objects onscreen. You can just change the existing ''Object'' creation with ''Scene'', from: Create the scene in the game in code. This will create all the child objects onscreen. You can just change the existing ''Object'' creation with ''Scene'', from:
  
-[]+<code c> 
 +orxObject_CreateFromConfig("Object"); 
 +</code>
  
 to: to:
  
-[] +<code c> 
 +orxObject_CreateFromConfig("Scene"); 
 +</code>
  
  
 Create all the text objects to go onscreen. You will need text objects for: Create all the text objects to go onscreen. You will need text objects for:
  
- - The speech +  - The speech 
- - The player instructions +  - The player instructions 
- - The current language indicator+  - The current language indicator
  
 Create these as: Create these as:
  
-[]+<code ini> 
 +[ToggleNationalityObject] 
 +Graphic  = ToggleNationalityGraphic 
 +Scale    = 2 
 +Position = (0, 120) 
 + 
 +[ToggleNationalityGraphic] 
 +Text  = ToggleNationalityText 
 +Pivot = center 
 + 
 +[ToggleNationalityText] 
 +String = "PRESS SPACE TO CHANGE NATIONALITY" 
 + 
 +[CurrentNationalityObject] 
 +Graphic  = CurrentNationalityGraphic 
 +Scale    = 2 
 +Position = (0, 160) 
 +Color    = (0, 128, 255) 
 + 
 +[CurrentNationalityGraphic] 
 +Text  = CurrentNationalityText 
 +Pivot = center 
 + 
 +[CurrentNationalityText] 
 +String = FRENCH 
 + 
 +[SpeechObject] 
 +Graphic  = SpeechGraphic 
 +Scale    = 2 
 +Position = (-70, -100) 
 +Color    = (0, 128, 255) 
 + 
 +[SpeechGraphic] 
 +Text  = SpeechText 
 +Pivot = center 
 + 
 +[SpeechText] 
 +String = Bonjour 
 +</code>
  
 And now place them into the scene by adding them to the Childlist: And now place them into the scene by adding them to the Childlist:
 +
 +<code ini>
 +[Scene]
 +ChildList = Person1 # Person2 # ToggleNationalityObject # CurrentNationalityObject # SpeechObject
 +</code>
  
 Next is the music. Define it with: Next is the music. Define it with:
  
-[]+<code ini> 
 +[BackgroundThemeMusic] 
 +Music       = je-te-veux.ogg 
 +Volume      = 0.5 
 +Loop        = true 
 +KeepInCache = true 
 +</code>
  
 And add it to the scene with: And add it to the scene with:
  
-[]+<code ini> 
 +[Scene] 
 +ChildList = Person1 # Person2 # ToggleNationalityObject # CurrentNationalityObject # SpeechObject 
 +SoundList = BackgroundThemeMusic 
 +</code>
  
 Next is the actual conversation. Define the speech with: Next is the actual conversation. Define the speech with:
  
-[]+<code ini> 
 +[Hello1] 
 +Sound       = bonjour1.ogg 
 +KeepInCache = true
  
-Them using a timeline track switch on and off the alpha of the speech text object to make it appear/disappear, move its position and play the sounds.+[Hello2] 
 +Sound       = bonjour2.ogg 
 +KeepInCache = true 
 +</code>
  
-Compile and run. Our two French gentlemen will start having a lovely conversation.+Then, using a timeline track switch on and off the alpha of the speech text object to make it appear/disappear, move its position and play the sounds:
  
 +<code ini>
 +[ConversationTimeLine]
 +0 = Object.SetPosition ^ (-70,-100) # Object.SetAlpha ^ 1.0 # Object.AddSound ^ Hello1
 +1 = Object.SetPosition ^ (70,-100) # Object.AddSound ^ Hello2
 +2 = Object.SetAlpha ^ 0.0
 +4 = 
 +Loop        = true
 +KeepInCache = true
 +</code>
  
-That is the basic game. +Add the Timeline to the ''SpeechObject'' so that the speech with be animated:
  
 +<code ini>
 +[SpeechObject]
 +Graphic   = SpeechGraphic
 +Scale     = 2
 +Position  = (-70, -100)
 +Color     = (0, 128, 255)
 +TrackList = ConversationTimeLine
 +</code>
 +
 +Compile and run. Our two French gentlemen will start having a lovely conversation.
 +
 +That is the basic game. 
  
 Now to make the game switchable to Australia mode. This is the easy part. Now to make the game switchable to Australia mode. This is the easy part.
 +
 +
 +===== Australian Assets =====
 +
 +We'll get the Australian version of the assets in now. These will replace the French ones.
 +
 +Australian sprite:
 +
 +{{ tutorials:localization:typical-aussie.png |}}
 +
 +Speech samples:
 +
 +{{ tutorials:localization:gidday1.ogg |}}
 +{{ tutorials:localization:gidday2.ogg |}}
 +
 +Music:
 +
 +{{ tutorials:localization:binda_polka.ogg |}}
  
 Begin by defining the two languages for the game: French and Australian. Begin by defining the two languages for the game: French and Australian.
  
-[]+<code ini> 
 +[Locale] 
 +LanguageList = French # Australian 
 +</code>
  
 Next, define those languages as sections containing your keys for the various assets or text: Next, define those languages as sections containing your keys for the various assets or text:
  
-[]+<code ini> 
 +[French] 
 +Hello           = Bonjour 
 +Image           = typical-frenchman.png 
 +HelloSound1     = bonjour1.ogg 
 +HelloSound2     = bonjour2.ogg 
 +BackgroundMusic = je-te-veux.ogg 
 +LanguageText    = FRENCH 
 + 
 +[Australian] 
 +Hello           = Gidday 
 +Image           = typical-aussie.png 
 +HelloSound1     = gidday1.ogg 
 +HelloSound2     = gidday2.ogg 
 +BackgroundMusic = binda_polka.ogg 
 +LanguageText    = AUSTRALIAN 
 +</code> 
 + 
 +Finally, go to each config and replace the absolute asset paths and text with the named keys from language sections. These keys are called using the special $ symbol:  
 + 
 +<code ini> 
 + 
 +[Hello1] 
 +Sound = $HelloSound1 
 +KeepInCache = true 
 + 
 +[Hello2] 
 +Sound       = $HelloSound2 
 +KeepInCache = true 
 + 
 +[BackgroundThemeMusic] 
 +Music       = $BackgroundMusic 
 +Volume      = 0.5 
 +Loop        = true 
 +KeepInCache = true 
 + 
 +[Person1] 
 +Graphic     = @ 
 +Texture     = $Image 
 +Pivot       = center 
 +Scale       = 5.0 
 +Position    = (-100, 0, 0) 
 +KeepInCache = true 
 + 
 +[CurrentNationalityText] 
 +String = $LanguageText 
 + 
 +[SpeechText] 
 +String = $Hello 
 + 
 +</code> 
 + 
 +Excellent, the localization is now added to all our parts of the config. But there is no way to switch locales. The final step is the define the ''Space Bar'' as the key to switch between languages. First the key in the config: 
 + 
 +<code ini> 
 +[MainInput] 
 +KEY_ESCAPE      = Quit 
 +KEY_SPACE = SwitchLanguage 
 +</code> 
 + 
 +Define a variable at the top of the code to keep track of the current language: 
 + 
 +<code c> 
 +int currentLanguageIndex = 0; 
 +</code>
  
-Finally go to each config and replace the absolute asset paths and text with the named keys from language sections. These keys are called using the special $ symbol: +Then in code, in the ''Run()'' function, switch the locale:
  
-[]+<code c> 
 +if (orxInput_HasBeenActivated("SwitchLanguage")) 
 +{ 
 +    currentLanguageIndex++; 
 +    if (currentLanguageIndex > 1){ 
 +        currentLanguageIndex = 0; 
 +    } 
 +     
 +    orxLocale_SelectLanguage(orxLocale_GetLanguage(currentLanguageIndex)); 
 +} 
 +</code>
  
 Compile and run. Now you can switch between the two languages with the Space Bar. Everything in the game switches over in an instant. Pretty impressive stuff.  Compile and run. Now you can switch between the two languages with the Space Bar. Everything in the game switches over in an instant. Pretty impressive stuff. 
  
 +{{ tutorials:localization:aussie-screenshot.png |}}
  
-Acknowledgements, permissions and thanks +Acknowledgements, permissions and thanks: 
-Accordion performance of Je Te Veux by Norimichi Nagasaka. Youtube channel is at: https://www.youtube.com/user/VAccordion +  * Thank you to Norimichi Nagasaka for allowing me to use his accordion performance of Je Te Veux. His Youtube channel is at: https://www.youtube.com/user/VAccordion 
-Graphics by Trevor Brennan: http://trevorbrennan.com +  * Thanks to Trevor Brennan: http://trevorbrennan.com for the graphics. 
-Thanks to FullyBugged, Dom M ad Matt R for the voices.+  * Thanks to FullyBugged, Dom M and Matt R for the voices.
  
en/tutorials/localization/localization.1545648159.txt.gz · Last modified: 2018/12/24 06:42 (5 years ago) (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC0 1.0 Universal
CC0 1.0 Universal Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki