Version: 2021.1
言語: 日本語
ネットワーク問題
パッケージの命名

カスタムパッケージの作成

Unity Package Manager は Unity 公式のパッケージ管理システムです。以下を行います。

  • Unity が素早く簡単に新しい機能を配布し、既存の機能を更新できるようにします。
  • ユーザーが再利用可能なコンポーネントを見つけて共有するためのプラットフォームを提供します。
  • 拡張可能なオープンプラットフォームとして Unity の機能を増進します。

Package Manager を使用して、プロジェクトの依存関係の定義、 パッケージの依存関係の解決、必要に応じたパッケージのダウンロードと追加、プロジェクトのコンテンツの統合を行うことができます。

パッケージとは何か、Unity Package Manager のしくみに関する一般的な情報は、Unity Package Manager のドキュメントを参照してください。

概要

パッケージは以下を含むことができます。

  • C# スクリプト
  • アセンブリ
  • ネイティブプラグイン
  • モデル、テクスチャ、アニメーション、オーディオクリップ、その他のアセット

ノート: Package Manager はパッケージ内のストリーミングアセットをサポートしていません。代わりに Addressable パッケージをご利用ください。

各パッケージには、パッケージ名、バージョン、 依存関係のリスト、リポジトリへの URL などの情報を含む パッケージマニフェスト ファイルも含まれます。

新しいパッケージを作成する手順は以下の通りです。

  1. 以下のいずれかの方法で、パッケージの空のシェルを作成します。

  2. パッケージに必要なツール、ライブラリ、アセットを実装します。

  3. パッケージのレイアウトが、Unity パッケージのパッケージレイアウト規則に準じていることを確認します。

  4. パッケージにテストを加えます。テストは、パッケージがさまざまなシナリオで期待通りに機能するために不可欠です。

    • すべてのエディターテストを Tests/Editor に書き込みます。
    • すべての再生モードテストを Tests/Runtime に書き込みます。
  5. アセンブリ定義ファイルの名前を変更し、更新します。

  6. サンプル があれば加えます。

    ノート: パッケージにはサンプルのみを加えることができますが、同じレイアウトと JSON 構造を使用して、ツールやテンプレートのパッケージの一部としてサンプルを加えることもできます。

  7. 新しいバージョンを公開するたびに CHANGELOG.md ファイルを更新できます。すべての新機能やバグ修正は、このファイルに記録されます。選択した changelog 形式の詳細は、変更履歴を記録する ドキュメントを参照してください。

    これは、共有しないパッケージの場合はオプションですが、共有パッケージには強く推奨されます。このようにすれば、ユーザーはどのバージョンが自分のニーズに最も適しているかを知ることができるからです。

    ヒント: パッケージの package.json マニフェストファイルの changelogUrl プロパティを使用して、このパッケージの変更ログをホストする外部 Web ページへのリンクを提供できます。

  8. LICENSE.mdTHIRD PARTY NOTICES.md ファイルにライセンスとサードパーティの通知を加えることができます。

    これは、共有しないパッケージの場合は必須ではありません。ただし、共有パッケージには強く推奨されます。これは、ユーザーがパッケージを誤用したり、サードパーティのライセンスに違反することを防ぐために役立ちます。

    ヒント: パッケージの package.json マニフェストファイルの licensesUrl プロパティを使用して、このパッケージのライセンスとサードパーティのお知らせをホストする外部 Web ページへのリンクを提供できます。

  9. パッケージの ドキュメント を作成します。

    ヒント: パッケージの package.json マニフェストファイルの documentationUrl プロパティを使用して、このパッケージのドキュメントをホストする外部 Web ページへのリンクを提供できます。

  10. パッケージを 共有 します。

新しい埋め込みパッケージの作成

プロジェクトフォルダー内 にカスタムパッケージを作成する場合は、以下の手順で行います。

  1. Unity Hub を開き、コンピューター上に 空のプロジェクトを作成 します。

    コンピューター上の既存のプロジェクトを使用して、パッケージをプロジェクトに埋め込む か、ローカルパッケージからインストールする こともできます。ただし、新しいプロジェクトとして開始するほうが、パッケージの内容にエラーが発生しにくくなります。

  2. コンピューターのファイルマネージャー (Windows ファイルエクスプローラーや macOS Finder など) を使用して、プロジェクトフォルダーに移動し、Packages サブフォルダーを見つけます。

  3. Packages フォルダーの中に、パッケージ名 と一致する名前で、自分のパッケージ用の新しいサブフォルダーを作成します。例えば、パッケージ名が com.example.mypackage であれば、サブフォルダーの名前も com.example.mypackage とします。

    ノート: これは、パッケージにアセットが含まれている場合に特に重要です。なぜなら、実際のフォルダー名に関わらず、AssetDatabase はPackages/<your-package-name>/Assets に一致するアセットパスを探す からです。

  4. 任意のテキストエディターを開き、 package.json という JSON ファイルを作成します。

  5. JSON ファイルを作成した新しいパッケージのルートフォルダー下に保存します。

  6. パッケージマニフェスト (package.json) ファイルのすべての必須フィールドに入力します。

Unity を再度開くと、新しいパッケージが Package Manager ウィンドウとProject ウィンドウに表示され、パッケージコンテンツの表示や変更を行えます。Project ウィンドウで package.json ファイルを選択すると、Inspector ウィンドウでそのコンテンツを直接変更することもできます。

新しいローカルパッケージの作成

Project フォルダーの外にカスタムパッケージを作成したい場合は、以下の手順に従ってください。

  1. コンピューターのファイルマネージャー (Windows ファイルエクスプローラーや macOS Finder など) を使用して、 パッケージ用のフォルダーを作成します 。

    パッケージのコンテンツをすでに作成している場合は、既存の場所を使用することもできます。

  2. フォルダー構造体の レイアウト が Unity パッケージの パッケージレイアウト規則 に従っていることを確認してください。例えば、エディターと Runtime のライブラリがある場合は、それらが EditorRuntime フォルダーに格納されていることを確認してください。

  3. 任意のテキストエディターを開き、 package.json という JSON ファイルを作成します。

  4. JSON ファイルを作成した新しいパッケージのルートフォルダー下に保存します。

  5. パッケージマニフェスト (package.json) ファイルのすべての必須フィールドに入力します。

  6. Unity で新しいプロジェクトを作成するか、既存のプロジェクトを開きます。

  7. Packages ウィンドウを開き、先ほど作成した package.json ファイルを使用して、ローカルパッケージをインストールする手順に従います。

新しいパッケージが Package Manager ウィンドウと Project ウィンドウに表示され、パッケージのコンテンツの表示や変更を行えます。Project ウィンドウで package.json ファイルを選択すると、Inspector ウィンドウでそのコンテンツを直接変更することもできます。


  • Custom Packages は Unity 2019.1 で追加NewIn20191
ネットワーク問題
パッケージの命名