Unity はパッケージ マニフェストファイル (package.json) を使用して、特定のパッケージの特定のバージョンに関する情報を管理します。パッケージマニフェストは常にパッケージのルートにあり、登録名とバージョン番号などのパッケージに関する重要な情報が含まれています。また、ユーザーと通信するための有用な情報を定義します。例えば、UI に表示されるユーザーにわかりやすい表示名、パッケージの簡単な説明、パッケージと互換性のある Unity の最も古いバージョンなどが含まれます。
パッケージマニフェストは JSON (JavaScript Object Notation) 構文を使用してパッケージに含まれるものを記述します。ファイル形式は npm の package.json 形式に似ていますが、一部のプロパティには異なるセマンティクスを使用します。
Package Manager はこのマニフェストを読み取り、 パッケージの内容、 パッケージの解凍方法、Package Manager ウィンドウでユーザーに表示する情報を見つけます。マニフェストはこの情報を一連の必須、必要、オプション のプロパティとして保存します。
これらのプロパティは必須です。これらが存在しない場合は、公開されたときにレジストリがパッケージを拒否するか、Package Manager がパッケージを見つけたりロードすることができません。
| プロパティ | JSON 型 | 説明 |
|---|---|---|
| name | 文字列 | 正式に登録されたパッケージ名。この名前は、逆ドメイン名表記を使用する Unity Package Manager の命名規則に準拠している必要があります。命名規則の詳細については、パッケージの命名 を参照してください。 ノート: これは一意の識別子であり、Package Manager ウィンドウのリストビューに表示される ユーザーにわかりやすい表示名 ではありません。 |
| version | 文字列 | パッケージのバージョン番号 (MAJOR.MINOR.PATCH)。 例えば、“3.2.1” は 3 番目のメジャーリリースの 2 番目のマイナーリリースで最初のパッチであることを示しています。 この値は セマンティックバージョニング に準拠する必要があります。詳しくは、バージョン管理を参照してください。 |
これらのプロパティは技術的にはオプションであり、有効な値が含まれていない場合や欠落している場合でも、プロジェクトにインストールすることができます。ただし、パッケージを見つけやすくし、 ユーザーにより良い体験を提供するために、これらのプロパティの値を設定する必要があります。
| プロパティ | JSON 型 | 説明 |
|---|---|---|
| description | 文字列 | パッケージの簡単な説明。これは、Package Manager ウィンドウの 詳細ビューに表示されるテキストです。すべての UTF–8 文字コードがサポートされます。つまり、改行 (\n) や箇条書き (\u25AA) などの特殊な形式の文字コードを使用できます。 |
| displayName | 文字列 | Unity エディター (例えば、Project ブラウザー、Package Manager ウィンドウなど) に表示されるユーザーに分かりやすい名前。 例えば、Unity Timeline、ProBuilder、In App Purchasing。 |
| unity | 文字列 | パッケージが互換性を持つ最低の Unity バージョンを示します。これを設定しないと、パッケージはすべての Unity バージョンと互換性があると仮定されます。 書式は、“<メジャー>.<マイナー>” (例えば 2018.3)。特定のパッチを示すには、unityRelease プロパティを使用します。 ノート: Unity に互換性がないパッケージは、Package Manager ウィンドウに表示されません。 |
これらのプロパティは任意であり、省略することができます。ただし、設定する場合は、有効な値である必要があります。
| プロパティ | JSON 型 | 説明 |
|---|---|---|
| author | オブジェクト | パッケージの作者。 このオブジェクトには、1 つの必須のフィールド (name) と 2 つのオプションのフィールド (email と url)が含まれます。 例 { "name" : "John Doe","email" : "john.doe@example.com","url" : "http://john.doe.example.com/"}
|
| changelogUrl | 文字列 | URL で指定したパッケージの変更ログのカスタムの保存場所。以下はその例。"changelogUrl":"https://example.com/changelog.html"ノート: Package Manager が URL の場所に到達できない場合 (ネットワークの問題など) は、以下を行います。 - パッケージがインストールされている場合、ファイルブラウザーを開き、パッケージキャッシュ内の CHANGELOG.md ファイルを表示します。- パッケージがインストールされていない場合、Package Manager はオフラインの変更ログが利用できないという警告を表示します。 |
| dependencies | オブジェクト | パッケージの依存関係のマップ。キーはパッケージ名で、値は特定のバージョンです。それらは、このパッケージが依存する他のパッケージを示します。 ノート: Package Manager は範囲の構文をサポートせず、 SemVer バージョンのみをサポートします。 |
| documentationUrl | 文字列 | URL で指定したパッケージのドキュメントのカスタムの保存場所。以下はその例。"documentationUrl": "https://example.com/"ノート: Package Manager が URL の場所に到達できない場合 (ネットワークの問題など) は、以下を行います。 - パッケージがインストールされている場合、ファイルブラウザーを開き、パッケージキャッシュ内の Documentation~ フォルダーを表示します。- パッケージがインストールされていない場合、Package Manager はオフラインドキュメントが利用できないという警告を表示します。 |
| hideInEditor | ブーリアン | 通常、Package Manager はほとんどのパッケージを自動的に隠しますが (暗示的な値は “true”)、このプロパティを “false” に設定することで、パッケージとそのアセットが常に表示されるようになります。 |
| keywords | 文字列の配列 | Package Manager の検索 API によって使用されるキーワードの配列。これは、ユーザーが関連するパッケージを見つけるのに役立ちます。 |
| license | 文字列 |
SPDX 識別子形式 を使用した OSS ライセンスの識別子、または “See LICENSE.md file” のような文字列。ノート: パッケージマニフェストでこのプロパティを省略すると、パッケージには LICENSE.md ファイルを加える必要があります。 |
| licensesUrl | 文字列 | URL で指定したパッケージのライセンス情報の保存場所。以下はその例。"licensesUrl": "https://example.com/licensing.html"ノート: Package Manager が URL の場所に到達できない場合 (ネットワークの問題など) は、以下を行います。 - パッケージがインストールされている場合、ファイルブラウザーを開き、パッケージキャッシュ内の LICENSE.md ファイルを表示します。- パッケージがインストールされていない場合、Package Manager はオフラインライセンス情報が利用できないという警告を表示します。 |
| samples | オブジェクトの配列 | パッケージに含まれるサンプルのリスト。各サンプルには、表示名、説明、Samples~ フォルダー自体から始まるサンプルフォルダーへのパスが含まれています。{"displayName": "<name-to-appear-in-the-UI>","description": "<brief-description>","path": "Samples~/<sample-subfolder>"}詳しい説明は、パッケージ用のサンプルの作成 を参照してください。 |
| type | 文字列 | Package Manager に追加情報を与える定数。 内部使用のために予約されています。 |
| unityRelease | 文字列 | パッケージに互換性のある特定の Unity のリリースを示す Unity バージョンの一部。このプロパティは、更新されたパッケージが Unity のアルファ/ベータの開発サイクルで行われた変更を必要とする場合に使用できます (例えば、新しく導入された API が必要な場合や、API アップデーターのルールなしに後方互換性のない方法で変更された既存の API を使用している場合など)。 予想される形式は“<UPDATE><RELEASE>” (例えば 0b4)。 ノート: unity プロパティを省略しても特に影響はありません。 Unity に互換性がないパッケージは、Package Manager ウィンドウ に表示されません。 |
{
"name": "com.unity.example",
"version": "1.2.3",
"displayName": "Package Example",
"description": "This is an example package",
"unity": "2019.1",
"unityRelease": "0b5",
"documentationUrl": "https://example.com/",
"changelogUrl": "https://example.com/changelog.html",
"licensesUrl": "https://example.com/licensing.html",
"dependencies": {
"com.unity.some-package": "1.0.0",
"com.unity.other-package": "2.0.0"
},
"keywords": [
"keyword1",
"keyword2",
"keyword3"
],
"author": {
"name": "Unity",
"email": "unity@example.com",
"url": "https://www.unity3d.com"
}
}