Рабочий процесс разработки пакета

Создайте свой собственный пакет Unity Package Manager (UPM) для расширения функциональности Unity Editor.

Вы можете использовать пакеты, которые вы создаете для одного из ваших проектов или для нескольких проектов. Вы также можете поделиться своим пакетом с другими в вашей организации или студии, чтобы они могли использовать его в любом проекте. Вы даже можете распространить свой пакет через официальные каналы, для более широкого сообщества для использования.

Следуйте этому рабочему процессу для создания полностью новых пакетов UPM. Информацию о модификации копий существующих пакетов см. в Копирование пакета Unity в папку проекта.

Чтобы создать свой собственный пакет UPM, выполните следующие задачи:

Создать структуру пакета.
Добавить код к вашему пакету.
Изменить определение сборки.
Изменить манифест пакета.
Создайте образцы для вашего пакета.
Добавить тесты в пакет.
Установить номер версии пакета.
Обновить журнал изменений для вашего пакета.
Добавить юридические требования к вашему пакету.
Документируйте свой пакет.

Предварительные условия

Перед началом работы определите, хотите ли вы создать пакет внутри или вне папки проекта. Дополнительные сведения см. в Сравнение мест создания пакетов.

Создание структуры пакета

Используйте функцию (+) > Создать пакет в Package Manager для создания структуры папок и стартовых файлов. Дополнительную информацию см. в Создание структуры пакета.

Добавить код к вашему пакету

Добавьте код, библиотеки и любые необходимые ресурсы, которые делают ваш пакет UPM уникальным. Дополнительные сведения см. в разделе Добавить код в пакет.

Изменение определения сборки

Любой код в вашем пакете должен быть организован в одну или несколько сборок с помощью файлов определения сборки (активов.asmdef). Unity создает отдельную сборку для каждого определения сборки, которая включает весь код в ее папке и подпапках.

Операция Package Manager Создать пакет создает эти определения сборки для вас, но вам может потребоваться изменить их по мере развития пакета.

Дополнительные сведения см. в Изменение определения сборки.

Изменение манифеста пакета

Манифест пакета (package.json) определяет метаданные для пакета UPM, включая его имя, версию, зависимости и другие детали конфигурации.

Операция Package Manager Создать пакет создает этот файл для вас, но он содержит минимальное количество требуемой информации. По мере развития вашего пакета, вам обычно нужно добавлять больше информации в манифест пакета.

Дополнительные сведения см. в разделе Изменение манифеста пакета.

Создание образцов для вашего пакета

Хотя включение образцов в ваш пакет необязательно, они являются ценным инструментом, помогающим пользователям узнать, как использовать ваш пакет.

Дополнительные сведения см. в Создание образцов для пакета.

Добавить тесты в пакет

Включение тестов в ваш пакет необязательно, но они полезны для проверки того, что ваш код работает так, как предполагается, и помогают другим безопасно проверять изменения.

Операция Создать пакет создает примерные тестовые файлы в соответствующей подпапке для вашего изменения.

Дополнительные сведения см. в Добавление тестов в пакет.

Установка номера версии пакета

Номер версии вашего пакета должен соответствовать принципам семантического версионирования.

Информацию о семантическом контроле версий и установке номера версии пакета см. в версионирование пакетов.

Обновление журнала изменений для вашего пакета

Обновляйте файл CHANGELOG.md каждый раз, когда вы публикуете новую версию пакета.

Дополнительные сведения см. в Обновление журнала изменений пакета.

Добавить юридические требования к вашему пакету

Ваш пакет может иметь юридические требования или элементы третьей стороны, которые вам нужно сообщить тем, кто потребляет его.

Для получения дополнительной информации, см. Добавление необходимых юридических файлов в пакет.

Документация вашего пакета

Включение документации в пакет необязательно, но предоставление четких рекомендаций поможет пользователям получить больше пользы и облегчит внедрение пакета.

Для получения дополнительной информации см. Документация пакета.