7 Days to Die 音声データ差し替えガイド

SDX は ゲームエンジン Unity を使ったゲームで MOD を実現するためのツール（ないしはフレームワーク）です。 http://sdxmod.com/ で配布されています。

7DTD の MOD にはその形態に幾つか種類があります。 種類の一つとして「SDX を前提とした MOD」というものがあります。 この形態の MOD では

• 複数の MOD を組み合わせて使う
• MOD を適用したり抜いたりする

といったことが容易になります。

音声差し替えに SDX は必須ではありませんが、何かと便利なので利用することにしました。

私が理解した SDX の技術背景を、分かる人向けに端折って概説しますと：

• 7 Days to Die は MOD 作成を意識して作られている。
  • ゲームパラメタの XML ファイルによる外部化
  • フックポイントの整備、など
• だが複数の MOD を作るための仕組みは備えていない。そこのところを何とかするのが SDX
• ある意味リンカのようなもの。
  • リンク結果として 7DTD のランタイムのファイル構成を書き換える
• 以下の機能を整備されているようだ。
  • オリジナルのバックアップ＆レストア
  • 実行前の XML ファイル編集
  • 実行前のパッチの適用（パッチは C# スクリプトとして書く模様）
  • 実行時の DLL ローディング
  • リソース解決の仕組み
  • フック関数の呼び出し
• というわけで「ツール」ではなく「フレームワーク」と自称している模様。

この文書の内容は 2017/1 現在での最新である以下の環境を前提としています。

• 7 Days to Die: alpha 15.1
• SDX 0.7.0
• platform: Windows のみ

7DTD のファイルを SDX が前提としている状態に整えるために必要な処置。 「インストールしたままなので変更無いはず」とスキップしてはいけない模様。 念の為メモ：別途 MOD 導入していたなどの事情があって、その情報が必要なら事前にバックアップしておくこと。

具体的な操作は以下：

1. Steam クライアントを起動
2. 「ライブラリ」メニュー「ゲーム」の中の「7 Days to Die」
3. 右クリックのメニューから「プロパティ」
4. 「ローカルファイル」タブの中の「ゲームキャッシュの整合性を確認…」ボタン
5. ウィンドウが表示され Steam のサーバーと通信して必要に応じてファイルが書き換わる

SDX のリリース案内 からたどれる http://sdxmod.com/builds/SDX_0.7.0.zip から ZIP ファイルをダウンロードする。

お好きな作業場所にこの zip を展開。この場所を以下の説明では ${SDX} と表記する。 （セキュリティソフトが SDX のファイルについてウィルスの恐れありと警告したりファイル削除するかもしれない。 無視させる設定をするなり、検疫からの復旧するなどの対処をすること。）

${SDX}/SDXLauncher.exe を起動する。操作ウィンドウが表示される。 SDX に対して Game Directory（7DTD のファイルの置き場所）を設定する。手順は以下

1. Steam クライアントで 7 Days to Die の Game Directory を確認する。 操作UIは以下：
   1. Steam クライアントを起動
   2. 「ライブラリ」メニュー「ゲーム」の中の「7 Days to Die」
   3. 右クリックのメニューから「プロパティ」
   4. 「ローカルファイル」タブの中の「ローカルファイルを閲覧…」ボタン
   5. エクスプローラーでフォルダが開かれる。パスをコピー。
2. SDX で「Settings」ボタンから「Game Directory」の欄に前述の場所をペースト。
3. Save で保存

7DTD alpha 15.1 が使っている Unity のバージョンに合わせて v5.3.3 を入手し、セットアップする。

1. 旧バージョンのアーカイブ から v5.3.3 の 「Unityエディター（64ビット）」をダウンロードする。
2. EXE ファイルを実行してインストールする。
3. インストールした Unity を起動する。
4. Unity のアカウントへのログインが要求されるので、ログインないしはアカウント作成する。

アカウントを作成する場合は以下：

1. Unity エディターを起動した画面で "create one" のリンクから Web ブラウザが起動する
2. 必要事項入力。
3. 確認メールが届くので、メールの中の URL へブラウザでアクセス、さらになんやかんや入力。
4. license options は PERSONAL EDITION を選択する。

（詳細が不明ならば「Unity インストール チュートリアル」などで検索して対処されたし。）

Unity エディターを使って音声データを 7DTD が実行時に読み込める形式に加工できるようにする。 具体的には、素材データ（Asset）をエクスポートする（書き出す）スクリプトを Unity のプロジェクトに取り込んでおく。

