【Unity】TextMeshProで日本語を表示する方法|□・文字化けの直し方

結論から書くと、TextMeshPro(TMP)で日本語が□になるのは、文字を描くための「フォントアセット」に日本語の字形が入っていないからです。日本語フォントから動的なフォントアセットを作り、テキストやTMP Settingsに設定すれば、ほとんどの場合はその場で直ります。この記事では、Unity 6でTextMeshProに日本語を表示する手順と、一部の漢字だけ□になる・ビルドすると消える・ファイルの文字化けといった「設定したのに直らない」時の見分け方をまとめました。

確認には、Unity 6000.3.14f1に入っているuGUI 2.0.0(Unity 6ではTextMeshProがこのパッケージに含まれています)のドキュメントとソースコードを使っています。

・TextMeshProのText Inputに日本語を入れたら、全部□(豆腐)になった
・Font Asset Creatorで作ったのに、一部の漢字だけ表示されない
・エディタでは出ていた文字が、ビルドしたゲームでは出ない
・CSVやテキストファイルから読んだ日本語が、□ではなく意味不明な文字になる

スポンサーリンク

TextMeshProで日本語が□になる理由

TextMeshProは、文字を画面に出すたびにフォントファイルを直接読んでいるわけではありません。あらかじめ字形を1枚のテクスチャ(アトラス)に並べた「フォントアセット」を使って描いています。

新しく作ったテキストに最初から付いているのは、LiberationSans SDFという英語用のフォントアセットです。ここには日本語の字形が1つも入っていません。そのため「あ」や「漢」を入れると、TMPは代わりの文字を探し、見つからなければ□で埋めます。

この□の正体はUnicodeの9633番(U+25A1)。ソースコードを読むと、文字が見つからない時はTMP Settingsの「Missing Character Unicode」の文字に置き換え、その値が0(初期値)なら□を使う作りになっていました。

同時にConsoleには、次のような警告が出ます。

The character with Unicode value \u3042 was not found in the [LiberationSans SDF] font asset or any potential fallbacks. It was replaced by Unicode character \u25A1 in text object [Text (TMP)].

\u3042は「あ」のコードです。角かっこの中に「どのフォントアセットで探したか」と「どのオブジェクトか」が出るので、□になった時はまずこの1行を読んでみてください。思っていたのと違うフォントアセットの名前が出ていれば、設定先を間違えています。

TextMeshProのボタンを作る手順の途中でも、この□に一度ぶつかります。ボタンそのものの作り方はこちらにまとめています。

日本語フォントを用意する(無料で使えるもの)

最初に必要なのは、日本語の字形を持ったフォントファイル(.ttfや.otf)です。

個人開発でよく使われるのは、Google Fontsで配布されているNoto Sans JPのように、SIL Open Font License(OFL)で公開されているフォント。OFLのフォントは、ゲームに組み込んで配布・販売することが認められています。ただし、フォント単体で売ることはできません。配布物にフォントファイルを入れる場合は、ダウンロードしたZIPに入っているライセンス文(OFL.txt)も一緒に入れておくと安心です。

WindowsやMacに最初から入っているフォント(MSゴシック、メイリオ、游ゴシックなど)は、ゲームに入れて配布してよいとは限りません。OSで使うための権利しか付いていないことが多いので、配るゲームには使わないのが無難です。

もう1つ、つまずきやすいのが可変フォント(ファイル名にVFやVariableが付いたもの)です。読み込み方によっては一番細い太さで扱われることがあり、Noto Sans JPの可変フォントも既定の太さは極細のThinになっています。ZIPの中にstaticフォルダがあれば、その中のNotoSansJP-Regular.ttfやNotoSansJP-Bold.ttfのように太さごとに分かれたファイルを使ってください。

フォントを自分で探す手間を省きたい、UIごと見た目を整えたい、という人はアセットストアのUI素材も候補になります。定番どころは人気アセットの記事でまとめています。

