Unity uses a package manifest file (package.json) to manage information about a specific version of a specific package. The package manifest is always at the root of the package and has crucial information about the package, such as its registered name and version number.
The package manifest also defines useful information to communicate to the user, such as:
The package manifest uses the JSON (JavaScript Object Notation) syntax to describe what’s inside the package. The file’s format is similar to npm’s package.json format, but uses different semantics for some of its properties. Refer to the example for a sample package manifest file.
The Package Manager reads this manifest to find out the package’s contents, how to unpack its contents, and what information to display the user in the Package Manager window. The manifest stores this information in a series of required, recommended, and optional properties.
If these properties aren’t present, either the registry refuses the package when it’s published, or the Package Manager can’t fetch or load the package.
| プロパティ | JSON 型 | 説明 |
|---|---|---|
| name | 文字列 | A unique identifier that conforms to the Unity Package Manager naming convention, which uses reverse domain name notation. For more information about the naming convention, refer to Naming your package. Note: The name identifier is different than the user-friendly name that appears in the list view in the Package Manager window. |
| version | 文字列 | The package version number (MAJOR.MINOR.PATCH). For example, “3.2.1” indicates that this is the 3rd major release, the 2nd minor release, and the first patch. This value must respect Semantic Versioning. For more information, refer to Versioning. |
The Package Manager can install packages in a project even if the recommended properties don’t have valid values or are missing.
However, the recommended best practice is to assign values for these properties to ensure that your package is discoverable and to offer a better experience for users.
| プロパティ | JSON 型 | 説明 |
|---|---|---|
| description | 文字列 | A brief description of the package. This is the text that appears in the details view of the Package Manager window. This field supports UTF–8 character codes. This means that you can use special formatting character codes, such as line breaks (\n) and bullets (\u25AA). |
| displayName | 文字列 | A user-friendly name to appear in the Unity Editor (for example, in the Project Browser, the Package Manager window, etc.). For example, Unity Timeline, ProBuilder, In App Purchasing. |
| unity | 文字列 | Indicates the lowest Unity version the package is compatible with. If omitted, the Package Manager considers the package compatible with all Unity versions. The expected format is “<MAJOR>.<MINOR>” (for example, 2018.3). To point to a specific patch, use the unityRelease property as well. Note: A package that isn’t compatible with Unity doesn’t appear in the Package Manager window. |
These properties are optional, meaning that you can omit them. However, if they’re present, they must have a valid value.
| プロパティ | JSON 型 | 説明 |
|---|---|---|
| author | Object or string | The author of the package. This property has one required field, name, and two optional fields, email and url. You can specify these fields as a JSON object, or collapse them into a single string whose key is author. Object example: {"name" : "John Doe","email" : "john.doe@example.com","url" : "http://john.doe.example.com/"} String example: "John Doe <john.doe@example.com> (http://john.doe.example.com/)"
|
| changelogUrl | 文字列 | Custom location for this package’s changelog specified as a URL. For example:"changelogUrl": "https://example.com/changelog.html"Note: When the Package Manager can’t reach the URL location (for example, if there is a network issue), it does the following: - If the package is installed, the Package Manager opens a file browser displaying the CHANGELOG.md file in the package cache. - If the package isn’t installed, the Package Manager displays a warning that an offline changelog isn’t available. |
| dependencies | オブジェクト | A map of package dependencies. Keys are package names, and values are specific versions. They identify other packages that this package depends on. Note: The Package Manager doesn’t support range syntax, only SemVer versions. |
| documentationUrl | 文字列 | Custom location for this package’s documentation specified as a URL. For example:"documentationUrl": "https://example.com/"Note: When the Package Manager can’t reach the URL location (for example, if there is a network issue), it does the following: - If the package is installed, the Package Manager opens a file browser displaying the Documentation~ folder in the package cache. - If the package isn’t installed, the Package Manager displays a warning that offline documentation isn’t available. |
| hideInEditor | ブーリアン | By default, a package’s assets are hidden in the Project window and omitted from the results when you use the Object Picker in the Inspector window. Set this property to “false” to make sure that this package’s assets are always visible. |
| keywords | 文字列の配列 | Package Manager の検索 API によって使用されるキーワードの配列。これは、ユーザーが関連するパッケージを見つけるのに役立ちます。 |
| license | 文字列 |
SPDX 識別子形式 を使用した OSS ライセンスの識別子、または “See LICENSE.md file” のような文字列。ノート: パッケージマニフェストでこのプロパティを省略すると、パッケージには LICENSE.md ファイルを加える必要があります。 |
| licensesUrl | 文字列 | Custom location for this package’s license information specified as a URL. For example:"licensesUrl": "https://example.com/licensing.html"Note: When the Package Manager can’t reach the URL location (for example, if there is a network issue), it does the following: - If the package is installed, it opens a file browser displaying the LICENSE.md file in the package cache. - If the package isn’t installed, the Package Manager displays a warning that offline license information isn’t available. |
| samples | オブジェクトの配列 | List of samples included in the package. Each sample has a display name, a description, and the path to the sample folder starting at the Samples~ folder itself:{"displayName": "<name-to-appear-in-the-UI>","description": "<brief-description>","path": "Samples~/<sample-subfolder>"}For more information, refer to Creating samples for packages. |
| type | 文字列 | Package Manager に追加情報を与える定数。 内部使用のために予約されています。 |
| unityRelease | 文字列 | Part of a Unity version indicating the specific release of Unity that the package is compatible with. You can use this property when an updated package requires changes made during the Unity alpha/beta development cycle. This might be the case if the package needs newly introduced APIs, or uses existing APIs that have changed in a non-backward-compatible way without API Updater rules. The expected format is “<UPDATE><RELEASE>” (for example, 0b4). Note: If you omit the recommended unity property, this property has no effect. A package that isn’t compatible with Unity doesn’t appear in the Package Manager window. |
{
"name": "com.[company-name].[package-name]",
"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.[company-name].some-package": "1.0.0",
"com.[company-name].other-package": "2.0.0"
},
"keywords": [
"keyword1",
"keyword2",
"keyword3"
],
"author": {
"name": "Unity",
"email": "unity@example.com",
"url": "https://www.unity3d.com"
}
}