Создание примеров для пакетов

Unity · Версия 2020.3 LTS · Manual

Создание примеров для пакетов

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

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

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

  1. Поместите файлы ресурсов или примеры файлов кода C# в папку Samples~. В пакете может быть несколько образцов: каждая вложенная папка папки Samples~ содержит один образец.
  2. Добавьте объект JSON для каждого образца в массив samples в вашем package.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

Включите образцы в манифест

Добавьте массив JSON в файл package.json с именем samples. Для каждого примера добавьте объект JSON, содержащий как минимум displayName и path, в папку с примерами:

Значение: Описание:
displayName Имя образца, отображаемое в сведениях о пакете в окне диспетчера пакетов.
description Краткое описание того, что образец демонстрирует или содержит. Это только для манифеста пакетаКаждый пакет имеет манифест, который предоставляет информацию о пакете для Менеджер пакетов. Манифест содержит такую информацию, как имя пакета, его версия, описание для пользователей, зависимости от других пакетов (если есть) и другие подробности. Дополнительная информация
См. в Словарь
. Описание не отображается в интерфейсе даже в виде всплывающей подсказки.
path Путь от папки Samples~ до корневой папки образца.

Например, используя ту же структуру, что и в примере для Расположение файлов примеров, раздел samples будет выглядеть похоже на это:

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

Обновлено 17 ноября 2026 г.