【宴4 x CRIADX】宴4でCRIADXが使える「CRIADX Plugin for Utage4」とは？～導入編～

こんにちは！
ADXアンバサダーのこはとです。

みなさん、ノベルゲームの音声演出、もっとこだわりたくないですか？
この度、 ノベルゲームアセット「宴4」でCRIADXが動かせるプラグインを開発し、公開いたしました！
本記事では、その導入方法と活用例などを、「導入編」「使い方と注意編」に分けてご紹介します。

宴（Utage）とは？

宴は、Unityでノベルゲームを制作するのに特化したUnity向け有料Assetです。
2014年よりリリースされており、現在もバージョン4（=宴4）としてサポートされている大型アセットとなっております。
どのようなゲームがプレイできるかは、以下のサイトを御覧ください（WebGLでプレイできます！）

Unityにインポートすることで、宴は基礎的なノベルゲームシステムを自動でセットアップしてくれます。
これにより、開発者はキャラクターの立ち絵や背景などのアセット、そして「シナリオ」と呼ばれるエクセル形式の台本を作成することで、プログラム無しに誰でも簡単にノベルゲームを作ることができます。
利用方法は多岐にわたり、ノベルゲームはもちろん、使い方しだいではクイズゲームのようなものも作れるほか、様々な形式のゲームにテキストイベント機能のみを切り出して活用することもできるため、現在も多くの開発者に愛されています。

本記事では、これにCRIADXという音声ミドルウェアを組み合わせることで、より豊かな音声表現ができるようにする方法を紹介します。

CRIADXとは？

CRIWARE社が開発する音声ミドルウェアです。
UnityやUnrealEngineなど、ゲームエンジンやその他開発環境に導入することで、より豊かな音声再生システムを実装できます。

導入すると…

• Unityのオーディオシステムより豊かな音声演出を簡単に実装できるようになる
• 外部オーサリングソフト「AtomCraft」を使用することで、音声の編集や管理を一箇所に統合できる
• Unity側では大量の音声を、一つの圧縮ファイルだけで管理することができる
• 再生時の遅延が大幅に改善
• AISACなどの独自機能で、音声にエフェクトなどの効果をつけられる

などの効果が得られます。

特に個人開発者向けのLE版では、一定の規模であれば無料で使用することができ、サブスクリプションなども不要となっております。
今回はこれを宴4に導入する方法を紹介しますが、もちろんCRIADX自体は普通のUnity環境でも使用していただくことができます。

ADXforUtage4を導入するとできること

「CRIADX Plugin for Utage4」という、そのままな名称ですが、本プラグインは元々宴3向けに提供されていたCRIADXプラグインをベースに、筆者が宴4向けに改修したプラグインとなっております。
基本的な部分は宴3向けだったものを宴4で動作するように改修しつつ、CRIADXの独自機能へアクセスできるよう、新規で追加のコマンドを用意しました。

導入することで、例えば…

• プレイヤーの選択に応じて、キャラクターボイスをヘッドホンの左右バランスを変えて再生する
• 街や洞窟などのシチュエーションに応じて、ボイス素材やBGMにエコーなどのエフェクトをかける
• 会話がシリアスな展開になったタイミングで、BGMを変えずに、BGMのパートをより暗い部分に自然に遷移させる
• キャラクターのボイスが、プレイヤーの選択した主人公の性別によって自動で切り替わる

など、ゲームをよりユニークにする演出を、シナリオのコマンドから設定できるようになります。

導入方法

実際にプラグインを導入していきましょう！
少し長いですが、最初だけなのでご勘弁ください！
※導入方法は、以下のマニュアルからでも同じ内容を確認できます。

前準備

導入する前に、まず以下のものが揃っているかを確認してください。

• Unity
  バージョンは任意のもので構いません
  執筆時点ではv6000.0.58f2にまで対応しています
• 宴4アセット
  UnityAssetStoreで購入しておく必要があります。導入前に購入しておきましょう
  https://assetstore.unity.com/packages/tools/game-toolkits/utage4-for-unity-text-adventure-game-engine-version4-266447
• CRIADXプラグイン
  以下のCRIWAREの公式ページからUnity向けプラグインをインストールしてください
  https://game.criware.jp/products/adx-le/
• AtomCraft
  上記と同様、CRIWAREの公式ページからダウンロードできます。ダウンロード後、インストールをし、あらかじめソフトの起動画面でライセンス認証を済ませておきましょう
• 本プラグイン
  ここからダウンロードできます。もちろん無料です。任意の場所に保存してください！
  https://github.com/kowato/CRIADXPlugin_for_Utage4

以上のものが揃ったら、Unityに導入していきましょう！

Unityプロジェクトの作成

UnityHubを開き、新しく宴用にProjectを作成しましょう。
2DProjectで作成し、Project名に任意の名前をつけます。

Unityへの「宴４」のインポート

プロジェクトを作成したら、必要なプラグインやアセットをインストールしていきます。

インストールする順番を誤ると、正しく動作しなくなる場合があります！
【宴4】→【CRIADX基本プラグイン】→【ADXforUtage4プラグイン】
の順でインストールするようにしましょう。