フォントファイルは、ProjectウィンドウのAssetsにドラッグすれば取り込めます。取り込んだフォントを選ぶと、インスペクターに「Include Font Data」という項目があります。TMPのフォントアセットを作るときにここがオフだと、「Unable to load font face」という警告が出て作れません。

Unity 6で日本語のフォントアセットを作る方法(動的が手軽)

フォントアセットの作り方は2通りあります。日本語なら、まずは手間の少ない「動的(Dynamic)」から始めるのがおすすめです。

手順1:動的フォントアセットを作る

ProjectウィンドウでさっきのNotoSansJP-Regular.ttfを右クリックし、Create > TextMeshPro > Font Asset > SDFを選びます(ショートカットはCtrl + Shift + F12)。フォント名に「SDF」が付いたアセットができれば成功です。

このメニューで作ったフォントアセットは、ソースコード上では次の初期値で作られていました。

項目 初期値 意味
Atlas Population Mode Dynamic 使った文字をその場でアトラスに足していく
Atlas Resolution 1024 × 1024 アトラス1枚の大きさ
Sampling Point Size 90 字形を描くときの大きさ
Padding 9 文字と文字の間の余白
Render Mode SDFAA 拡大してもぼやけにくい描き方

動的のフォントアセットは、最初はアトラスが空っぽです。テキストに「こんにちは」と入れた瞬間に、その5文字だけが元のフォントファイルから描かれて足されます。だから日本語のように文字数が多い言語でも、使う文字を前もって選ばずに済むんですね。

手順2:テキストに設定する

Text (TMP)を選んで、インスペクターのFont Assetに今作ったアセットをドラッグします。これで□が日本語に変われば完了です。

手順3:プロジェクト全体の既定にする

テキストを作るたびに設定し直すのは面倒なので、Edit > Project Settings > TextMesh Pro > Settingsを開き、2か所に入れておきます。

  • Default Font Asset:新しく作るテキストに最初から付くフォント
  • Fallback Font Assets:どのフォントアセットにも無い文字を探しに行く先

英語の見た目はLiberationSansのまま残したい、という場合はDefault Font Assetを変えずに、Fallback Font Assetsにだけ日本語フォントを入れる方法もあります。英字は元のフォント、日本語だけ日本語フォント、という出し分けになります。

一部の漢字だけ□になる時の直し方

ひらがなは出るのに、特定の漢字や記号だけ□になる。これは静的(Static)のフォントアセットでよく起きます。

ネットの古い手順では、Window > TextMeshPro > Font Asset Creatorを開き、Character Setに「Characters from File」を選んで、常用漢字などを並べたテキストファイルから焼き込む方法がよく紹介されています。この方法で作ったフォントアセットは、焼き込んだ文字しか持っていません。リストから漏れた漢字、全角の記号(「~」「♪」など)、後から台本に足したセリフの文字が□になります。

Font Asset CreatorでGenerate Font Atlasを押した後のレポート欄に「Characters missing from font file」と出る文字は、そもそも元のフォントファイルに字形がありません。この場合はリストを直しても出ないので、その文字を持つ別のフォントを足す必要があります。

直し方として一番手早いのは、静的と動的を組み合わせる方法です。

  1. よく使う文字(ひらがな・カタカナ・常用漢字)は今の静的フォントアセットのまま使う
  2. 同じフォントファイルから、手順1の方法で動的フォントアセットをもう1つ作る
  3. 静的フォントアセットのインスペクターを開き、Fallback Font Assetsに動的のほうを入れる

こうすると、焼き込んだ文字は静的から、漏れた文字だけ動的から描かれます。TMPの公式ドキュメントでも、文字数の多い言語では文字を複数のフォントアセットに分け、フォールバックでつなぐ使い方が紹介されていました。

TMPが文字を探す順番(公式ドキュメントのフォールバックの章より)

  1. テキストに設定したFont Asset
  2. そのFont AssetのFallback Font Assets(上から順に、さらにその先のフォールバックも)
  3. テキストのSprite Asset
  4. TMP SettingsのFallback Font Assets
  5. TMP SettingsのDefault Sprite Asset
  6. TMP SettingsのDefault Font Asset
  7. どこにも無ければMissing Character(□)

