#unity Unity6+VisualStudio2022でNuGetパッケージをインストールする入門

　この記事はUnityアドベントカレンダー8日目の記事です。

qiita.com

NuGetの使い方を学ぼう

　Visual Studioで開発している方は誰でもお世話になっているであろうNuGetなんですが、UnityでNuGetパッケージを使用する場合、通常とは異なる導入手順が必要です。

　話が前後しますが、土屋は最近「Sprache」と言うC#実装のパーサコンビネータをUnityで使えないか検証していました。

　SpracheはNuGetパッケージとして提供されているので、まず非Unity環境で動かして挙動を確認し、問題なければUnity環境に持って来ようとしました。

　この時、Unity環境ではNuGetパッケージの導入手順がVisualStudio環境とは異なるという事を知らなかったため、作業中にプチハマリしてしまったのでした……。

　土屋と同じ苦しみを他の人が繰り返さなくていいように、このハマリポイントを記事にしておきたいと思います。

　そもそもNuGetとはどういう物なのか、なぜUnityでは手順が違うのかなどについても軽く説明するので、UnityユーザーのNuGet導入ガイドになればと思います。

　なお、今回の記事はUnity6＋Visual Studio2022環境を想定しています。

NuGetとは

※このパートは以前書いた記事のリライトです。

　NuGet（「ニューゲット」と読むのが一般的らしい）は、マイクロソフトが開発・運用しているパッケージマネージャーと呼ばれるwebサービスです。クラウドで.NETライブラリのデータベースを管理し、VS経由で任意のパッケージを、他ライブラリとの依存関係を自動的に対応しながらインストールできます。今回のSpracheのように、ユーザーもデータベースにパッケージを登録できます。

　ライブラリは依存性の管理というのが大変でして、例えばＡというライブラリがＢＣＤというライブラリを内部で参照している場合、ＡＢＣＤを全部インストールする必要があります、もちろんＢＣＤも他のライブラリに依存している場合があります。

　また、ＡはＢのVer1.0には対応していますが、ＢのVer1.2は互換性が確認出来ていない場合とかが起こりえます。その為、適切なバージョンの依存ライブラリをインストールする必要があります。NuGetを使えば、このような依存性を自動的に対応してくれるわけです*1。

　このように、NuGetは、様々な.NETライブラリを統一的なインストール方法、かつ、ライブラリ間のバージョン依存性も自動的に解決し、必要なライブラリをインストールしてくれるのです。。

Visual Studio 2022でNuGetパッケージをインストールする

　ではさっそくNuGet経由でライブラリをインストールしてみましょう。先にUnityではなく、Visual StudioでNuGetパッケージをインストールする手順を説明します。ここでは先程も名前を挙げた「Sprache」を例にします。

　Visual Studio 2022のプロジェクトを開いている状態で、「ツール＞NuGetパッケージマネージャー＞ソリューションのNuGetパッケージの管理」を選択します。

　ウィンドウが開いたら「参照」タブを選択し、検索ボックスに「Sprache」と入力します。すると、下のペインにNuGetデータベースに登録されているパッケージの候補が表示されます*2。

　一番上の「Sprache」を選択し、右ペインの「インストール」を選択します。

　ポップアップウィンドウが２個表示されるので「適用」「同意する」をそれぞれ選択するとインストールが完了します。

　タブの「インストール済み」を選択すると、Spracheがインストールされている事がわかります。

UnityプロジェクトでNuGetパッケージを利用する

　ここからようやくUnityの話になります。

　先程無事にNuGetパッケージをインストールできましたが、Unityプロジェクトで使用する場合にはこの手順は使えません。と言うのも、Unityではビルドに含めるアセンブリをUnity側で管理する必要があるためです。

　何故かと言いますと、通常の方法でVisualStudio側でNuGetパッケージをインストールすると、その参照情報はcsprojファイルに書き込まれるのですが*3、Unityはビルド時にcsprojファイルを更新する事があり、それにより、管理外のアセンブリ（ここではNuGetパッケージの事）への参照情報が削除されてしまうのです。

　そのため、UnityプロジェクトでNuGetパッケージを使用する場合、そのNuGetパッケージをUnity側で管理しなければいけません。

　Unity標準ではNuGetの管理機能が用意されておらず、外部ツールでUnityの機能を拡張する必要があります。

　NuGetを管理する為のツールは、以下の２種が提供されています。どちらを使う場合も、Unityプロジェクト毎にツールを追加する必要があります。

NuGetForUnity：エディタ拡張
Unity NuGet：Unityパッケージ

　「Unity NuGet」は、NuGetパッケージをPackage Manager経由で導入・管理できるようになる優れものです。ただし、~~OpenUPMというレジストリ~~UnityNuGetの人が公開している unitynuget-registry.azurewebsites.net*4 に登録されているパッケージしかインストールできないという制約があります（ざっくりとした説明）。「Unity NuGet」自身もPackage Managerからインストールします。

　「NuGetForUnity」は上記の制約はありませんが、エディタ拡張の形式で提供されているツールで、.unitypackageファイルをダウンロードしてインポートする手間があります*5。また、インストールしたNuGetパッケージは（Package Managerではなく）NuGetForUnity内で管理されます。

　SpracheがOpenUPMに登録されているか分からなかったので*6、今回はNuGetForUnityを使います。