Unity 패키지 매니페스트 설명서
이 문서는 Unity에서 사용하는 패키지 매니페스트 파일인 package.json에 대한 설명을 제공합니다. 패키지 매니페스트는 Unity 패키지의 정보를 관리하며, 패키지의 버전, 이름, 설명 등 다양한 정보를 포함합니다.
패키지 매니페스트란?
패키지 매니페스트 파일은 각 패키지의 루트에 위치하며, JSON 형식으로 작성되어 있습니다. 이 파일은 패키지의 주요 정보를 포함하고 있으며, Unity 에디터의 Package Manager에서 사용할 수 있도록 정보를 제공합니다.
필수 프로퍼티
패키지가 성공적으로 퍼블리시되기 위해 반드시 포함해야 할 프로퍼티입니다.
| 프로퍼티 | JSON 타입 | 설명 |
|---|---|---|
| name | String | 패키지의 고유한 식별자입니다. |
| version | String | 패키지 버전 번호(MAJOR.MINOR.PATCH)입니다. |
권장 프로퍼티
이 프로퍼티들은 선택 사항이지만, 포함할 경우 패키지의 검색 가능성과 사용자 경험을 향상시킵니다.
| 프로퍼티 | JSON 타입 | 설명 |
|---|---|---|
| description | String | 패키지에 대한 간략한 설명입니다. |
| displayName | String | Unity 에디터에서 보여줄 사용자 친화적 이름입니다. |
| unity | String | 패키지와 호환 가능한 가장 낮은 Unity 버전입니다. |
옵션 프로퍼티
선택적으로 포함할 수 있는 프로퍼티이며, 유효한 값을 지정해야 합니다.
| 프로퍼티 | JSON 타입 | 설명 |
|---|---|---|
| author | Object/String | 패키지의 작성자 정보입니다. |
| dependencies | Object | 패키지가 의존하는 다른 패키지들을 명시합니다. |
| documentationUrl | String | 패키지 문서의 URL입니다. |
매니페스트 예시
아래는 패키지 매니페스트의 예시입니다:
{ "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" } }
활용 및 응용 예제
- 패키지 업데이트: 패키지 매니페스트에서 버전 정보를 업데이트하여 새로운 기능이나 버그 수정을 쉽게 관리할 수 있습니다.
- 의존성 관리: 다른 패키지에 대한 의존성을 정의하여, 자동으로 필요한 패키지를 설치하고 호환성을 유지할 수 있습니다.
- 문서화 및 지원:
documentationUrl과changelogUrl을 사용하여 사용자에게 패키지 사용법 및 변경 사항을 쉽게 찾을 수 있도록 지원합니다.
추가 리소스
이 문서는 Unity 패키지 매니페스트 파일을 작성하는 데 필요한 기본 지식과 예제를 제공합니다. 각 프로퍼티의 용도와 중요성을 이해하고 적절하게 활용하면 보다 효율적으로 Unity 패키지를 관리할 수 있습니다.