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

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

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

You can use the Package Manager to define project dependencies, resolve package dependencies, download packages, add packages, and integrate content in your projects.

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

概要

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

• C# スクリプト
• アセンブリ
• Native plug-ins
• モデル、テクスチャ、アニメーション、オーディオクリップ、その他のアセット

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

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

Procedure

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

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

   • 埋め込みパッケージを設定
   • ローカルパッケージを設定

2. Make sure the layout of your folder structure follows the package layout convention for Unity packages. For example, if you have Editor and Runtime libraries, make sure you store them under the Editor and Runtime folders.

3. If your package includes code, make sure the package layout you created has the necessary assembly definition files. For information about creating and defining assembly definition files, see Assembly definition and packages. For additional information, see Assembly definitions.

   Note: If the console window reports a warning after adding an assembly definition file, save your project, close it, then reopen it.

4. Add your tools, libraries, and any assets your package requires.

5. Add tests to your package. Tests are essential for ensuring that the package works as expected in different scenarios:

   • すべてのエディターテストを Tests/Editor に書き込みます。
   • Write all your Play Mode Tests in Tests/Runtime.

6. If you have samples for your package, add them to the proper samples subfolder.

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

7. You can update the CHANGELOG.md file every time you publish a new version. Every new feature or bug fix should have a trace in this file. For more details on the chosen changelog format, see the Keep a Changelog documentation.

   This step is optional for packages that you don’t share, but strongly recommended for shared packages, so that users know which version best suits their needs.

   Tip: You can provide a link to an external web page where you host this package’s changelog by setting the changelogUrl property in your package’s package.json manifest file.

8. You can include licenses and third-party notices in the LICENSE.md and THIRD PARTY NOTICES.md files.

   This step is optional for packages that you don’t share, but strongly recommended for shared packages, so that your users don’t misuse your packages or violate any third-party licenses.

   Tip: You can provide a link to an external web page where you host this package’s licensing and third-party notices by setting the licensesUrl property in your package’s package.json manifest file.

9. Document your package.

   Tip: You can provide a link to an external web page where you host this package’s documentation by setting the documentationUrl property in your package’s package.json manifest file.

10. Share your package.

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

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

Note: These instructions are part of the larger procedure for Creating custom packages.

1. Open the Unity Hub, and create an empty project on your computer.

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

2. Using your computer’s file manager (for example the Windows File Explorer or the macOS Finder), navigate to your project folder and locate the Packages subdirectory.

3. Create a new subdirectory for your package inside the Packages folder using a name that matches the package name and follows the naming conventions. For example, if your package name is com.example.mypackage, create a subdirectory called com.example.mypackage.

   Note: This is particularly important if your package contains assets, because the AssetDatabase looks for an asset path that matches Packages/<your-package-name>/Assets, regardless of the actual folder name.

4. Open your preferred text editor and create a JSON file called package.json in the root of the package folder.

5. Fill out all required and recommended fields in the package.json file. You can use the package manifest example as a reference.

When you reopen Unity, the new package appears in the Package Manager window and in the Project window, where you can view and modify the package contents. If you select the package.json file in the Project window, you can also modify its JSON values directly in the Inspector window.

Return to the main procedure to complete the creation of your package.

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

Follow these instructions if you want to create a custom package outside your project folder.

Note: These instructions are part of the larger procedure for Creating custom packages.

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

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

2. Open your preferred text editor and create a JSON file called package.json in the root of the package folder.

3. Fill out all required and recommended fields in the package.json file, making sure the name property follows the naming conventions. You can use the package manifest example as a reference.

4. In Unity, create a new project or open an existing project.

5. Open the Package Manager window and follow the instructions for installing a local package, using the package.json file you just created.

The new package appears in the Package Manager window and in the Project window, where you can view and modify the package contents. If you select the package.json file in the Project window, you can also modify its JSON values directly in the Inspector window.

Return to the main procedure to complete the creation of your package.