---
title: 为包创建样本
product: Unity Editor
version: '6000.0'
latest_version: '7000.0'
status: This page documents version 6000.0. The latest version is 7000.0.
canonical: https://docs.unity.com/zh-cn/engine/6000.0/manual/packages-list/cus-pkg-development/cus-samples
latest_url: https://docs.unity.com/zh-cn/engine/7000.0/manual/packages-list/cus-pkg-development/cus-samples.md
last_updated: 2026-10-30
generated_at: 2026-11-18T10:57:37.620Z
locale: zh-cn
---

# 为包创建样本

> 包含可选样本，可帮助Users学习包和导入示例内容。

从 Unity Editor 版本 2019.1 开始，您可以向包添加样本。样本可以是示例代码、一些着色器和 Textures、一些动画或通常在 Project 的 `Assets` Folder 下查找的任何其他文件。

当您 Open Package Manager 窗口并选择包含样本的包时，包中的每个样本的[细节面板](/engine/6000.0/manual/packages-list/upm-ui-window/upm-ui-details.md)中都会显示一个**导入**按钮。当您选择**导入**时，包管理器会将该样本的整个子文件夹结构复制到项目的 `Assets` Folder 下。

要向包添加样本：

1. 将资源文件或示例 C# 代码文件放[在 Samples\~ 文件夹下](#sample-subfolder)。一个包中可以有多个样本；`Samples~` Folder 的每个子文件夹都有一个样本。

   > **Note:**
   >
   > 倾斜角色 (`~`) 告诉 Unity 忽略 `Samples~` Folder 的内容。不会使用 `.meta` 文件跟踪此类文件夹。

2. 在`package.json`清单文件中的 `samples` Array 下为每个样本添加 [json Object](#sample-manifest)。

## 样本文件的位置##location-of-sample-files

您可以在包的 `Samples~` Folder 子文件夹下添加样本 Assets。例如，具有着色器样本的包可能如下所示：

```lang-plain
MyPackage
  ├── package.json
  └── Samples~
        ├── SamplesHDRP
        │ ├── Textures
        │    |     ├── MossyRock.bmp
        │    |     └── SandyRock.bmp
        │ └─ 着色器
        │ ├── 光照纹理混合 HDRPrGraph
        │          └── Lit Vertex Color HDRP.ShaderGraph
        └── SamplesStandard
        │ ├── Textures
        │    |     ├── MossyRock.bmp
        │    |     └── SandyRock.bmp
        │ └─ 着色器
        │          ├── StandardTextureBlend.shader
        │          └── StandardVertexColor.shader
        └── SamplesUniversalRP
             ├──Textures
             |     ├── MossyRock.bmp
             |     └── SandyRock.bmp
             └── Shader
                   ├──光照纹理混合 URP.ShaderGraph
                   └── Lit Vertex Color URP.ShaderGraph
```

## 在清单中包含样本##include-your-samples-in-the-manifest

将名为 `samples` 的 json Array 添加到 `package.json` 文件。对于每个样本，将至少包含`displayName`和`path`的 json Object 添加到样本文件夹：

| **密钥**        | **描述**                                       |
| ------------- | -------------------------------------------- |
| `displayName` | 在 包管理器 窗口中的细节细信息中显示的样本Name。                  |
| `description` | 样本演示或包含的内容的简要描述。这仅用于包清单。描述不会出现在界面中，甚至作为工具提示。 |
| `path`        | 从 `Samples~` Folder 到样本根 Folder 的路径。         |

例如，使用与[样本文件位置](#sample-subfolder)示例相同的结构，`samples`部分如下所示：

```lang-json
{
	"samples": [
		{
			"displayName":“HDRP 着色器”，
			"description": "包含高清渲染管道的样本着色器",
			"path":"Samples~/SamplesHDRP"
		},
		{
			"displayName":“URP 着色器”，
			"description": "包含通用渲染管道的样本着色器",
			"path":"Samples~/SamplesUniversalRP"
		},
		{
			"displayName":“标准 RP 着色器”，
			"description": "包含标准渲染管道的样本着色器",
			"path":"Samples~/SamplesStandard"
		}
	]
}
```
