Unity 패키지 생성 가이드
이 문서는 Unity에서 커스텀 패키지를 만드는 방법에 대한 가이드를 제공합니다. 패키지는 Unity의 공식 패키지 관리 시스템을 통해 쉽게 설치, 배포 및 관리할 수 있는 재사용 가능한 컴포넌트입니다.
패키지의 구성
패키지는 다음과 같은 요소를 포함할 수 있습니다: - C# 스크립트 - 어셈블리 - 네이티브 플러그인 - 모델, 텍스처, 애니메이션 및 오디오 클립 등의 에셋
참고: 패키지 관리자는 패키지의 스트리밍 에셋을 지원하지 않으므로, 어드레서블 패키지를 사용하는 것이 좋습니다.
각 패키지는 패키지 이름, 버전, 종속성, 저장소 URL 등의 정보가 담긴 패키지 매니페스트 파일을 포함합니다.
패키지 생성 절차
새 패키지를 만들기 위해 다음 단계를 따르세요:
- 빈 셸 생성:
- 내장된 패키지를 설정하거나,
- 로컬 패키지를 설정합니다.
- 패키지 레이아웃 확인:
- 프로젝트 폴더 구조가 Unity 패키지의 레이아웃 규칙을 준수하는지 확인합니다.
- 예를 들어, Editor 및 Runtime 라이브러리를 포함하는 경우, 각각의 폴더 아래에 저장되어야 합니다.
- 어셈블리 정의 파일 확인:
- 패키지에 코드가 포함된 경우 요구되는 어셈블리 정의 파일이 존재하는지 확인합니다.
- 필요한 에셋 추가:
- 패키지에 필요한 툴과 라이브러리 및 에셋을 추가합니다.
- 테스트 추가:
- 모두 적합한 시나리오에서 의도한 대로 작동하는지 확인하기 위해 테스트를 포함합니다.
- 모든 에디터 테스트는
Tests/Editor폴더, 플레이 모드 테스트는Tests/Runtime폴더에 작성합니다. - CHANGELOG.md 업데이트:
- 새 버전을 퍼블리시할 때마다 CHANGELOG.md 파일을 업데이트하여 모든 새로운 기능이나 버그 수정을 기록합니다.
- 라이선스 포함:
- LICENSE.md 및 THIRD PARTY NOTICES.md 파일에 라이선스와 타사 공지를 포함합니다.
- 문서화:
- 패키지의 상세한 사용법 및 API를 문서화합니다.
- 패키지 공유:
- 패키지를 다른 사용자와 공유하고자 할 경우, 패키지의 package.json 매니페스트 파일을 설정하여 외부 웹페이지 링크를 제공합니다.
커스텀 패키지 예제
내장 패키지 생성 예제
- Unity Hub에서 빈 프로젝트를 생성합니다.
- 프로젝트 폴더에서
Packages디렉토리로 이동합니다. - 패키지 이름과 일치하는 하위 디렉토리를 생성합니다.
- 예:
com.example.mypackage - 루트에
package.json파일 생성 후 필수 및 권장 필드를 채웁니다.
로컬 패키지 생성 예제
- 파일 관리자에서 패키지를 위한 폴더를 생성합니다.
- 패키지 폴더의 루트에
package.json파일을 생성합니다. - 필수 및 권장 필드를 채우고,
name속성이 명명 규칙을 따르는지 확인합니다. - Unity에서 새 프로젝트를 열고 패키지 관리자 창을 통해 로컬 패키지를 설치합니다.
유용한 팁
- 패키지의
package.json매니페스트 파일에 있는changelogUrl,licensesUrl,documentationUrl프로퍼티를 설정하여 외부 리소스 링크를 추가할 수 있습니다. - 패키지의 가독성을 높이기 위해 간단한 README 파일을 포함하는 것이 좋습니다.
이 가이드를 통해 Unity 내에서 패키지를 효과적으로 생성하고 관리하는 데 도움이 되길 바랍니다. 추가적인 질문이 있으시면 Unity 커뮤니티 포럼 또는 튜토리얼에서 도움을 받을 수 있습니다.