サンプル

Naninovelパッケージには、ビジュアルノベルやダイアログモードでの制作を始めるためのデモサンプルがいくつか含まれています。さらに、開発時によくある用途を紹介する専用のサンプル集も提供しています。以下では、これらのサンプルへのアクセス方法と、それぞれの概要を説明します。

サンプルへのアクセス

高度なサンプルプロジェクトをダウンロードアーカイブ ↗ からダウンロードしてください。

ダウンロードしたディレクトリを解凍し、Unityエディターで開きます。プロジェクトがロードされたら、Assets/Scenes/Main.unity シーンを開き、プレイモードに入ります。デモプロジェクト ↗ のタイトル画面が表示されます。デモを開始するか、「SAMPLES」ボタンをクリックして、以下に概説する利用可能なサンプルに移動できます。

Addressable

このサンプルは、Addressableプロバイダーを使用して（リソースエディターメニューを使用せずに）Naninovelリソースを手動で登録し、リモートホストからアセットを配信する方法を示しています。

サンプルプロジェクトのリソースのほとんどは、リソースマネージャーメニューで割り当てられていないことに注意してください。

— それでも、シナリオスクリプトからは同じ方法でアクセスできます。

nani

@back Snow

これが機能するのは、アセットにNaninovelのリソースアドレスが割り当てられているためです。

パースペクティブシーン

このサンプルは、アニメーションする複数の環境スプライトを配置した汎用背景、パースペクティブモードでのカメラレンダリング、およびボケ（被写界深度）効果を示しています。背景は Content/Backgrounds/Perspective ディレクトリに保存されています。

コンパイラーローカライズ

サンプルプロジェクトでコンパイラーローカライズを有効にするには、スクリプト構成メニューの Compiler Localization フィールドに Settings/Naninovel/CompilerRu アセットを割り当てます。その後、UnityエディターとVS Code拡張機能を再起動します。これで、VS Codeでプロジェクトを開き、Compiler Localization サンプルシナリオを実行できます。

E2E

E2E Tests サンプルは、自動エンドツーエンドテストスイートをセットアップし、利用可能なAPIのほとんどを使用する方法を示しています。

テストスクリプトは Scripts/E2E フォルダーの下に保存されています。フォルダーに配置された .asmdef ファイルに注目してください。これは、Unityテスト環境でテストソースをコンパイルするために必要です。また、Packages/manifest.json ファイルの testables エントリにも注目してください。これにより、テストアセンブリがUnityのテストランナーに公開されます。

汎用アクター

Content/Backgrounds/Beach と Content/Backgrounds/Perspective の汎用背景、および Content/Characters/Kohaku/K3D の汎用キャラクターでは、UnityのAnimatorで作成された3Dモデルとアニメーションを使用して汎用アクター実装をセットアップおよび使用する方法を確認できます。

ダイアログモード

Naninovelを、3Dアドベンチャーゲーム向けのドロップインのダイアログシステムとしても、切り替え可能なスタンドアロンのノベルモードとしても使用する例を示すサンプルプロジェクトです。

すべてのプロジェクト固有のサンプルスクリプトは Scripts/Runtime/DialogueMode フォルダーに保存されています。

インベントリ

インベントリシステムはビジュアルノベルの範囲外ですが、Naninovelとの統合方法に関する多くのリクエストや質問が寄せられました。インベントリサンプルでは、エンジンのソースコードを変更せずに、インストール済みのNaninovelに追加できるインベントリ拡張機能の作成と統合を紹介しています。

注意

インベントリはスタンドアロン製品ではなく、Naninovelの一部でもありません。エンジンを拡張およびカスタマイズする方法を学ぶために使用してください。ただし、そのまま製品に使えるインベントリシステムのソリューションであるとは期待しないでください。そのようなものを探している場合は、アセットストアを確認する ↗ か、ゼロからカスタムのものを作成してください。

このサンプルプロジェクトでは、グリッドレイアウト、ページネーション、ドラッグアンドドロップウィンドウを備えたカスタムインベントリUIの作成方法を紹介しています。ほかにも、カスタムエンジンサービスと関連する構成メニューの追加、入力バインディングの追加、状態管理をエンジンに委ねる方法、カスタムシナリオコマンドと式クエリの作成方法を示しています。

