State of Thai in Godot Engine

And today here we come at Godot Engine. Godot Engine is an open source game engine which gains more and more popularity among game developers. Part of the reason is it’s an open source, another part would be it is good enough for many indie games.

When it comes to Thai in Godot Engine, one of the pioneers is LeftWay from Tongson. Tongson is actually a friend of mine whom I chat with almost everyday. He is quite onto Open Source and discovered Godot very early on. He is even one of the first developer who publish games made with Godot in Steam. And that’s a shoutout to him, mavhod.

Enough with the introduction.

In-Game.

Godot Engine supports two kinds of font, the bitmap fonts, and dynamic fonts. Dynamic fonts is in fact TrueType fonts, backed by FreeType library.

First of all, bitmap fonts does not work with Thai, period. Just skip it.

Regarding Dynamic Fonts. Since FreeType has advanced layout feature removed when it was transitioned to the version 2, you can assume that necessary feature for Thai text is also removed as well. I have no experiences with FreeType 1, but FreeType 2 does not supports those features. That also the reason why Dynamic Fonts does not support these features as well.

So yes, its support for Thai text is pretty much on par with Unity 3D. No mkmk nor mark supports. For the time being, you’ll be stuck with older fonts, designed a decade ago. I won’t go into details for now, but it’s pretty similar to Unity 3D version I made. Please check it out.

And here it plays out in-game:

As you might have guess, if you read the link I’ve mentioned before, the above text is Loma from TLWG, and below is Sarabun from Cadsondemak. Loma is older font, which was designed at the time there were no OpenType, so the designer took extra care to make sure it is read-able when the combination of character can lead into problem. These design decision is not present with Sarabun, which was designed much later. Comparing the output of these two fonts, you might notice the missing ticks on Sarabun, and also the tail of one character is overlapping the tail of the above vowel character. That’s the trait of newer fonts.

Similar to Unity3D, you can also do glyph substitution technique to solve the floating tonemark and the floating vowel problem. The feature image I took from LeftWay shows the in-house implementation made by the developer. Please scroll up a little bit :).

However, after I do some more investigation, I come up with the conclusion that it will be come a waste of time in the near feature.

Someone in the Godot Engine community has already proposed to do OpenType shaping based on Harfbuzz library. In fact, a pull request is already been reviewed and should be merged to the main trunk very very soon. The PR originated by a needs to do LTR text layout which is required by Arabian language, but we are also benefitted from the PR as well (they even have screenshots contains Thai text as well). I’d like to express my gratitude to the user bruvzg on github. Thank you.

Here’s the test screenshot, taken directly from that PR. Credit to bruvzg as well.

I’m expecting this to be merged into the next major release of their, but well don’t hold your breath.

Editor

The game engine’s editor runs on top of the game engine, like Unreal Engine 4. So since the engine could not display Thai perfectly (yet), then the editor also suffer from the same problem.

Anyway, Godot ships with Thai font, NotoSansThaiUI, so at least it can display Thai (unlike UE4). And since they ship with older version of NotoSansThaiUI, the font has older design that based on the constraints we had in the past. Thus, Godot Engine can display Thai text pretty well.

So, out of the box, Godot has one of the best Thai support.

Appendix

Here’s the font I uses in above example.

Feature Image taken from LeftWay by Tongsun. I’m not associated nor affiliated with the company nor the title in anyway.

State of Thai in Unity

Unity3D is one of the most popular games engine used in Thailand. In fact, it’s not far fetch from being the most popular one. We do enjoy using Unity3D as it’s quite intuitive (although I’d say it’s not that easy for beginners).

However, Thai remains one of the obstacle in making good games for Thai people. I mean, the language. Displaying Thai in Game Engine is one of the problem we are facing so far. The TLDR; version is, Unity3D is not able to display perfect Thai strings in game (on both UnityUI and TextMeshPro), due to the fact of missing essential text layout feature required for displaying Thai.

Why it is so difficult. Well, Thai writing is 4-level of characters.

  1. The base character. Base character stay on the baseline. Keep in mind that some character has part of it extends down below the baseline — ญ ฎ ฐ. Some other character has parts of it extends above the height of most character in the set – ป ฟ.
  2. The above base character level. In this level, it can be either above character vowel -ี -ิ, or tone mark -้ -่.
  3. The topmost level, which is tone mark on top of the above character vowel. In this case they can be -ี่ -ี้
  4. The under-baseline vowel like -ู.

