Unity는 패키지 매니페스트 파일(package.json)을 사용하여 특정 패키지의 특정 버전에 대한 정보를 관리합니다.패키지 매니페스트는 항상 패키지의 루트에 있으며, 등록 이름 및 버전 번호와 같이 패키지에 대한 중요한 정보를 포함하고 있습니다.
또한 패키지 매니페스트는 다음과 같이 사용자와 통신하는 데 유용한 정보도 정의합니다.
패키지 매니페스트는 JSON(JavaScript Object Notation) 구문을 사용하여 패키지 콘텐츠를 설명합니다. 파일의 포맷은 npm의 package.json 포맷과 유사하지만, 일부 프로퍼티에 대해 다른 시맨틱을 사용합니다. 샘플 패키지 매니페스트 파일은 예시를 참조하십시오.
패키지 관리자는 이 매니페스트를 읽고 패키지 콘텐츠, 콘텐츠 언패킹 방법, Package Manager 창에서 사용자에게 표시할 정보를 알아낼 수 있습니다. 매니페스트는 이러한 정보를 일련의 필수, 권장 및 옵션 프로퍼티에 저장합니다.
이러한 프로퍼티가 없으면 패키지가 퍼블리시될 때 레지스트리가 거부하거나, 패키지 관리자가 패키지를 페치하거나 로드할 수 없습니다.
| 프로퍼티 | JSON 타입 | 설명 |
|---|---|---|
| name | String | 고유 식별자로, 역순 도메인 이름 표기법을 사용하는 Unity 패키지 관리자 명명 규칙을 준수해야 합니다. 명명 규칙에 대한 자세한 내용은 패키지 명명을 참조하십시오. 참고: name 식별자는 Package Manager 창의 목록 패널에 나타나는 사용자 친화적 표시 이름과 다릅니다. |
| version | String |
"major.minor.patch" 포맷을 사용하는 패키지 버전 번호. 예를 들어 "3.2.1"은 세 번째 메이저 릴리스, 두 번째 마이너 릴리스, 그리고 첫 번째 패치임을 나타냅니다. 이 값은 유의적 버전을 준수해야 합니다. 자세한 내용은 버전 지정을 참조하십시오. |
패키지 관리자는 권장 프로퍼티가 누락되었거나 잘못된 값을 포함하는 경우에도 프로젝트에 패키지를 설치할 수 있습니다.
그러나 권장되는 모범 사례는 이러한 프로퍼티에 값을 할당하여 패키지를 검색할 수 있도록 하고 사용자에게 더 나은 환경을 제공하는 것입니다.
| 프로퍼티 | JSON 타입 | 설명 |
|---|---|---|
| description | String | 패키지의 간단한 설명입니다. 이는 Package Manager 창의 세부 정보 패널에 나타나는 텍스트입니다. 이 필드에서는 UTF–8 문자 코드를 지원합니다. 따라서 줄바꿈(\n) 및 불릿(\u25AA)과 같은 특수 포맷의 문자 코드를 사용할 수 있습니다. |
| displayName | String | Unity 에디터에 표시되는 사용자 친화적 이름입니다(예: 프로젝트 창, Package Manager 창 등). displayName 값의 예시로는 Unity Timeline, ProBuilder, In App Purchasing이 있습니다. |
| unity | String | 패키지와 호환 가능한 가장 낮은 Unity 버전을 표시합니다. 생략된 경우 패키지 관리자는 패키지가 모든 Unity 버전과 호환된다고 간주합니다. 예상되는 포맷은 "major.minor"(예: "2018.3")입니다. 특정 패치를 가리키려면 옵션 프로퍼티에서 설명하는 unityRelease 프로퍼티도 포함하십시오.참고: Unity와 호환되지 않는 패키지는 Package Manager 창에 나타나지 않습니다. |
선택 사항인 프로퍼티입니다. 즉, 생략할 수 있지만, 포함할 경우 유효한 값을 지정해야 합니다.
| 프로퍼티 | JSON 타입 | 설명 |
|---|---|---|
| author | 오브젝트 또는 문자열입니다. | 패키지의 작성자입니다. 이 프로퍼티에는 이름이라는 필수 필드 하나와 이메일 및 url이라는 선택 필드 두 개가 있습니다. 이러한 필드를 JSON 객체로 지정하거나 키가 작성자인 단일 문자열로 축소할 수 있습니다. 객체 예시: {"name" :"John Doe","email" :"john.doe@example.com","url" :"http://john.doe.example.com/"} 문자열 예시: "John Doe <john.doe@example.com> (http://john.doe.example.com/)"
|
| changelogUrl | String | URL로 지정된 이 패키지의 변경 로그에 대한 커스텀 위치입니다. 예를 들면 다음과 같습니다."changelogUrl": "https://example.com/changelog.html"참고: 네트워크 문제 등으로 인해 패키지 관리자가 URL 위치에 도달할 수 없으면 다음을 수행합니다. - 패키지가 설치된 경우 패키지 관리자는 패키지 캐시에 CHANGELOG.md 파일을 표시하는 파일 브라우저를 엽니다. - 패키지가 설치되지 않은 경우 패키지 관리자는 오프라인 변경 로그를 사용할 수 없다는 경고를 표시합니다. |
| dependencies | 오브젝트 | 패키지 종속성의 맵입니다.키는 패키지 이름이고, 값은 특정 버전입니다.이 패키지가 종속된 다른 패키지를 식별합니다. 참고:패키지 관리자는 범위 구문을 지원하지 않으며, SemVer 버전만 지원합니다. |
| documentationUrl | String | 패키지의 기술 자료에 대한 커스텀 위치로, URL로 지정됩니다. 예:"documentationUrl": "https://example.com/"참고: 패키지 관리자를 통해 URL 위치로 이동할 수 없는 경우(예: 네트워크 문제) 다음을 수행합니다. - 패키지가 설치된 경우 패키지 관리자가 파일 브라우저를 열어 패키지 캐시의 Documentation~ 폴더를 표시합니다. - 패키지가 설치되지 않은 경우 패키지 관리자가 오프라인 기술 자료를 사용할 수 없다는 경고를 표시합니다. |
| hideInEditor | 부울 |
인스펙터 창에서 오브젝트 피커를 사용하는 경우 프로젝트 창에서는 기본적으로 패키지 에셋을 숨기고 결과에서 생략합니다. 패키지의 에셋이 항상 보이게 하려면 이 프로퍼티를 "false"로 설정합니다. |
| keywords | 문자열 배열 | 패키지 관리자가 API를 검색할 때 사용하는 키워드 배열입니다. 사용자가 적절한 패키지를 찾는 데 도움이 됩니다. |
| license | String |
SPDX 식별자 포맷을 사용하는 OSS 라이선스의 식별자, 또는 “Refer to LICENSE.md file”과 같은 문자열입니다. 참고: 패키지 매니페스트에서 이 프로퍼티를 생략하면 패키지는 LICENSE.md 파일을 포함해야 합니다. |
| licensesUrl | String | 패키지의 라이선스 정보에 대한 커스텀 위치로, URL로 지정됩니다. 예:"licensesUrl": "https://example.com/licensing.html"참고: 패키지 관리자를 통해 URL 위치로 이동할 수 없는 경우(예: 네트워크 문제) 다음을 수행합니다. - 패키지가 설치된 경우 패키지 관리자가 파일 브라우저를 열어 패키지 캐시에 LICENSE.md 파일을 표시합니다. - 패키지가 설치되지 않은 경우 패키지 관리자가 오프라인 라이선스 정보를 사용할 수 없다는 경고를 표시합니다. |
| samples | 오브젝트 배열 | 패키지에 포함된 샘플 목록입니다. 각 샘플에는 표시 이름, 설명, Samples~ 폴더에서 시작하는 샘플 폴더 경로가 포함됩니다.{"displayName": "<name-to-appear-in-the-UI>","description": "<brief-description>","path": "Samples~/<sample-subfolder>"}자세한 내용은 패키지용 샘플 생성을 참조하십시오. |
| 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"
}
}