手順：

1. スクリプトのファイル を入手。（この配布サイトは広告のウィンドウがポップアップするので、適宜閉じる）
2. Unity で プロジェクトを作成する
   1. Unity エディターを起動
   2. 「NEW」ボタン （あるいは既に他のプロジェクトを開いているのであれば メニュー>File>New Project… ）
   3. 名前と場所を適当に指定。3D/2D の選択は 3D で。
3. Unity の Project Window （ウィンドウ左下の方 Project タブ） の中の Assets を選択
4. その右側の所（This folder is empty と表示されている）に先ほど入手した ExportAssetBundles.cs をドロップ。
5. Assets のところの右クリックで "Assets/Build AssetBundle From Selection - Track dependencies" が出るのを確認。

補足：

• この準備は Unity のプロジェクトを作るたびに必要である。
• このスクリプトは SDX を使った MOD の作り方 HowTo 記事 SD2DX-How-To-Make-Mods から紹介されている。
• （ 参考 https://docs.unity3d.com/Manual/BuildingAssetBundles.html ）

自分が作る MOD の名前を決める。以下の例示では MyMod にしたとして記述する。

MOD の中に収めるバンドル（ここでは音声データのパックしたもの）の名前を決める。 MOD の名前と同じでも可。以下の例示では MyBundle として記述する。

差し替えたい音声を wav 形式で作成する。

音声にどのような種類（ジャンプした時、暑い時、etc.）が有るかは、 添付のテンプレートの config.xml や 一覧資料 を参照。

Unity で wav ファイルを 7DTD が実行時に読み込める形式に変換する。

手順：

1. Unity エディターで前述の ExportAssetBundles.cs を取り込んだプロジェクトを開く。
2. Assets の中にフォルダを作り、その名前をバンドルの名前にする。（例えば MyBundle）
   1. Unity の画面左下 Assets で右クリック
   2. メニュー から 「Create>Folder」を選択
   3. 出来たフォルダの名前が反転しているので変更
3. このフォルダに用意した wav ファイルをドロップしていく。
4. AssetBundle として 書き出す
   1. MOD の名前にしたフォルダのところで右クリック
   2. メニュー項目 「Assets/Build AssetBundle From Selection - Track dependencies」 を選択
   3. 保存する場所を適当に選択。
   4. 「New Resource」 となっているファイル名をバンドルの名前（例えば MyBundle）にする。（←重要！）
   5. 保存。（これで音声データをパックした MyBundle.unity3d が生成された。）

1. MOD のテンプレートを SDX の管理下に配置する
   1. SDX で 「Mods Folder」 ボタンを押す。
   2. ${SDX}\Targets\7DaysToDie\Mods フォルダが作られる。エクスプローラーが開く。
   3. 添付の MOD テンプレート（PlayerVoicesTemplate フォルダ）をこの Mods にコピーする
   4. フォルダ名をこれから作成する MOD 名（今の例では MyMod）に変更する。以下このフォルダの場所は ${MyMod} と表記する。
   5. （このフォルダ名は何でも良いようだが MOD 名にしておくのが混乱しないだろう。）
2. ${MyMod}/mod.xml を編集する
   1. author（作者）, name（MOD の名前）,mod_version（MOD のバージョン）, description（MOD の内容説明） を適宜編集。
   2. SDX （SDXLauncher.exe）を再起動すると、Mods タブにこの MyMod が現れる。
   3. （見て分かるように、mod.xml の内容は SDX での表示に使われる）
   4. （ちなみに game_version は 7DTD のバージョン、launcher_version は SDX のバージョン）
3. 音声データの MOD への取り込み
   1. 前述の手順で作成した AssetBundle（MyBundle.unity3dファイル） を ${MyMod}/Resources フォルダの中に置く。
4. 音声データとゲーム中のアクションの対応付けを記述する
   1. ${MyMod}/Configs/config.xml を編集する。（記述方法は別記）

1. SDX のウィンドウで「Build」ボタンをおす
2. エラー表示が無いことを確認する。エラーが起きたら config.xml の編集にもどる。（あるいは Assets の中身を確認）

なお SDX 0.7.0 で 「ERROR: No assembly from BuildAndRunPatchModsTask」という表示は正常。

1. SDX のウィンドウで「Play」ボタンを押す。7DTD が起動する。
2. ゲームをプレイして挿し換わっていることを確認する。

