← Пакеты и управление пакетами Шаг 243 из 281

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

Вы можете создавать образцы для включения в разрабатываемый вами пакет Unity Package Manager (UPM).

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

Когда вы открываете окно Package Manager и выбираете пакет, содержащий образцы, для каждого образца в пакете появляется кнопка Импорт в панели деталей пакета. Когда вы выбираете Импорт, Package Manager копирует всю структуру подпапок для этого образца в папку проекта Assets.

Чтобы добавить образцы в пакет:

Поместите файлы asset или кодовые файлы C# в папку Samples. В пакете может быть более одного образца. Каждая подпапка папки Samples содержит один образец.
Откройте файл манифеста пакета (package.json) для редактирования. Чтобы найти файл, см. Найдите файл манифеста.
Если файл не содержит массива JSON, называемого samples, добавьте его.
Для каждого образца, который вы хотите включить, добавьте объект JSON в массив samples.

Включите следующие ключи и значения для каждого объекта JSON в массив samples:

Ключ	Описание
`displayName`	Имя образца, как оно отображается в панели сведений о пакете окна Package Manager.
`description` (факультативно)	Краткое описание того, что демонстрирует или содержит образец. Это описание отображается на вкладке Образцы панели сведений о пакете окна Package Manager.
`path`	Путь к папке образца, начиная с `Samples`.

Убедитесь, что package.json содержит действительные JSON.. Вы можете проверить его действительность, используя онлайн-валидатор JSON или непосредственно в редакторе кода, если он поддерживает проверку синтаксиса JSON.
Сохраните файл.

Местоположение образцов файлов

Вы можете добавить образцы ассетов в подпапки папки Samples вашего пакета. Например, пакет с образцами шейдеров может выглядеть примерно так:

MyPackage
  ├── package.json
  └── Samples
        ├── SamplesHDRP
        │    ├── Textures
        │    |     ├── MossyRock.bmp
        │    |     └── SandyRock.bmp
        │    └── Shader
        │          ├── Lit Texture Blend HDRP.ShaderGraph
        │          └── Lit Vertex Color HDRP.ShaderGraph
        └── SamplesStandard
        │    ├── Textures
        │    |     ├── MossyRock.bmp
        │    |     └── SandyRock.bmp
        │    └── Shader
        │          ├── StandardTextureBlend.shader
        │          └── StandardVertexColor.shader
        └── SamplesUniversalRP
             ├── Textures
             |     ├── MossyRock.bmp
             |     └── SandyRock.bmp
             └── Shader
                   ├── Lit Texture Blend URP.ShaderGraph
                   └── Lit Vertex Color URP.ShaderGraph

Пример массива образцов в файле манифеста

Используя ту же структуру, что и в примере для Местоположение файлов примера, массив samples в package.json выглядит примерно так:

{
    "samples": [
        {
            "displayName": "HDRP Shaders",
            "description": "Contains sample shaders for the High Definition render pipeline",
            "path": "Samples/SamplesHDRP"
        },
        {
            "displayName": "Standard RP Shaders",
            "description": "Contains sample shaders for the Standard render pipeline",
            "path": "Samples/SamplesStandard"
        },
        {
            "displayName": "URP Shaders",
            "description": "Contains sample shaders for the Universal render pipeline",
            "path": "Samples/SamplesUniversalRP"
        }
    ]
}

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

При создании пакета с помощью Создание пакета функция, держите путь образцов в вашем package.json указывающие на Samples. Не добавляйте конечную тильду (~В ходе процесс экспорта, Unity переименует Samples папка в Samples~ автоматически, так что это скрыто в Packages папка Project окно. Вам не нужно настраивать значения пути для образцов в файле манифеста. Package Manager После того, как разработчики импортируют ваш образец, они могут найти его в папке Assets папка Project окно.

Дополнительные ресурсы

← Предыдущий шагСсылка на манифест пакета Следующий шаг →Добавить тесты в пакет