足りない文字を自分で確かめたい時は、次のスクリプトを付けて再生すると、Consoleに□になる文字とそのコードが並びます。HasCharactersの第3引数をtrueにすると、フォントアセットに設定したフォールバックの中も探してくれます。

using System.Text;
using TMPro;
using UnityEngine;

// 日本語の文字がフォントアセットに入っているかを調べるスクリプト
// テキスト(TMP)のオブジェクトに付けて、再生するとコンソールに結果が出ます
public class MissingCharChecker : MonoBehaviour
{
    [SerializeField] private TMP_Text targetText;

    void Start()
    {
        if (targetText == null)
        {
            targetText = GetComponent<TMP_Text>();
        }

        TMP_FontAsset font = targetText.font;
        string text = targetText.text;

        // 第3引数 true で、フォントアセットのフォールバックも探す
        bool hasAll = font.HasCharacters(text, out uint[] missing, true);

        if (hasAll)
        {
            Debug.Log($"[{font.name}] すべての文字が入っています");
            return;
        }

        StringBuilder sb = new StringBuilder();
        foreach (uint code in missing)
        {
            // 足りない文字と、そのコード(U+xxxx)を並べる
            sb.Append($"{char.ConvertFromUtf32((int)code)}(U+{code:X4}) ");
        }
        Debug.LogWarning($"[{font.name}] に無い文字: {sb}", targetText);
    }
}

このコードと次のPrewarmFontは、Unity 6000.0.49f1のUnityEngineとUnity.TextMeshProのDLLでビルドが通ることを確認しました(エディタ上での実行はしていません)。HasCharactersとTryAddCharactersは6000.3.14f1のソースにも同じ形で残っています。

ビルドすると日本語が消える・重い時の確認ポイント

エディタでは表示されていたのに、ビルドしたゲームでは□になる。あるいは表示は出るけれど、ファイルサイズが大きくなった。どちらも動的フォントアセットの性質から来ています。

元のフォントファイルを消していないか

動的フォントアセットは、ゲーム中に元のフォントファイルを読んで文字を足します。公式ドキュメントにも、動的フォントアセットは元のフォントファイルへのつながりを持ち続けるので、開発中に消してはいけない、と書かれています。静的なら作った後に消しても描けますが、動的では消すと新しい文字が足せなくなります。

Clear Dynamic Data On Buildの意味

フォントアセットのGeneration Settingsには「Clear Dynamic Data On Build」という項目があります。ソースコードを見ると、これがオンの動的フォントアセットは、ビルドの直前にアトラスに足された文字が空に戻されます。

これは不具合ではありません。エディタで試しに打った文字をゲームに持ち込まないための仕組みで、ゲーム中に必要な文字はその場で足されます。ただし、元のフォントファイルがビルドに入っていることが前提です。新しく作る動的フォントアセットでこの値をどうするかは、TMP Settingsの同じ名前の項目で決まります。

ビルドサイズが気になる時

公式ドキュメントによると、動的フォントアセットを使うと元のフォントファイルもビルドに含まれます。日本語フォントは1ファイルで数MBあることが多いので、スマホ向けやWebGLでサイズを抑えたい場合は、ゲーム中に出る文字を静的で焼き込み、動的は保険としてフォールバックに置くくらいがちょうどいいと思います。

逆に、プレイヤーが名前を入力する欄があるゲームでは、何の文字が来るか分かりません。入力欄に使うテキストは動的フォントアセットを必ずフォールバックにつないでおきましょう。入力欄の使い方はこちらで書いています。

会話の最初の1文字目だけ引っかかる時

動的フォントアセットは、初めて出る文字を描く瞬間に少し処理が入ります。ノベルゲームのように長い文章を一気に出す場面で気になるなら、よく使う文字を先に足しておく方法があります。