テンプレートから既製のインベントリUIを作成するには、Create -> Naninovel -> Inventory -> Inventory UI アセットコンテキストメニューを使用します。次に、エディターで Naninovel -> Resources -> UI を介してプレハブをNaninovel UIリソースに追加します。追加されると、UIは他のすべてのUIと同様に、@showUI および @hideUI コマンドで表示/非表示にできます。

Inventory UIコンポーネントには Capacity プロパティがあり、インベントリのスロット数を変更できます。スロットグリッドは、Content/InventoryGrid ゲームオブジェクトを介して構成されます（スロット数とレイアウト、ページあたりのスロット数など）。ウィンドウのドラッグアンドドロップ動作は、Content ゲームオブジェクトにアタッチされた Drag Drop コンポーネントを介して構成（または無効化）できます。

インベントリアイテムプレハブは、Create -> Naninovel -> Inventory -> Inventory Item アセットコンテキストメニューを使用して作成できます。次に、アイテムプレハブをエディターで Naninovel -> Resources -> Inventory を介してインベントリリソースとして割り当てる必要があります。

アイテムが多く、エディターメニューから割り当てるのが不便な場合は、Resources/Naninovel/Inventory フォルダーに入れると、自動的にエンジンに公開されます。さらにサブフォルダーで整理することもできます。この場合、シナリオスクリプトで参照するときはスラッシュ（/）を使用します。たとえば、Resources/Naninovel/Inventory/Armor/FullPlate.prefab として保存されているアイテムは、スクリプトで Armor/FullPlate として参照できます。

Addressable Asset System を使用してリソースを手動で公開することも可能です。アセットを公開するには、上記の方法で使用するパスと同じアドレスを割り当てますが、Resources/ 部分は省略します。たとえば、FullPlate.prefab アイテムを公開するには、プレハブにアドレス Naninovel/Inventory/FullPlate を割り当てます。エディター内では、特別な「Editor」リソースプロバイダーが常に最初に使用されることに注意してください。Addressableプロバイダーは、エディターメニューを介して割り当てられていないリソースに対してのみ試行されます。

各アイテムには、単一のインベントリスロットにスタックできるこのタイプのアイテムの数を制限する Stack Count Limit プロパティと、アイテムが使用されたとき（@useItem コマンドを介して、またはプレイヤーがインベントリ内のアイテムをクリックしたとき）に呼び出される On Item Used Unityイベントがあります。以下は、Play Script コンポーネントを使用してイベントを設定し、アイテムが使用されたら削除し、グリッチ特殊効果をスポーンし、テキストメッセージを表示する例です。

@addItem コマンドを使用してインベントリにアイテムを追加し、@removeItem（または @removeItemAt、@removeAllItems）を使用して削除できます。アイテムIDはアイテムプレハブ名と同じです。インベントリスロットIDはグリッドスロットインデックスと同じです（例：最初のスロットは0、2番目は1など）。

アイテムがインベントリに存在するかどうかを確認したり、既存のアイテム数を取得したりするための itemExist() および itemCount() カスタム式クエリも、利便性のために用意されています。

以下はサンプルプロジェクトのスクリプトです。

nani

# Start

行動を選んでください。[>]

@choice "剣を拾う" lock:itemExist("Sword")
    @addItem Sword
@choice "鎧を拾う" lock:itemExist("Armor")
    @addItem Armor
@choice "冒険が待っている、いざ出発！"

# Adventure

@if itemExist("Sword")
    @set monstersSlayed={ itemExist("Armor") ? random(3,5) : 2 }
    @addItem Food amount:{monstersSlayed}
    {monstersSlayed}体のモンスターに遭遇し、剣で倒しました。
    @goto #Start
@else
    しかし武器がありません！モンスターにやられてしまいました。
    @goto #Start

Live2D

このサンプルは、NaninovelでLive2Dキャラクターを使用する方法を示しています。キャラクターは Content/Characters/Hiyori および Content/Characters/Senko ディレクトリにあります。