1:宴をインポート

まず、宴４をプロジェクトにインポートします。
Window>>PackageManagerから、Utage4をDownload（初回のみ）、及びImportします

この表示が出たらそのまま「Install/Upgrade」を押していただいてOKです。

2:CRIADX基本プラグインをインポート

宴のインポートが終わったら、特に設定などは行わず、そのままCRIADXの基本プラグインをインポートします。
Assets>>ImportPackage>>CustomPackageから、前述でダウンロードしたCRIADXプラグインのフォルダの中の「cri\unity\plugin」に入っているcriware_unity_plugin_(バージョン名)_le_ja.unityPackageを選択し、内容をすべてImportしましょう。

3:ADXforUtage4プラグインをインポート

CRIADXの基本プラグインが導入できたら、最後に本プラグイン「ADXforUtage4」をインポートします。
同じくAssets>>ImportPackage>>CustomPackageから、ダウンロードしたADXPlugin_for_Utage4_(バージョン名).unitypackageをインポートします。

以上3つのインポートが終わったのを確認できたら、宴のシーンを作成していきます。
（※Project内の「Utage4_AdxSample_Unity6」フォルダの中のサンプルシーンを開くことで、本プラグインの動作を確認することもできます。）

宴のシーン作成

「宴４」「ADXのUnity向けプラグイン」「ADXの宴４向けプラグイン」をインストールし終えたのを確認できたら、宴のシーンセットアップを行います。
Tools>>Utage>>New Projectから、任意の名前を設定し、「Create」でProjectを作成しましょう。
ここで作成した名前は、そのままSceneの名前になります。

※再生時に「TMP Importer」のウインドウが出た場合は、再生を停止して「Import TMP Essentials」を選択してください。

必要な設定の変更

シーンの設定まで行けたら、最後にADX向けの設定として以下の設定を確認します。

UnityAudioの無効化

余計な処理を回避するため、UnityデフォルトのAudio再生は無効化します。
Edit→ProjectSettings→Audio→DisableUniyAudioのチェックボックスをOnに設定。

CRIADX基本コンポーネントを作成

UnityでADXを使用する場合は、Sceneにいくつか必須コンポーネントを配置する必要があります。
まず、空オブジェクトを作成して名前を「CRIWARE」とし、オブジェクトに「CriAtom」コンポーネントを追加します。

その後、Hierarchy上で右クリックを押し、CRIWAREの項目から以下の2つのオブジェクトを作成します。

• CRIWARE Library Initializer
• CRIWARE Error Handler

この２つは「CRIWARE」オブジェクトの子要素にしておきましょう。

宴のサウンドシステムをADXのサウンドシステムに変更

宴のサウンドシステムは、外部のサウンドシステムへの置換に対応しており、本プラグインもその機能を用いて実装しております。

新規オブジェクトを作成し、AddComponentからAdx2LeForUtageコンポーネントをアタッチしましょう。
また、この際、Adx2LeForUtageコンポーネントの「DefaultCueSheet」の値に「CueSheet_0」を入力しておきましょう。

設定が終わったら、SoundManagerのOnCreateSoundSystemに作成したAdx2LeForUtageを追加します。

新規追加のコマンドを使用できるようにする

本プラグインで追加されたコマンドを使用できるようにします。
「AdvEngine」がアタッチされているゲームオブジェクトに、AddComponentでAdxCustomCommandを追加するだけでOKです。

（任意）文字送り音、カーソルホバー音を鳴らしたい場合

文字送り音、カーソルホバーの音を再生したい場合は、別で設定する必要があります。

文字送り音

文字送りの音を設定する場合は、AdvEngineゲームオブジェクトにAdvTextSoundを追加します。この際、Engineの値にAdvEngineスクリプトを設定することを忘れないよう注意してください。

「DefaultSoundName」に文字送りのCueNameを、「SoundCueSheet」に読み込み先のCueSheet名を入力することで、任意の音声で文字送りができます。（Cueの設定はシナリオデータでラベルと紐づける必要があります）

また、SoundInfoListに「キャラ名」「CueName」を設定することで、任意のキャラの文字送り音を変更することもできます。

マウスホバー音

マウスホバー音や決定音を変える場合は、uguiButtonSeオブジェクトの確認をします。
デフォルトの値を空白にした場合、それぞれ「ClickSe」「HighliteSe」が代わりに入力されます。スプレッドシートのAudioに同名のラベルを作り、ラベルにCueNameを紐づけることで、マウスホバー音などを設定できます。

導入編　おわり

以上で導入は完了です！お疲れ様でした！
基本的には導入は１プロジェクトにつき１回でOKです。
ただし、後編の「使い方と注意」でもお伝えしますが、もし宴のバージョンアップを行った際は、お手数ですが本プラグインを再インポートしていただけますと幸いです。
「使い方と注意」では、具体的な活用方法やコマンドなどを解説します！
また、以下のマニュアルからでも使用方法は確認できますので、こちらも御覧ください！

後編「使い方と注意」編はこちら

URL