Unity는 패키지 매니페스트 파일(package.json)을 사용하여 특정 패키지의 특정 버전에 대한 정보를 관리합니다. 패키지 매니페스트는 항상 패키지의 루트에 있으며 등록 이름, 버전 번호 등 패키지에 대한 중요한 정보를 포함합니다.
또한 패키지 매니페스트는 다음과 같이 사용자와 통신하는 데 유용한 정보도 정의합니다.
패키지 매니페스트는 JSON(JavaScript Object Notation) 구문을 사용하여 패키지 내부에 있는 내용을 설명합니다. 파일의 포맷은 npm의 package.json 포맷과 유사하지만 일부 프로퍼티에는 다른 시맨틱을 사용합니다. 샘플 패키지 매니페스트 파일의 예시를 참조하십시오.
패키지 관리자는 이 매니페스트를 읽고 패키지의 콘텐츠, 패키지 콘텐츠의 압축 해제 방법, 패키지 관리자 창에 표시할 정보를 확인합니다. 매니페스트는 이 정보를 일련의 필수, 권장, 선택적 프로퍼티에 저장합니다.
이러한 프로퍼티가 없으면 패키지가 퍼블리시될 때 레지스트리가 거부하거나 패키지 관리자가 패키지를 가져오거나 로드할 수 없습니다.
| 프로퍼티 | JSON 유형 | 설명 |
|---|---|---|
| name | 문자열 | 역순 도메인 이름 표기법을 사용하는 Unity 패키지 관리자 명명 규칙을 준수하는 고유 식별자입니다. 명명 규칙에 대한 자세한 내용은 패키지 명명을 참고하십시오. 참고: name 식별자는 패키지 관리자 창의 리스트 패널에 표시되는 사용자가 알기 쉬운 표시 이름과 다릅니다. |
| version | 문자열 |
"major.minor.patch" 포맷을 사용하는 패키지 버전 번호입니다. 예를 들어 "3.2.1"은 세 번째 메이저 릴리스, 두 번째 마이너 릴리스, 첫 번째 패치임을 나타냅니다. 이 값은 시맨틱 버전 지정을 준수해야 합니다. 자세한 내용은 버전 지정을 참조하십시오. |
패키지 관리자는 권장 프로퍼티에 값이 누락되거나 유효하지 않은 값이 있는 경우에도 프로젝트에 패키지를 설치할 수 있습니다.
그러나 권장되는 베스트 프랙티스는 이러한 프로퍼티에 값을 할당하여 패키지를 검색할 수 있고 사용자에게 더 나은 경험을 제공하는 것입니다.
| 프로퍼티 | JSON 유형 | 설명 |
|---|---|---|
| description | 문자열 | 패키지에 대한 간략한 설명입니다. 이 텍스트는 패키지 관리자 창의 세부 정보 패널에 표시됩니다. 이 필드는 UTF–8 문자 코드를 지원합니다. 즉, 줄바꿈(\n) 및 글머리 기호(\u25AA) 같은 특수 포맷 문자 코드를 사용할 수 있습니다. |
| displayName | 문자열 | Unity 에디터(예: 프로젝트 창, 패키지 관리자 창 등)에 표시되는 알기 쉬운 이름입니다. Unity 타임라인, ProBuilder, 인앱 구매를 displayName 값의 예시로 들 수 있습니다. |
| unity | 문자열 | 패키지가 호환되는 최저 Unity 버전을 나타냅니다. 생략된 경우 패키지 관리자는 패키지를 모든 Unity 버전과 호환되는 것으로 간주합니다. 예상되는 포맷은 "major.minor"(예: "2018.3")입니다. Unity 6 이상 버전은 동일한 "####.#" 포맷을 따릅니다. 예를 들어 Unity 6의 기술 버전 번호는 "6000.0"입니다.특정 패치를 가리키려면 옵션 프로퍼티에 설명된 unityRelease 프로퍼티도 포함합니다.참고: Unity와 호환되지 않는 패키지는 패키지 관리자 창에 표시되지 않습니다. |
이러한 프로퍼티는 선택 사항이므로 생략할 수 있습니다. 그러나 존재하는 경우 유효한 값이 있어야 합니다.
| 프로퍼티 | JSON 유형 | 설명 |
|---|---|---|
| author | 객체 또는 문자열 | 패키지의 작성자입니다. 이 프로퍼티는 한 명의 작성자만 지원합니다. 이 프로퍼티에는 하나의 필수 필드인 name과 두 개의 선택 필드인 email 및 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 | 문자열 | URL로 지정된 이 패키지의 변경 기록 커스텀 위치입니다. 예시:"changelogUrl": "https://example.com/changelog.html"참고: 패키지 관리자가 해당 URL 위치에 도달할 수 없는 경우(예: 네트워크 문제가 있음) 다음 작업을 수행합니다. - 패키지가 설치된 경우 패키지 관리자가 패키지 캐시에 CHANGELOG.md 파일을 표시하는 파일 브라우저를 엽니다. - 패키지가 설치되어 있지 않은 경우 패키지 관리자가 오프라인 변경 로그를 사용할 수 없다는 경고를 표시합니다. |
| dependencies | 객체 | 패키지 종속성의 맵입니다. 키는 패키지 이름이고 값은 특정 버전입니다. 이 패키지가 종속되는 다른 패키지를 식별합니다. 참고: 패키지 관리자는 범위 구문을 지원하지 않으며, SemVer 버전만 지원합니다. |
| documentationUrl | 문자열 | URL로 지정된 이 패키지 문서의 커스텀 위치입니다. 예시:"documentationUrl": "https://example.com/"참고: 패키지 관리자가 해당 URL 위치에 도달할 수 없는 경우(예: 네트워크 문제가 있음) 다음 작업을 수행합니다. - 패키지가 설치된 경우 패키지 관리자가 패키지 캐시에 Documentation~ 폴더를 표시하는 파일 브라우저를 엽니다. - 패키지가 설치되어 있지 않은 경우 패키지 관리자가 오프라인 문서를 사용할 수 없다는 경고를 표시합니다. |
| hideInEditor | 부울 | 기본적으로 프로젝트 창은 패키지 에셋을 숨기고 인스펙터 창에서 오브젝트 피커를 사용할 때 이를 결과에서 생략합니다. 이 프로퍼티를 "false"로 설정하면 이 패키지의 에셋이 항상 표시됩니다. |
| keywords | 문자열 배열 | 패키지 관리자 검색 API에서 사용하는 키워드의 배열입니다. 사용자가 관련 패키지를 찾는 데 도움이 됩니다. |
| license | 문자열 |
SPDX 식별자 포맷을 사용하는 OSS 라이선스의 식별자 또는 ‘LICENSE.md 파일 참조’ 같은 문자열입니다. 참고: 패키지 매니페스트에서 이 프로퍼티를 생략하면 패키지에 LICENSE.md 파일이 포함되어야 합니다. |
| licensesUrl | 문자열 | 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 | 문자열 | 내부용으로 활용됨. |
| unityRelease | 문자열 | 패키지가 호환되는 특정 Unity 릴리스를 나타내는 Unity 버전의 일부입니다. 이 프로퍼티는 Unity 알파/베타 개발 사이클 중에 업데이트된 패키지를 변경해야 하는 경우에 사용할 수 있습니다. 패키지에 새로 도입된 API가 필요하거나 API 업데이터 규칙 없이 이전 버전과 호환되지 않는 방식으로 변경된 기존 API를 사용하는 경우가 이에 해당할 수 있습니다. 예상되는 포맷은 "<update><release>(예: "0b4")입니다. 참고: 권장되는 unity 프로퍼티를 생략하면 이 프로퍼티는 영향을 미치지 않습니다. Unity와 호환되지 않는 패키지는 패키지 관리자 창에 표시되지 않습니다. |
{
"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"
}
}