ローカライズ

生成されたローカライズドキュメントは Content/Localization ディレクトリに保存されます。
生成されたシートは、サンプルプロジェクトルートの下の「Sheets」ディレクトリに保存されます。
ローカライズ固有のフォントは Content/Fonts に保存されます。

ローカライズツール用に選択されたフォルダー：

フォルダー	パス
Script Folder (input)	Assets/Scripts/Scenario
Text Folder (input)	Assets/Content/Text
Locale Folder (output)	Assets/Content/Localization

スプレッドシートツール用に選択されたフォルダー：

フォルダー	パス
Input Scripts Folder	Assets/Scripts/Scenario
Input Text Folder	Assets/Content/Text
Input Localization Folder	Assets/Content/Localization
Output Folder	Sheets

マップ

このサンプルは、C#スクリプトなしでインタラクティブマップを実装する方法を示しています。

マップは Content/UI/Map に保存されたカスタムUIとして実装されています。場所はUIに配置された通常のUnityボタンです。

ボタンのクリックおよびホバーイベントは、Naninovelの Play Script コンポーネントによって処理されます。

場所の利用可否は、ボタンにアタッチされた Variable Events コンポーネントで制御されます。

RTL

RTLプリンターは Content/Printers/RTL に保存されています。

アクターシェーダー

この例は、カスタムトランジションエフェクトを追加するためのテクスチャシェーダーと、ライティングおよび自己発光をサポートするスプライトシェーダーを作成および使用する方法を示しています。後者は、背景アクターの時間帯をシミュレートするために使用されます。

カスタムシェーダーは Scripts/Shaders ディレクトリに保存されています。

背景テクスチャには自己発光マスクがアルファレイヤーに格納されており、カスタムシェーダーはこれを使用して、グローバルライトを無視して発光すべき領域を判定します。

時間帯は Scripts/Runtime/Shader/TimeOfDay.cs で制御され、1日24時間の任意の時点におけるライトの色と発光強度を構成できます。

コンポーネントAPIは Scripts/Runtime/Shader/SetHour.cs カスタムコマンドを介してシナリオスクリプトに公開されており、@hour コマンドで時刻を設定できます。例：

nani

; 現在の時刻を3秒かけて18:00（午後6時）に設定します。
@hour 18 time:3

Spine

このサンプルは、NaninovelでSpineキャラクターを使用する方法を示しています。キャラクターは Content/Characters/Spine ディレクトリにあります。

UI

このサンプルには、新規のカスタムUIと変更を加えた組み込みUIの、次の例が含まれています。

タイトル画面

音楽ギャラリー

クレジット

Chatプリンターのタイムスタンプ

カスタム選択肢ハンドラー

表示されるメッセージ内の絵文字

表示されるメッセージ内のフォントバリアント

カレンダー

すべてのサンプルUIは Content/UI に保存されています。

レイヤーアクター

レイヤーキャラクターは Content/Characters/Miho ディレクトリに、カメラレンダリングモードで設定されたレイヤー背景は Content/Backgrounds/Particles にあります。

ダイスアクター

ダイスキャラクターとアトラスは Content/Characters/Kohaku/Diced にあります。

ビデオアクター

ビデオ背景は Content/Backgrounds/Video ディレクトリに保存されており、ビデオアクターは Content/Characters/Ball ディレクトリにあります。

シーン背景

シーン背景は Content/Backgrounds/Scene ディレクトリにあります。

トランジションエフェクト

利用可能なすべてのトランジションエフェクトを順番に適用するデモは、Scripts/Scenario/Transitions シナリオスクリプトにあります。

オートボイス

ENおよびJAロケールのボイスクリップは Content/Audio/Voice の下に保存されています。

「Auto Voicing」サンプルに入り、ゲーム設定でボイス言語を切り替えてみてください。

ミュージックイントロ

トラックのベース部分をループする前にイントロ部分を1回再生するように、@bgm コマンドの intro パラメーターを使用する方法を示します。

背景のマッチング

背景マッチング機能のデモです。アスペクト比の異なる背景を表示ビューポートに一致させる方法を示しています。

