This is an old revision of the document!
One of the unique features available within Orx is the ability to switch languages in game using locale features. While many game engines allow a user to program using locale to some degree, Orx lets you switch languages back and forth in real-time.
An example of this could be a graphical adventure game that features characters, onscreen text, digital speech, and music. Locale switching would allow you to completely switch out all graphics, text, speech and music with a single function call without altering the game-play.
All data is defined by you, and so your regions or nations could be aliens/humans, orcs/elves. You could even think of it as a kind of themeing.
Its a pretty amazing feature that comes out of the box.
This tutorial will be done in two steps:
Begin with a blank project created using the init tool.
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.
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.
Let's begin with the French assets, building the French version first.
Delete the default config object and FX sections. We wont need those.
Create the default
Person object in the config with:
[Person1] Graphic = @ Texture = $Image Pivot = center Scale = 5.0 Position = (-100, 0, 0) KeepInCache = true
The above config uses section inheritance. You can 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:
[[email protected]] Position = (100, 0, 0) Scale = (-5, 5, 1)
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.
[Scene] ChildList = Person1 # Person2
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
Create all the text objects to go onscreen. You will need text objects for:
Create these as:
[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
And now place them into the scene by adding them to the Childlist:
[Scene] ChildList = Person1 # Person2 # ToggleNationalityObject # CurrentNationalityObject # SpeechObject
Next is the music. Define it with:
[BackgroundThemeMusic] Music = je-te-veux.ogg Volume = 0.5 Loop = true KeepInCache = true
And add it to the scene with:
[Scene] ChildList = Person1 # Person2 # ToggleNationalityObject # CurrentNationalityObject # SpeechObject SoundList = BackgroundThemeMusic
Next is the actual conversation. Define the speech with:
[Hello1] Sound = bonjour1.ogg KeepInCache = true [Hello2] Sound = bonjour2.ogg KeepInCache = true
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:
[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
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.
We'll get the Australian version of the assets in now. These will replace the French ones.
Begin by defining the two languages for the game: French and Australian.
[Locale] LanguageList = French # Australian
Next, define those languages as sections containing your keys for the various assets or text:
[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
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:
[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
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.
Acknowledgements, permissions and thanks