using TMPro;
using UnityEngine;

// 動的フォントアセットに、よく使う文字を先に追加しておくスクリプト
// 会話が始まった瞬間に文字を作る処理が重なるのを避けたい時に使います
public class PrewarmFont : MonoBehaviour
{
    [SerializeField] private TMP_FontAsset dynamicFont;
    [SerializeField] private TextAsset charList; // よく使う文字を並べたテキストファイル

    void Awake()
    {
        bool ok = dynamicFont.TryAddCharacters(charList.text, out string missing);

        if (!ok)
        {
            // 元のフォントファイルに字形が無い文字が missing に入る
            Debug.LogWarning($"追加できなかった文字: {missing}");
        }
    }
}

TryAddCharactersは、Atlas Population ModeがStaticのフォントアセットに使うと「Unable to add characters to font asset」という警告を出して何もしません。動的のほうを渡してください。会話システムを自分で作らずアセットで済ませたい人は、日本語の扱いも含めて比べたこちらの記事が参考になると思います。

□ではなく「文字化け」する時はフォント以外が原因

最後に、症状の見分け方です。□(豆腐)になるのはフォントの問題でした。一方で「縺ゅ≠」のような意味の通らない漢字や「�」「?」に化ける時は、フォントではなく文字コードの問題であることがほとんどです。

見え方 原因 直し方
□(豆腐)になる フォントアセットに字形がない 日本語の動的フォントアセットを設定・フォールバックに追加
一部の漢字だけ□ 静的フォントアセットに焼き込み漏れ 同じフォントの動的アセットをフォールバックに
ビルド後だけ□ 元のフォントファイルが無い・動的の前提が崩れている フォントファイルを残す、静的で焼き込む
意味不明な漢字や「?」 CSVやテキストファイルの文字コード違い ファイルをUTF-8で保存し直す
スクリプトの日本語コメントが化ける .csファイルの文字コード違い エディタでUTF-8に変えて保存し直す

Excelで作ったCSVは、保存の形式によってはShift_JISになります。これをUTF-8のつもりで読むと、TMPに渡る前の時点で文字が壊れているので、フォントをいくら替えても直りません。Debug.Logで読み込んだ文字列を出してみて、Consoleの時点で化けていれば文字コード、Consoleでは正しく出ていてTMPだけ□ならフォント、と切り分けられます。

スクリプトの文字化けやコンパイルエラーに巻き込まれた時は、こちらの記事も役に立つはずです。

まとめ|日本語は「動的フォントアセット+フォールバック」から始める

TextMeshProで日本語が□になったら、Consoleの警告でどのフォントアセットを探したかを見て、日本語フォントの動的フォントアセットを作り、テキストかTMP SettingsのFallback Font Assetsに入れる。最初はこれだけで十分です。

一部の漢字が抜ける時は静的に動的をフォールバックでつなぐ、ビルドで消える時は元のフォントファイルとClear Dynamic Data On Buildを確かめる、意味不明な文字なら文字コードを疑う。この順で見ていけば、だいたいの日本語トラブルは片づきます。

今週はUIをテーマに書いてきました。見た目を整える素材から探したい人は、無料と有料をタイプ別に比べたUIアセットの記事からどうぞ。

有料アセットは、セールの時期に買うと半額以下になることも珍しくありません。毎月のセールの内容はこちらで更新しています。

フォントやUIの素材を有料アセットで揃えるなら、値引きの大きいセールの時期に買うのがお得です。人気どころはセール時におすすめの人気アセット40選にまとめていて、今月のセールの日程はUnityアセットストアのセール情報で確認できます。

著者プロフィール
うんくん

IT系に特化した記事がメインです。(Unity多め。)
Udemy講師もやっています。よろしくお願いします。

※Amazonのアソシエイトとして、当メディアは適格販売により収入を得ています。

うんくんをフォローする
unityunity基本操作
スポンサーリンク
シェアする
うんくんをフォローする