前述した手順の中の ${MyMod}/Configs/config.xml の記述方法の詳細を、 付属のテンプレートの config.xml を元にして説明します。

例えば次の塊が、一つの音声（サウンド）の差し替えを定義しています。

    <!-- player2jump: ジャンプの声 -->
    <remove xpath="/Sounds/SoundDataNode[@name='player2jump']/AudioClip" />
    <remove xpath="/Sounds/SoundDataNode[@name='player2jump']/AudioClip" />
    <remove xpath="/Sounds/SoundDataNode[@name='player2jump']/AudioClip" />
    <remove xpath="/Sounds/SoundDataNode[@name='player2jump']/AudioClip" />
    <append xpath="/Sounds/SoundDataNode[@name='player2jump']" >
      <AudioClip ClipName="#FooBundle?num001_01"/>
      <AudioClip ClipName="#FooBundle?num002_01"/>
      <AudioClip ClipName="#FooBundle?num003_01"/>
    </append>

「<!–」と「–>」に囲まれた範囲（複数行可）は、SDX は読み飛ばす人間向けのメモ書き（コメント）です。

音声は種類ごとに名前が決まっています。 上記の例は「player2jump」という名前の音声設定を書き換えています。

「player2jump」は、女性プレイヤーキャラクタがジャンプした時の声です。 sounds-name.html に判明した範囲で名前と「どこで使われる音か」を記しました。

      <AudioClip ClipName="#FooBundle?num001_01"/>

の部分が使用する音声データを指定しています。 バンドル名「FooBundle」に含まれる「num001_01.wav」を使用することを指定しています。 このように

• シャープ
• AssetBundle の名前
• ハテナ
• wavファイル名の拡張子を除いた部分

を連ねて書きます。

テンプレートには AssetBundle として Resources/FooBundle.unity3d が格納されているので、 この例ではこの部分は FooBundle になっています。 ご自分の MOD を作る際には自分で作ったバンドル名に（例えば MyBundle）してください。

この AudioClip を複数並べると、発音のたびに複数の音声データの中からひとつがランダムに選ばれて使われます。 ゼロ個ならば無音になります。

    <remove xpath="/Sounds/SoundDataNode[@name='player2jump']/AudioClip" />

の行はデフォルトの AudioClip を取り除く（使用しない）ようにする指定です。 7DTD のオリジナルの設定では player2jump には４種類の音声データが指定されているので、 この remove の行を４回書いています。

（オリジナルの設定で何個の指定があるかは ${SDX}/Backups/7 Days To Die/Data/Config/sounds.xml を見ると分かります。）

（ xpath の仕様からすると複数回書かなくても良さそうなものなのだが、 どうやら該当する一つ目のノードにだけ作用するらしい。）

上記の記述でジャンプ操作するとこれまでのデフォルトの音声は鳴らずに、 num001_01, num002_01, num003_01 のいずれか（それぞれ「いち」「に」「さん」という音声）が鳴るようになります。

• config.xml は mod.xml から import されている
• XML config 要素は 7DTD の XML の DOM 書き換え操作を記述する。
• config 要素の name は XML ファイル名に対応している。
  • remove 要素は DOM から element を削除する操作指示
  • その xpath は削除する element を指す。
• append は要素の追加指示。
• 他は SDX のドキュメントや https://7daystodie.com/forums/showthread.php?41047-Guide-SDX-How-to-write-your-own-configuration-file などを参照
• /Sounds/SoundDataNode が音の種類ごとに、発声データを記述している。
  • その中の AudioClip が波形データ
  • SoundDataNode には他のパラメタもある
    • AudioSource: 音源の名前（おそらくゲームの3D空間でのシミュレートをするためのもの）
    • LocalCrouchVolumeScale, runningvolumescale 相対ボリューム？

XML ファイルの記述を間違えるとエラーになる。 間違え方によって色々な反応のパターンがある。

Game Directory で指定した場所の /Data/Config/sounds.xml に書き換わった XML ファイルが作成される

将来の版ではデフォルトの sounds.xml の内容が変化するかもしれない。 （SoundDataNode の名前（name 属性）が変ったり AudioClip の数が変更されたり。） その場合 SDX での Build 中にエラーが出るので、調節する。 他の MOD を併用している場合に同様の問題が

MOD のスクリプトが一つも入っていないと Mods.dll が見つかりませんでした、というエラーメッセージが起きる。 これは SDX の不具合と思われる。 このテンプレートでは回避するために空っぽのスクリプトを同梱している。