GitHubのリポジトリからUnityのパッケージマネージャーを使用してファイルをパッケージとしてインポートする。 その①

本日はUnity枠です。

今回は筆者も開発にかかわっているMicrosoft MixedRealityToolkit GraphicsTools(以下MRGT)の仕組みが気になったので模倣しながらGitHubのリポジトリからUnityのパッケージとして配布できるサンプルを作っていきます。

〇開発プロジェクトと配布パッケージの作成

①配布用の新しいリポジトリを作成します。

②git直下にUnityプロジェクト(ここではDevelopmentProject)とからのフォルダを作成します。(ここではcom.holomoto.sampleUnityPackage)

ここではDevelopmentProjectがリリースするパッケージを開発するためのUnityProject、この工程では空フォルダですが、com.holomoto.sampleUnityPackageが実際に配布するファイルを格納します。

③配布パッケージのルートフォルダ(以降com.holomoto.sampleUnityPackage)の一つ下の階層にpakcage.jsonを作成します。

このpakcage.jsonがUnityのPackageManagerでUnityパッケージとして読み込む際の礎となります。

④pakcage.jsonの中身を次のように定義します。

{
  "name": "com.holomoto.samplepackage.unity",//パッケージ名
  "version": "0.1.0",
  "displayName": "HoloMotoSampleUnityPackage",//表示名
  "description": "Sample for loading files from GitHub repository as Unity packages in any Unity project",
  "unity": "2020.2",
  "repository": {
    "type": "git",
    "url"://GithubのURL "https://github.com/HoloMoto/UnityPackage_import_from_GitHub_Sample.git"
  }
}

このurlはGitHubリポジトリのCodeから見ることができるhttpsのURLを指定します。

⑤DevelopmentProject(開発プロジェクト)のmanifest.jsonを書き換えます。

DevelopmentProject("Unityプロジェクト名")\Packages\manifest.json

  "dependencies": {
    "com.holomoto.samplepackage.unity": "file:../../com.holomoto.samplepackage.unity",

これによって開発用のUnityプロジェクトにローカル環境のパッケージとして読み込まれます。 　

UnityプロジェクトのPackage内のフォルダは通常ファイルの操作を行うことはできませんが、このようにしてインポートしたUnityパッケージの場合Assetsファイル内同様に自由にファイルの移動、編集が可能になります。

⑥GitHubへPushします。

今回は次のリポジトリに公開しています。

github.com

以上で配布パッケージが完成しました。

次回は運用環境での配布パッケージの導入とサンプルの追加を行っていきます。