PackagingTool 説明書

This software is released under the MIT License, see LICENSE.txt.

このページは、BOOTHにて公開中の、Unityクリエイター向けエディタ拡張「PackagingTool」の説明書です。

説明

このプログラムは、UnityPackage化の一連の手順をプリセット化することで、１クリックでのパッケージングやビルド時の自動パッケージングを行えるようにするエディタ拡張です。パッケージ化のルールにGitの.gitignoreを用いることが可能で、個別にルールを作成することもできます。エディタ拡張の開発時や配布用アバターの作成時に使用することを想定していますが、パッケージング後の自動バックアップ機能を使用することで、個人的なアバター用プロジェクトのバックアップを取ることもできます。

使い方

Unitypackageを導入したあとに、「Packaging Tool/Preset Editor」を開きます。

Preset Editorが開いたら、Addボタンから新しいプリセットを作成します。

新しく作成したプリセットを選択することで、プリセットの編集ができるようになります。

「Package Save Path」は、自動ビルドを行った際にunitypackageの出力先となるパスを入力する欄です。
「Backup Folder Path」は、自動バックアップが有効な際に、自動ビルド後にバックアップを出力するフォルダのパスです。

Visualタブの説明

Visualタブでは、パッケージに組み込むファイルを視覚的に選択することができます。

パッケージに組み込むファイル/フォルダは、リスト上で「オレンジ色」で表示されます。加えて、チェックボックスにもチェックマークがついています。
　また、この状態を「アクティブ状態」と言います。

マウスカーソルで選択したファイル/フォルダは「青色」で表示されます。
　また、この状態を「選択状態」と言います。

アクティブ状態は、対象の「ダブルクリック」「チェックボックスのクリック」「右クリックメニューのToggle Active」で切り替えることができます。

アクティブ状態にならず、パッケージにも組み込まれない状態のファイル/フォルダは、リスト上で「打ち消し線」が引かれています。この状態を「無視状態」と言います。

無視状態は、対象の「右クリックメニューのAdd to Local/Global Ignore」より選択できます。Localはそのプリセットのみで無視し、Globalはプリセットやプロジェクトをまたいだすべての環境で無視されます。（VRCSDK等を入れると良いです。）

Allowタブの説明

Allowタブでは、アクティブ状態なファイル/フォルダのパスを自由に編集することができます。Visualタブで設定したものが自動的に同期されるため、基本的にここを編集する必要はありません。

Ignoreタブの説明

Ignoreタブでは、無視するファイル/フォルダのパスを指定することができます。

• Local Settings はプリセット毎の無視リストです。
• Global Settings はプリセットやプロジェクトをまたいだ無視リストで、SDKを無視リストに入れる場合などを想定しています。
• Project .gitignore(Read Only) はgitなどでリポジトリとして管理している場合に表示されます。.gitignoreの設定をそのままパッケージングの無視リストとして使用することができます。

チェックボックスがついているリストは、プリセット毎でそのルールを使用するかを切り替えることが可能です。例えば、RadialInventoryというプリセットで「Project .gitignore」のチェックを外すと、そのプリセットでは.gitignoreにて指定されているルールは使われなくなります。

自動ビルドやバックアップの方法

メニューの「Packaging Tool/Build Profiles」をクリックして、Build Profilesウィンドウを開きます。

各プリセットごとに自動ビルドを行うかなどの設定を行うことが可能です。

• Auto Buildにチェックを入れた場合、スクリプトのコンパイル時や、シーンのPlay時に自動的にUnityPackageをビルドします。ビルドされたUnityPackageはプリセットの「Package Save Path」に保存されます。
• Create Backupにチェックを入れた場合、UnityPackageをビルドしたタイミングでプリセットの「Backup Folder Path」へUnityPackageをコピーします。また、コピーする際に自動的に「名前+日付」にリネームされます。
• Build Unitypackageボタンを押すと、ルールに基づいたパッケージングを手動で行うことができます。

バックアップの自動削除はありませんので、増えてきたら都度削除をお願いします。

バグ報告

BOOTHの取引メッセージで宜しくお願いいたします。

更新情報

2021/06/20 – V1.0	更新内容
	PackagingToolを公開しました。