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:
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.
Add a JSON object for each sample under the samples
array in your package.json
manifest file.
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
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"
}
]
}
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.