Unity

← コンテンツをゲームに組み込む

Unity 6 · C# · Newtonsoft Json

まず、一文を画面に表示してみましょう。この小さなサンプルは「港の鍵」の実際のエクスポートを直接読み込みます。会話をすべて実行する仕組みではありません。表示できたら、データをゲームのUIにつなげていきます。

1 ・ファイルやシーンの準備

story.jsonをAssets/Storyへ入れます。Package Managerでcom.unity.nuget.newtonsoft-jsonをインストールします。Canvas → Text - TextMeshProを作り、求められたらTMP Essentialsを読み込みます。GameObjectにFirstText.csを付け、InspectorでJSONのTextAssetをstoryFile、テキストをdialogueTextへ割り当てます。Playを押します。

story.json · エクスポートファイルの説明

2 · 最初のテキストを表示

using System;
using Newtonsoft.Json.Linq;
using TMPro;
using UnityEngine;

public class FirstText : MonoBehaviour
{
    [SerializeField] private TextAsset storyFile;
    [SerializeField] private TMP_Text dialogueText;
    private JObject story;

    private void Start()
    {
        try { story = JObject.Parse(storyFile.text); ShowLanguage("en"); }
        catch (Exception error) { dialogueText.text = "Cannot read story.json"; Debug.LogException(error); }
    }

    public void ShowLanguage(string locale)
    {
        const string id = "fd7b61a3-8233-4ba7-8f77-b88b119a91bf";
        var content = story["content"];
        var translation = content["translations"]?[locale]?[id];
        var message = translation?["message"] ?? content["texts"][id]["sourceMessage"];
        string line = "";
        foreach (var segment in message["segments"])
        {
            if ((string)segment["kind"] != "text") throw new Exception("Text-only example");
            line += (string)segment["text"];
        }
        dialogueText.text = line;
    }
}

「Welcome to the harbour. I am Mira.」と表示されれば成功です。locale = "de"、または言語パラメーターをdeにすると「Willkommen im Hafen. Ich bin Mira.」になります。言語が見つからない場合は原文を使います。このサンプルはテキストセグメントに対応しており、プレースホルダーを黙って捨てることはありません。

3 · 一文の表示から会話へ

上の固定テキストIDは、最初の動作確認用です。実際のゲームでは、story-index.jsonからflowRef/entryRefを選び、execution.entries[entryRef].nodeRef、続いてexecution.nodes[nodeRef]を読みます。現在の会話ノードからtext.textRefとspeakerRefを取得します。次へ進む方法はノードのkindによって異なります。

名前と会話にはTMP_Text.textを使います。回答はButton.onClickで処理し、各選択肢IDを個別のローカル変数に保存します。EndではdialogPanel.SetActive(false)を使います。ボタンからdeという言語文字列を渡してShowLanguageを呼べば、進行を戻さず言語を変えられます。

1. ContinueとEnd：接続をたどり、会話ボックスを閉じる
2. 選択肢：回答のID、表示順、選択後の進行先
3. 条件と変数：10ゴールドと2ゴールドで試す
4. 言語：同じIDから別の言語の内容を読み出す
5. コマンド: アイテムを与えるか、ショップを開く
6. Call/Return：サブストーリーを呼び出して戻る

// Inside a method after story (JObject) has been loaded.
var choice = story["execution"]["nodes"]["42edfff8-b8fe-46bf-ae0d-9e2347b6e726"];
foreach (var optionIdToken in choice["optionOrder"])
{
    string optionId = (string)optionIdToken;
    var option = choice["options"][optionId];
    Debug.Log(optionId + " " + (string)option["text"]["textRef"]);
    // Resolve the text and retain optionId in your Button.onClick listener.
}
var branch = story["execution"]["nodes"]["c1c3c372-0a73-4cd0-851d-ede59d5709bb"];
int gold = 10; // Repeat with 2.
var next = gold >= (int)branch["condition"]["right"]["value"]["value"]
    ? branch["whenTrue"] : branch["whenFalse"];
Debug.Log((string)next["nodeRef"]);

4 · 自分の画像を対応付ける

この補足コードでは、現在の会話オブジェクトをnodeとし、コメントに記載したUI要素が存在することを前提とします。C++とMonoGameでは、speakerRefはすでにSpeakerIdまたはspeakerIdとして読み込まれています。キーはミラの実際のキャラクターIDです。画像の名前と配置先はゲーム側で決めます。指定箇所に各行を挿入してください。

// Add inside your own MonoBehaviour. Assign a Sprite and a UI Image in Inspector.
[SerializeField] private Sprite miraPortrait;
[SerializeField] private UnityEngine.UI.Image portrait;
// node is the current JObject dialogue:
portrait.sprite = (string)node["speakerRef"] == "807b2957-7bab-4a28-83a4-1f3d1589bbc2" ? miraPortrait : null;
portrait.enabled = portrait.sprite != null;

話者名は、会話文と同様にcontent.characters[speakerRef].nameTextRefから取得します。画像の対応がない場合は、前のポートレートを隠すか代替画像を表示します。画像は言語によって切り替わりません。

完全なエクスポートに含まれる画像参照を使う

5 · ゲームに必要なファイルを同梱する

参照されたTextAssetはシーンに同梱されます。IDの表は動的なキーを持つJSONオブジェクトです。JsonUtilityをJObjectの代わりにそのまま使うことはできません。この例ではStreamingAssetsへのファイルアクセスは不要です。

結果を確認する

1. 英語とドイツ語の挨拶が正しく表示され、対応していない言語では英語に戻ることを確認します。
2. 進行処理を追加したら、両方の回答、所持金10と2、サブストーリーからの復帰、Endを試してください。
3. ビルドしたゲームをプロジェクトフォルダーの外で実行します。JSON、フォント、ポートレートがそこでも読み込めることを確認してください。

公式ドキュメント

この実装で使用するAPIと設定の資料：

• Unity Newtonsoft Jsonパッケージ
• TextAsset
• JSON シリアル化制約