Some combination like ปี่ or ญู can looks messed up when the renderer does not support feature like mark-to-mark and mark-to-base placement. Unfortunately our beloved Unity3D does not support this.

I won’t go for details for now, may be later.

Also there are some issue with Editor itself as well. I’ll explain that one later. Let’s move on to the game engine first.

In-Game

As I mentioned before, Unity3D only support a basic text shaping which is not adequate for display Thai properly. Here’s the proof.

I’m pretty sure at this point, some of you who’s not very familiar with the language might ask ‘what’s the problem here?’ Basically the tone mark in Unity just overlaps with the vowel under it. And in some case, the vowel also overlaps with the base character as well. The word ปี่ (flute) cannot be rendered in Unity3D correctly.

This is the same font and same string in other program that support advanced OpenType feature. Notice the extra tick on top of the second base character of the second and the third phrase. Also the above vowel on the third phrase are moved slightly to the left so it does not overlaps with the base character.

The font used in above example is Sarabun, from Cadsondemak.

So, back in the day when there’s no OpenType, we Thai people also has this kind of problem on most application we are using. Luckily, since the font foundries are aware of this problem, they designed the font so that it avoid or minimize the problem when the glyphs overlaps with each other.

Below is Loma from TLWG, rendered with Unity3D. Loma was created a decade back, by the team Thai Linux Working Group who brought Thai support to Linux (a big thanks to them).

Notice that the tone mark is visible even if there’s above-base character vowel there, because the tone mark’s default position is higher than the most present days fonts. The third phrase still have the vowel overlaps the base character, as the character has its long tail extended higher in the air. The default vowel position is slightly to the left to give the visual indication that this is -ี not -ิ, which is an different vowel (they are not exchangeable).

However, these technique might be good enough for displaying on screen, it’s not when it come to publishing works. Some of the software vendor has develop a technique to swap out glyph to a proper version when certain condition is met. Eg, when the input string is ป่ then swap the tone mark with the version that positioned lower than user. This technique is commonly referred as glyph substitution. It’s still in-use now a day, but as a compliment to mark-to-mark and mark-to-base positioning provided by OpenType.

Anyway, people at SaladLab has implement glyph substitution library called ThaiFontAdjuster to use with Unity 3D. There’s catch with using this library, you need to use specific fonts as the substitution map is hard-coded in the library. They do provide a special built of ‘NotoSans Thai’ that support the library. I think Loma above also support this library as well (I haven’t tried though.).

However, these are just workaround. Until Unity3D supports glyph positioning (mark and mkmk in particular), I’d say we still have to struggle with Thai text in the engine.

Editor.

The first problem you will encountered is, the input field does not display Thai text properly (again). I think it comes from the font that they are using in the UI. It’s probably due to the fact that I’m using Windows 10, as some UI fonts shipped with Windows 10 are different than one shipped with earlier versions of Windows.

Also if you copy the string from text field, and then paste it, you notice that the pasted content is different than what it was copied into.

Probably this worth a bug report ?

Appendix

Here’s the font I uses in above example.

Feature Image taken from Araya by MAD Virtual Reality Studio. I’m not associated nor affiliated with the company nor the title in anyway.

State of Thai in Unreal Engine 4

In this post, I’d like to talk a bit about displaying Thai text in Unreal Engine 4. I’ve been playing with this engine for months now. What I’ve seen so far is the engine does support Thai, but with a little bit of catch. I’ll talk about them a little bit later in this post.

Some might ask, what is so special about Thai? Well I’ve seen more and more awareness in getting games localized for Thai. AAA titles like Sekiro, Dying Light, or Jump Force ships with Thai localization. Many more are rumored to have one. Anyway Thai is also one of the difficult language to display due to its 4-level of glyph positions.

To give you some head ups, at a given horizontal position, there are 4 possible positions. These names are my madeups, which might different than other documents. Please keep this in mind.

  • Base character, which always stay on the base line. Part of the character might be under the base line.
  • Above base character, this can be either floating vowel character, or tone mark.
  • Above floating vowel character. In this position it can be only tone mark.
  • Below base character vowel.

