Создание пользовательских пакетов

Руководство Unity 2020.3 (LTS)
Пакеты
Создание пользовательских пакетов

Менеджер пакетов Unity — это официальная система управления пакетами для Unity. Он делает следующее:

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

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

Общую информацию о том, что такое пакет и как работает диспетчер пакетов Unity, см. в разделе ПакетыПакеты — это наборы ресурсов, которыми можно делиться и повторно использовать в Unity. Диспетчер пакетов Unity (UPM) может отображать, добавлять и удалять пакеты из вашего проекта. Эти пакеты являются родными для менеджера пакетов Unity и обеспечивают фундаментальный метод предоставления функциональных возможностей Unity. Однако диспетчер пакетов Unity также может отображать пакеты Asset Store, загруженные из Asset Store. Подробнее
См. в документации Словарь.

Обзор

Пакеты могут содержать следующее:

Скрипты C#
Сборки
Нативные плагины
Модели, текстуры, анимация и аудиоклипыКонтейнер для аудиоданных в Unity. Unity поддерживает моно-, стерео- и многоканальные аудиоресурсы (до восьми каналов). Unity может импортировать форматы аудиофайлов .aif, .wav, .mp3 и .ogg, а также форматы модуля трекера .xm, .mod, .it и .s3m. Подробнее
См. в Словарь и других ресурсах.

Примечание. Диспетчер пакетов не поддерживает потоковую передачу ресурсов в пакетах. Вместо этого используйте пакет Addressables.

Каждый пакет также содержит манифест пакетаКаждый пакет имеет manifest, который предоставляет информацию о пакете диспетчеру пакетов. Манифест содержит такую информацию, как имя пакета, его версия, описание для пользователей, зависимости от других пакетов (если есть) и другие подробности. Подробнее
См. в файле Словарь, который включает такую информацию, как имя пакета, его версия, список его зависимостей и URL-адрес его репозитория.

Чтобы создать новый пакет:

Создайте пустую оболочку для пакета одним из следующих способов:
- Настройка встроенного пакета.
- Настройте локальный пакет.
Реализуйте свои инструменты, библиотеки и любые ресурсы, которые требуются вашему пакету.
Убедитесь, что макет вашего пакета соответствует соглашению о макетах пакетов для пакетов Unity.
Добавьте тесты в свой пакет. Тесты необходимы для обеспечения того, чтобы пакет работал должным образом в различных сценариях:
- Запишите все свои тесты редактора в Tests/Editor.
- Запишите все свои тесты Playmode в Tests/Runtime.
Переименуйте и обновите файлы определения сборки.
Добавьте образцы в свой пакет, если они у вас есть.

Примечание. Пакеты могут содержать только образцы, но вы также можете включать образцы как часть инструмента или пакета шаблонов, используя тот же макет и структуру JSON.
Вы можете обновлять файл CHANGELOG.md каждый раз, когда публикуете новую версию. Каждая новая функция или исправление ошибки должны иметь трассировку в этом файле. Дополнительные сведения о выбранном формате журнала изменений см. в документации Ведение журнала изменений.

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

Совет. Вы можете предоставить ссылку на внешнюю веб-страницу, на которой размещен журнал изменений этого пакета, используя свойство changelogUrl в вашем файл манифеста пакета package.json.
Вы можете включить лицензии и уведомления третьих сторон в LICENSE.md и файлы THIRD PARTY NOTICES.md.

Это необязательно для пакетов, которыми вы не делитесь, но настоятельно рекомендуется для общих пакетов, чтобы ваши пользователи не злоупотребляли вашими пакетами и не нарушали какие-либо сторонние лицензии.

Совет. Вы можете предоставить ссылку на внешнюю веб-страницу, на которой размещены уведомления о лицензировании этого пакета и сторонние уведомления, используя licensesUrl в файле манифеста вашего пакета package.json.
Задокументируйте свой пакет.

Совет. Вы можете предоставить ссылку на внешнюю веб-страницу, на которой размещена документация по этому пакету, используя свойство documentationUrl в вашем файл манифеста пакета package.json.
Поделитесь своим пакетом.

Создание нового встроенного пакета

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

Откройте Unity Hub и создайте пустой проект на своем компьютере.
Вы также можете использовать существующий проект на своем компьютере и встроить пакет в свой проект или установить пакет из локальной папки. Однако запуск нового проекта делает содержимое пакета менее подверженным ошибкам.
С помощью диспетчера файлов на компьютере (например, Проводника Windows или Finder macOS) перейдите в папку проекта и найдите вложенную папку Packages.
Создайте новую вложенную папку для вашего пакета в папке Packages, используя имя, совпадающее с именем пакета. . Например, если ваш пакет называется com.example.mypackage, вложенная папка также должна называться com.example.mypackage.

Примечание. Это особенно важно, если ваш пакет содержит ресурсы, потому что AssetDatabase ищет путь к ресурсу, который соответствует Packages//Assets, независимо от того, как называется фактическая папка.
Откройте предпочитаемый текстовый редактор и создайте файл JSON с именем package.json.
Сохраните его в созданной корневой папке нового пакета.
Заполните все обязательные и рекомендуемые поля в файле манифеста пакета (package.json).

При повторном открытии Unity новый пакет появляется в окне Диспетчера пакетов и в окне проекта. Окно, показывающее содержимое папки Assets (вкладка "Project") Подробнее
См. в Словарь, где можно просмотреть и изменить содержимое пакета. Если вы выберете файл package.json в окне "Project", вы также сможете изменить его содержимое непосредственно в Inspector. Окно Unity, в котором отображается информация о выбранном в данный момент игровом объекте, активе или настройках проекта, что позволяет просматривать и редактировать значения. Подробнее
См. в окне Словарь.

Создание нового локального пакета

Следуйте этим инструкциям, если вы хотите создать пользовательский пакет вне папки вашего проекта:

С помощью файлового менеджера на компьютере (например, Windows File Explorer или MacOS Finder) создайте папку для своего пакета.

Вы также можете использовать существующее местоположение, если вы уже создали контент для своего пакета.
Убедитесь, что макет структуры папок соответствует соглашению о макете пакетов для пакетов Unity. Например, если у вас есть библиотеки Editor и Runtime, убедитесь, что они хранятся в папках Editor и Runtime.
Откройте предпочитаемый текстовый редактор и создайте файл JSON с именем package.json.
Сохраните его в корневой папке пакета.
Заполните все обязательные и рекомендуемые поля в файле манифеста пакета (package.json).
В Unity создайте новый проект или откройте существующий.
Откройте окно Пакеты и следуйте инструкциям по установке локального пакета, используя Только что созданный файл package.json.

Новый пакет появляется в окне диспетчера пакетов и в окне проекта, где вы можете просматривать и изменять содержимое пакета. Если вы выберете файл package.json в окне «Project», вы также сможете изменить его содержимое непосредственно в окне «Inspector».

Пользовательские пакеты добавлены в Unity 2019.1 NewIn20191

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