ビジュアルスクリプティング

Visual Scripting ↗（以前はBoltと呼ばれていました）は、Unityにデフォルトでバンドルされている組み込みパッケージです。プログラマーも非プログラマーもコードを書かずに使用できるユニットベースのグラフを使用して、ゲームやアプリケーションのロジックを作成できます。

まず、Package Managerで Visual Scripting パッケージがインストールされていることを確認してください。

Visual Scriptingプロジェクト設定にある Node Library リストに Elringus.Naninovel.Runtime ライブラリを追加します。これは、エンジンの型とAPIをビジュアルスクリプティンググラフに公開するために必要です。

Visual Scriptingは、ライブラリから使用可能なすべての型を自動的に公開するわけではないため、同じ設定メニューの Type Options リストに必要なNaninovel型を追加します。以下の例では、Engine、Script Player Interface、および Script Player Extensions を追加しましたが、他のエンジンサービスインターフェースや構成など、より多くの型が必要になるでしょう。

変更を適用するには、ライブラリと型を追加した後、ユニットを再生成することを忘れないでください。

Visual Scripting設定でNaninovelライブラリと型が追加されると、エンジンAPIがグラフビューの下のファジーファインダーで使用できるようになり、他のUnityまたはサードパーティAPIと同様に使用できます。以下は、エンジンを初期化してスクリプトを再生する例です。この例を試す前に、必ず Initialize On Application Load を無効にし、Title UI を削除してください。

シナリオスクリプトからビジュアルスクリプティンググラフまたはステートマシンにイベントを送信する場合は、以下に示すカスタムコマンドの例を使用します。これは、指定された名前のゲームオブジェクトを検索し、指定された名前と引数でイベントを送信しようとします。

[Serializable, Alias("bolt")]
public class BroadcastBoltEvent : Command
{
    [Alias("object"), RequiredParameter]
    public StringParameter GameObjectName;
    [Alias("name"), RequiredParameter]
    public StringParameter EventName;
    [Alias("args")]
    public StringListParameter Arguments;

    public override Awaitable Execute (ExecutionContext ctx)
    {
        var gameObject = GameObject.Find(GameObjectName);
        if (!gameObject)
        {
            Debug.LogError($"Failed to broadcast '{EventName}' bolt event: '{GameObjectName}' game object is not found.");
            return Async.Completed;
        }

        CustomEvent.Trigger(gameObject, EventName, Arguments);

        return Async.Completed;
    }
}

内容をプロジェクトのAssetsディレクトリ内の任意の場所に保存された新しいC#スクリプトにコピー＆ペーストするだけで、コマンドが自動的に使用可能になり、次のように使用できます。

nani

; 指定した引数とともに「MyEvent」を「ExampleEvent」ゲームオブジェクトに送信します
@bolt object:ExampleEvent name:MyEvent args:ExampleMessage,Script002

以下は、ExampleEvent ゲームオブジェクトにアタッチされたときに、メッセージを表示して指定されたスクリプトの再生を開始するグラフの例です。

サンプル ​

サンプルへのアクセス ​

Addressable ​

パースペクティブシーン ​

コンパイラーローカライズ ​

E2E ​

汎用アクター ​

ダイアログモード ​

インベントリ ​

Live2D ​

ローカライズ ​

マップ ​

RTL ​

アクターシェーダー ​

Spine ​

UI ​

レイヤーアクター ​

ダイスアクター ​

ビデオアクター ​

シーン背景 ​

トランジションエフェクト ​

オートボイス ​

ミュージックイントロ ​

背景のマッチング ​

ビジュアルスクリプティング ​

サンプル

サンプルへのアクセス

Addressable

パースペクティブシーン

コンパイラーローカライズ

E2E

汎用アクター

ダイアログモード

インベントリ

Live2D

ローカライズ

マップ

RTL

アクターシェーダー

Spine

UI

レイヤーアクター

ダイスアクター

ビデオアクター

シーン背景

トランジションエフェクト

オートボイス

ミュージックイントロ

背景のマッチング

ビジュアルスクリプティング