从 2019.1 开始,您可以将示例添加到资源包中。示例可能是一段示例代码、一些着色器和纹理、一些动画,或者您通常可以在项目的 Assets
文件夹下找到的任何其他文件。
当用户打开 Package Manager 窗口并选择包含示例的资源包时,资源包中每个示例的详细信息窗格中将出现 Import 按钮。当用户单击 Import 按钮时,Package Manager 会将该示例的整个子文件夹结构复制到项目的 Assets
文件夹下。
要将示例添加到您的资源包中,请执行以下操作:
将资源文件或 C#示例代码文件放置 Samples~
文件夹下。一个资源包可包含多个示例:Samples~
文件夹的每个子文件夹分别包含一个示例。
Note: The tilde character (~
) tells Unity to ignore the contents the Samples~
folder. Such folders aren’t tracked with .meta
files.
在您的 package.json
清单文件中的 samples
数组下为每个示例添加一个 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 数组添加到名为 samples
的 package.json
文件。对于每个示例,将至少包含 displayName
和 path
的 JSON 对象添加到示例文件夹:
值: | 描述: |
---|---|
displayName |
在 Package Manager 窗口中,将出现在资源包详细信息中的示例的名称。 |
description |
A brief description of what the sample demonstrates or contains. This is just for the package manifest. The description doesn’t appear in the interface, even as a tooltip. |
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"
}
]
}