Version: 2022.3
Language : English
Adding tests to a package
Package manifest

Creating samples for packages

As of 2019.1, you can add samples to a package. A sample might be a piece of example code, some shadersA program that runs on the GPU. More info
See in Glossary
and textures, some animation, or any other files that you can usually find under the project’s Assets folder.

When a user opens the Package Manager window and selects a package containing samples, an Import button appears in the package’s details pane for each sample in the package. When the user clicks the Import button, the Package Manager copies the whole subfolder structure for that sample under the project’s Assets folder.

To add samples to your package:

  1. Put the asset files or example C# code files under the Samples~ folder. You can have more than one sample in a package: each subfolder of the Samples~ folder contains one sample.

    Note: The tilde character (~) tells Unity to ignore the contents the Samples~ folder. Such folders aren’t tracked with .meta files.

  2. Add a JSON object for each sample under the samples array in your package.json manifest file.

Location of sample files

You can add your sample assets under subfolders of the Samples~ folder of your package. For example, a package with shader samples might look something like this:

  ├── 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

Include your samples in the manifest

Add a JSON array to the package.json file called samples. For each sample, add a JSON object containing at least the displayName and the path to the samples folder:

Value: Description:
displayName The name of the sample as it appears in the package details on the Package Manager window.
description A brief description of what the sample demonstrates or contains. This is just for the package manifestEach package has a manifest, which provides information about the package to the Package Manager. The manifest contains information such as the name of the package, its version, a description for users, dependencies on other packages (if any), and other details. More info
See in Glossary
. The description doesn’t appear in the interface, even as a tooltip.
path The path from the Samples~ folder to the sample’s root folder.

For example, using the same structure as the example for Location of sample files, the samples section would look similar to this:

    "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"
Adding tests to a package
Package manifest
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。