For example ‘คนที่ไม่มีความกตัญญูกตเวที’

I won’t go further than these details. May be later I’ll write some article about that.

Because of these position, most game engine which only support TrueType layout (advance + bearing) won’t be able to render Thai string currently, let alone those only support fixed-width font.

Unreal Engine 4, in the other hands, support OpenType shaping. Things like mkmk, mark, etc. are directly supported, thanks to Harfbuzz, an open source OpenType shaping engine.

In-Game

As I mentioned before, support for Thai is pretty good out of the box. Just add a Thai font, create a TextBox with that font, and done, it’s ready.

But here’s the catch. Not all fonts are created equally.

The one on top is Sarabun, while the one on the bottom is NotoSans Thai. Notice that the above-vowel tone mark is not placed correctly. I don’t know why either. Since NotoSans Thai work fine on many software (including Android OS) my guess is UE4 has some problems with this font specifically.

Actually Sarabun is not perfect either, here’s why:

Sarabun has it’s ascender and descender too small to cover the lower vowel and above-vowel tonemark. If you have multi-line string, it’s possible that these characters will clash with each others, resulting in some nasty looking. This is something with the font. I’ve already contacted Cadsondemak on this matter, but they have yet to reply. May be I should visit Emquartier sometime, as their office is there :).

The one that looks better than those 2 above is Loma from TLWG.

The takeaway here is, you have to do some experiment to find which works and which does not.

Editor

Since the engine’s editor run on the engine itself, the editor is also capable to display Thai text as well as the game does. However, the game engine is not shipped with fonts that has Thai glyphs, every Thai character displays as ‘Tofu’s.

They are not ordinary Tofu, but still Tofu nonetheless. Anyway as I mentioned earlier, the editor itself runs on top of the engine, so if the engine can displays Thai, then what only missing is Thai fonts. Adding Thai fonts is not a difficult tasks to do, but it requires a little bit of coding. You have to then rebuild the engine from source. I hope that we could have Thai fonts shipped with the engine, but that’s up to the team at Epic to decide.

And here is the proof that it’s capable of doing that, after some modifications.

Anyway, in order to add font, firstly you have to get source code and build it. Please refer to this article for how to do that.

Secondly, after have all the code and build the engine, we needs some Thai fonts. I’m using Sarabun from Cadsondemak in this example, as the font looks amazing and render almost correctly most of the time by UE.

The path is /Engine/Editor/Slate/Fonts.

Finally, add some code to TSharedRef<const FCompositeFont> FLegacySlateFontInfoCache::GetDefaultFont() function to let the engine cache the fonts we’ve added.

// Thai (editor-only)
if (GIsEditor)
{
    FCompositeSubFont& SubFont = MutableDefaultFont->SubTypefaces[MutableDefaultFont->SubTypefaces.AddDefaulted()];
    APPEND_RANGE(SubFont, Thai);
    APPEND_EDITOR_FONT(SubFont.Typeface, "Regular", "Sarabun-Regular.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "Italic", "Sarabun-Italic.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "Bold", "Sarabun-Bold.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "BoldItalic", "Sarabun-BoldItalic.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "BoldCondensed", "Sarabun-Bold.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "BoldCondensedItalic", "Sarabun-BoldItalic.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "Black", "Sarabun-ExtraBold.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "BlackItalic", "Sarabun-ExtraBoldItalic.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "Light", "Sarabun-Light.ttf", EFontHinting::Default);
    APPEND_EDITOR_FONT(SubFont.Typeface, "VeryLight", "Sarabun-ExtraLight.ttf", EFontHinting::Default);
}

Feel free to change the font files to the one you’re using, if you’re not using Sarabun as I am.

Anyway I’ve came across some fonts that works fine in-game but not in editor, Loma is one of them. It just display ‘Tofu’ like this font does not exist. I don’t know why. If you happen to come across any font that works fine in both in-game and editor, please feel free to leave some comments.

Appendix

Here’s the font I uses in above example.

Feature Image taken from Home Sweet Home by YGGDRAZIL GROUP. I’m not associated nor affiliated with the company nor the title in anyway.