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.
이러한 프로퍼티가 없으면 패키지가 퍼블리시될 때 레지스트리가 거부하거나, 패키지 관리자가 패키지를 페치하거나 로드할 수 없습니다.
| 프로퍼티 | JSON 타입 | 설명 |
|---|---|---|
| name | String | 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. |
패키지 관리자는 권장 프로퍼티에 유효한 값이 없거나 누락된 경우에도 프로젝트에 패키지를 설치할 수 있습니다.
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 | String | 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 | String | 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 | String | 패키지와 호환 가능한 가장 낮은 Unity 버전을 표시합니다. 누락되면 패키지 관리자는 모든 Unity 버전과 호환된다고 간주합니다. 예상되는 포맷은 “<MAJOR>.<MINOR>”(예: 2018.3)입니다. 특정 패치를 가리키려면 unityRelease 프로퍼티를 함께 사용하십시오. 참고: Unity와 호환되지 않는 패키지는 Package Manager 창에 나타나지 않습니다. |
선택 사항인 프로퍼티입니다. 즉, 생략할 수 있지만, 포함할 경우 유효한 값을 지정해야 합니다.
| 프로퍼티 | 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 | String | URL로 지정된 이 패키지의 변경 로그에 대한 커스텀 위치입니다. 예를 들면 다음과 같습니다."changelogUrl": "https://example.com/changelog.html"참고: 네트워크 문제 등으로 인해 패키지 관리자가 URL 위치에 도달할 수 없으면 다음을 수행합니다. - 패키지가 설치된 경우 패키지 관리자는 패키지 캐시에 CHANGELOG.md 파일을 표시하는 파일 브라우저를 엽니다. - 패키지가 설치되지 않은 경우 패키지 관리자는 오프라인 변경 로그를 사용할 수 없다는 경고를 표시합니다. |
| 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 | String | URL로 지정된 이 패키지의 문서에 대한 커스텀 위치입니다. 예를 들면 다음과 같습니다."documentationUrl": "https://example.com/"참고: 네트워크 문제 등으로 인해 패키지 관리자가 URL 위치에 도달할 수 없으면 다음을 수행합니다. - 패키지가 설치된 경우 패키지 관리자는 패키지 캐시에 Documentation~ 폴더를 표시하는 파일 브라우저를 엽니다. - 패키지가 설치되지 않은 경우 패키지 관리자는 오프라인 문서를 사용할 수 없다는 경고를 표시합니다. |
| 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 | 문자열 배열 | 패키지 관리자가 API를 검색할 때 사용하는 키워드 배열입니다. 사용자가 적절한 패키지를 찾는 데 도움이 됩니다. |
| license | String |
SPDX 식별자 포맷을 사용하는 OSS 라이선스의 식별자, 또는 “LICENSE.md 파일 참조”와 같은 문자열입니다.참고: 패키지 매니페스트에서 이 프로퍼티를 생략하면 패키지는 LICENSE.md 파일을 포함해야 합니다. |
| licensesUrl | String | URL로 지정된 이 패키지의 라이선스 정보에 대한 커스텀 위치입니다. 예를 들면 다음과 같습니다."licensesUrl": "https://example.com/licensing.html"참고: 네트워크 문제 등으로 인해 패키지 관리자가 URL 위치에 도달할 수 없으면 다음을 수행합니다. - 패키지가 설치된 경우 패키지 캐시에 LICENSE.md 파일을 표시하는 파일 브라우저를 엽니다. - 패키지가 설치되지 않은 경우 패키지 관리자는 오프라인 라이선스 정보 정보를 사용할 수 없다는 경고를 표시합니다. |
| 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 | String | 패키지 관리자에 추가 정보를 제공하는 상수입니다. 내부 사용으로 예약되어 있습니다. |
| unityRelease | String | 패키지가 호환 가능한 특정 Unity 릴리스를 나타내는 Unity 버전의 구성 요소입니다. 이 프로퍼티는 업데이트된 패키지가 Unity 알파/베타 개발 사이클 동안 적용된 변경 사항을 필요로 할 때 사용할 수 있습니다. 패키지에 새로 도입된 API가 필요하거나 패키지가 API 업데이터 규칙이 적용되지 않은 비하위호환 방식으로 변경된 기존 API를 사용하는 경우를 예로 들 수 있습니다. 예상되는 포맷은 “<UPDATE><RELEASE>”(예: 0b4)입니다. 참고: 권장 unity 프로퍼티를 생략하면 이 프로퍼티는 아무 효과도 발휘하지 않습니다. Unity와 호환되지 않는 패키지는 Package Manager 창에 나타나지 않습니다. |
{
"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"
}
}