Unity는 패키지 매니페스트 파일(package.json)을 사용하여 특정 패키지의 특정 버전에 관한 정보를 관리합니다. 패키지 매니페스트는 항상 패키지의 루트에 위치하며, 패키지에 관한 중요 정보(예: 등록 이름, 버전 숫자 등)를 담고 있습니다. 또한 UI에 표시되는 사용자 친화적 이름, 패키지에 대한 간략한 설명, 패키지와 호환되는 가장 낮은 Unity 버전 등과 같이 사용자에게 전달할 유용한 정보를 정의합니다.
패키지 매니페스트는 JSON(JavaScript Object Notation) 구문을 사용하여 패키지 콘텐츠를 설명합니다. 파일의 포맷은 npm의 package.json 포맷과 유사하지만, 일부 속성에 대해 다른 시맨틱을 사용합니다.
패키지 관리자는 이 매니페스트를 판독하여 패키지 콘텐츠, 콘텐츠 언패킹 방법, Package Manager 창에서 사용자에게 표시할 정보를 알아낼 수 있습니다. 매니페스트는 이러한 정보를 일련의 필요, 필수 및 옵션 속성에 저장합니다.
꼭 필요한 속성입니다. 이러한 속성이 없으면 패키지가 퍼블리시될 때 레지스트리가 해당 패키지를 거부하거나, 패키지 관리자가 패키지를 페치하거나 로드할 수 없습니다.
| 속성 | JSON 타입 | 설명 |
|---|---|---|
| name | String | 공식적으로 등록되는 패키지 이름입니다. 이 이름은 역순 도메인 이름 표기법을 사용하는 Unity 패키지 관리자 명명 규칙을 준수해야 합니다. 이름은 다음 사항을 충족해야 합니다. - com.<company-name>으로 시작합니다. - 에디터에 표시되도록 50자 이하로 지정합니다. 그 외에는 214자 이하입니다. - 소문자, 숫자, 하이픈(-), 밑줄(_), 마침표(.)만 포함합니다. - 중첩된 네임스페이스를 표시하기 위해 네임스페이스의 끝에 추가 마침표를 붙입니다. 예를 들어 com.unity.timeline은 Unity에서 타임라인을 구현하는 패키지 이름입니다. 참고: 이 이름은 고유 식별자이며, Package Manager 창의 리스트 뷰에 나타나는 사용자 친화적 이름이 아닙니다. |
| version | 문자열 | 패키지 버전 숫자(**’MAJOR.MINOR.PATCH“**)입니다. 이 값은 시맨틱 버전 지정을 준수해야 합니다. 자세한 내용은 패키지 버전을 참조하십시오. 예를 들어 ”3.2.1"은 세 번째 메이저 릴리스, 두 번째 마이너 릴리스, 그리고 첫 번째 패치임을 나타냅니다. |
기술적으로는 선택 사항인 속성입니다. 패키지 관리자는 값이 유효하지 않거나 누락된 경우에도 프로젝트에 이 속성을 여전히 설치할 수 있습니다. 하지만 패키지를 쉽게 찾고 패키지 소비자들에게 뛰어난 경험을 제공하려면 이 속성에 값을 지정하는 것이 좋습니다.
| 속성 | JSON 타입 | 설명 |
|---|---|---|
| displayName | String | Unity 에디터에 표시되는 사용자 친화적 이름입니다(예: 프로젝트 브라우저의 Package Manager 창 등). 예: Unity Timeline, ProBuilder, In App Purchasing |
| description | String | 패키지에 대한 간략한 설명입니다. 이 텍스트는 Package Manager 창의 세부 정보 뷰에 나타납니다. UTF–8 문자 코드가 지원됩니다. 즉, 줄바꿈(\n), 불릿(\u25AA) 등과 같은 특수 포매팅 문자 코드를 사용할 수 있습니다. |
| unity | String | 패키지와 호환 가능한 가장 낮은 Unity 버전을 표시합니다. 누락되면 패키지는 모든 Unity 버전과 호환된다고 간주됩니다. 예상되는 포맷은 “<MAJOR>.<MINOR>”(예: 2018.3)입니다. 특정 패치를 가리키려면 unityRelease 속성을 함께 사용하십시오. 참고: Unity와 호환되지 않는 패키지는 Package Manager 창에 나타나지 않습니다. |
선택 사항인 속성입니다. 즉, 생략할 수 있지만, 포함할 경우 유효한 값을 지정해야 합니다.
| 속성 | JSON 타입 | 설명 |
|---|---|---|
| unityRelease | String | 패키지가 호환 가능한 특정 Unity 릴리스를 나타내는 Unity 버전의 구성 요소입니다. 이 속성은 업데이트된 패키지에 Unity 알파/베타 개발 사이클 동안 적용된 변경 사항이 필요할 때 사용할 수 있습니다(예: 새로 도입된 API가 필요하거나 API 업데이터 규칙이 적용되지 않은 비하위호환 방식으로 변경된 기존 API를 사용하는 경우). 예상되는 포맷은 “<UPDATE><RELEASE>”(예: 0b4)입니다. 참고: unity 속성을 생략하면 이 속성은 아무 효과도 발휘하지 않습니다. Unity와 호환되지 않는 패키지는 Package Manager 창에 나타나지 않습니다. |
| dependencies | 오브젝트 | 패키지 종속성 맵입니다. 키는 패키지 이름이고 값은 특정 버전입니다. 이 패키지가 기반하는 다른 패키지를 나타냅니다. 참고: 이 패키지 관리자는 범위 구문을 지원하지 않으며 SemVer 버전만 지원합니다. |
| keywords | 문자열 배열 | 패키지 관리자가 API를 검색할 때 사용하는 키워드 배열입니다. 사용자가 적절한 패키지를 찾는 데 도움이 됩니다. |
| type | String | 패키지 관리자에 추가 정보를 제공하는 상수입니다. 내부 사용으로 예약되어 있습니다. |
| author | 오브젝트 | 패키지의 작성자입니다. 이 오브젝트에는 하나의 필수 필드(name)와 두 개의 옵션 필드(email 및 url)가 들어 있습니다. 예를 들어 다음과 같습니다. { "name" : "John Doe","email" : "john.doe@example.com","url" : "http://john.doe.example.com/"}
|
{
"name": "com.unity.example",
"version": "1.2.3",
"displayName": "Package Example",
"description": "This is an example package",
"unity": "2019.1",
"unityRelease": "0b5",
"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"
}
}
패키지 버전은 시맨틱 버전 지정(SemVer)을 준수해야 합니다. SemVer는 패키지 작성자가 기본 버전 대비 특정 버전에 포함된 변경 사항 타입에 관한 정보를 자동화 툴이 사용할 수 있는 포맷으로 제공하도록 해주는 버전 전략입니다.
SemVer는 버전을 MAJOR.MINOR.PATCH로 표기하고 다음 가이드라인을 사용하여 호환성에 대한 정의를 제공합니다.
| 값 증분: | 해당 조건: | 예제: |
|---|---|---|
| MAJOR | 최소 하나의 대규모 변경 사항이 있습니다. 패키지의 버전은 다른 버전으로 대체될 수 없습니다. |
1.2.3 버전과 2.0.0 버전은 호환 가능하지 않지만, 안전하게 서로 교체하여 사용할 수 있습니다. |
| MINOR(MAJOR 값과 동일) | 가장 높은 MINOR 값은 이전 버전과 호환되는 방식으로 기능을 도입합니다. | 1.3.0 버전은 이전 버전과 호환되므로 1.3.0 버전을 사용하여 1.2.0에 대한 종속성을 충족할 수 있습니다. 1.2.0을 사용하여 1.3.0에 대한 종속성을 충족할 수는 없습니다. |
| PATCH(MAJOR.MINOR 값과 동일) | 가장 높은 PATCH 값은 API의 변경 없이 이전 버전과 호환되는 방식으로 버그 수정을 도입합니다. | 1.3.0 버전과 1.3.1 버전은 둘 다 동일한 API를 가지고 있으므로 교체하여 사용할 수 있습니다. 단, 1.3.1에는 1.3.0에는 없는 버그 수정이 포함되어 있습니다. |
이러한 버전 지정 방식을 따르면 패키지 관리자가 충돌을 자동으로 해결(가능한 경우)하거나 패키지를 이전 버전과 호환되는 신규 버전으로 업그레이드할 수 있습니다.
자세한 내용은 시맨틱 버전 지정 웹 사이트를 참조하십시오.