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.
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:

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

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:

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"
        }
    ]
}

• Samples for custom packages added in 2019.1 NewIn20191