Version: 2021.1
패키지용 샘플 생성
버전 지정

패키지 매니페스트

Unity는 패키지 매니페스트 파일(package.json)을 사용하여 특정 패키지의 특정 버전에 관한 정보를 관리합니다. 패키지 매니페스트는 항상 패키지의 루트에 위치하며, 패키지에 관한 중요 정보(예: 등록 이름, 버전 숫자 등)를 담고 있습니다. 또한 UI에 표시되는 사용자 친화적 이름, 패키지에 대한 간략한 설명, 패키지와 호환되는 가장 낮은 Unity 버전 등과 같이 사용자에게 전달할 유용한 정보를 정의합니다.

패키지 매니페스트는 JSON(JavaScript Object Notation) 구문을 사용하여 패키지 콘텐츠를 설명합니다. 파일의 포맷은 npmpackage.json 포맷과 유사하지만, 일부 프로퍼티에 대해 다른 시맨틱을 사용합니다.

패키지 관리자는 이 매니페스트를 판독하여 패키지 콘텐츠, 콘텐츠 언패킹 방법, Package Manager 창에서 사용자에게 표시할 정보를 알아낼 수 있습니다. 매니페스트는 이러한 정보를 일련의 필수, 의무옵션 프로퍼티에 저장합니다.

필수 프로퍼티

꼭 필요한 프로퍼티입니다. 이러한 프로퍼티가 없으면 패키지가 퍼블리시될 때 레지스트리가 해당 패키지를 거부하거나, 패키지 관리자가 패키지를 페치하거나 로드할 수 없습니다.

프로퍼티 JSON 타입 설명
name String 공식적으로 등록되는 패키지 이름입니다. 이 이름은 역순 도메인 이름 표기법을 사용하는 Unity 패키지 관리자 명명 규칙을 준수해야 합니다. 명명 규칙에 대한 자세한 내용은 패키지 명명을 참조하십시오.

참고: 이 이름은 고유 식별자이며, Package Manager 창의 리스트 뷰에 나타나는 사용자 친화적 이름이 아닙니다.
version 문자열 패키지 버전 숫자입니다(MAJOR.MINOR.PATCH).

예를 들어 “3.2.1”은 3번째 메이저 릴리스, 2번째 마이너 릴리스, 첫 번째 패치를 나타냅니다.

이 값은 시맨틱 버전 지정을 준수해야 합니다. 자세한 내용은 버전 지정을 참조하십시오.

의무 프로퍼티

기술적으로는 선택 사항인 프로퍼티입니다. 패키지 관리자는 값이 유효하지 않거나 누락된 경우에도 프로젝트에 이 속성을 여전히 설치할 수 있습니다. 하지만 패키지를 쉽게 검색하고 사용자에게 더 나은 경험을 제공하려면 이러한 프로퍼티에 값을 지정하는 것이 좋습니다.

프로퍼티 JSON 타입 설명
description String 패키지에 대한 간략한 설명입니다. 이 텍스트는 Package Manager 창의 세부 정보 뷰에 나타납니다. UTF–8 문자 코드가 지원됩니다. 즉, 줄바꿈(\n), 불릿(\u25AA) 등과 같은 특수 포매팅 문자 코드를 사용할 수 있습니다.
displayName String Unity 에디터에 표시되는 사용자 친화적 이름입니다(예: 프로젝트 브라우저의 Package Manager 창 등).

예: Unity Timeline, ProBuilder, In App Purchasing
unity String 패키지와 호환 가능한 가장 낮은 Unity 버전을 표시합니다. 누락되면 패키지는 모든 Unity 버전과 호환된다고 간주됩니다.

예상되는 포맷은 “<MAJOR>.<MINOR>”(예: 2018.3)입니다. 특정 패치를 가리키려면 unityRelease 프로퍼티를 함께 사용하십시오.

참고: Unity와 호환되지 않는 패키지는 Package Manager 창에 나타나지 않습니다.

옵션 프로퍼티

선택 사항인 프로퍼티입니다. 즉, 생략할 수 있지만, 포함할 경우 유효한 값을 지정해야 합니다.

프로퍼티 JSON 타입 설명
author 오브젝트 패키지의 작성자입니다.

이 오브젝트에는 하나의 필수 필드(name)와 두 개의 옵션 필드(emailurl)가 들어 있습니다.

예를 들어 다음과 같습니다.
{ "name" : "John Doe",
   "email" : "john.doe@example.com",
   "url" : "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 부울 일반적으로 패키지 관리자는 대부분의 패키지를 자동으로 숨기지만(묵시적 값은 “true”), 이 프로퍼티를 “false”로 설정하여 패키지와 해당 에셋을 항상 표시할 수도 있습니다.
keywords 문자열 배열 패키지 관리자가 API를 검색할 때 사용하는 키워드 배열입니다. 사용자가 적절한 패키지를 찾는 데 도움이 됩니다.
license String SPDX 식별자 포맷을 사용하는 OSS 라이선스의 식별자, 또는 “LICENSE.md 파일 참조”와 같은 문자열입니다.

참고: 패키지 매니페스트에서 이 프로퍼티를 생략하면 패키지는 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.unity.example",
  "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.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"
  }
}


패키지용 샘플 생성
버전 지정