包含此页的版本:
不含此页的版本:
这是推荐用于自定义包的包布局:
<package-root>
├── package.json
├── README.md
├── CHANGELOG.md
├── LICENSE.md
├── Third Party Notices.md
├── Editor
│ ├── <company-name>.<package-name>.Editor.asmdef
│ └── EditorExample.cs
├── Runtime
│ ├── <company-name>.<package-name>.asmdef
│ └── RuntimeExample.cs
├── Tests
│ ├── Editor
│ │ ├── <company-name>.<package-name>.Editor.Tests.asmdef
│ │ └── EditorExampleTest.cs
│ └── Runtime
│ ├── <company-name>.<package-name>.Tests.asmdef
│ └── RuntimeExampleTest.cs
├── Samples~
│ ├── SampleFolder1
│ ├── SampleFolder2
│ └── ...
└── Documentation~
└── <package-name>.md
许多官方 Unity 包也实现了这种结构。
| 位置 | 描述 |
|---|---|
package.json |
这包清单每个包都有一个清单,该清单向包管理器提供有关包的信息。清单包含包的名称、版本、用户说明、对其他包的依赖关系(如果有)以及其他详细信息等信息。更多信息 请参阅术语表,它定义了包依赖项和其他元数据。 |
README.md |
开发人员包文档。这通常是帮助想要更改包或在包的主分支上推送新更改的开发人员的文档。 |
CHANGELOG.md |
按时间倒序描述包更改。最好使用标准格式,例如保留变更日志。 |
LICENSE.md |
包含包许可证文本。通常,包管理器会从选定的 SPDX 列表网站复制文本。 |
Third Party Notices.md |
包含满足法律要求所需的信息。 |
Editor/ |
编辑器平台特定的 Assets 文件夹。与 Assets 下的 Editor 文件夹不同,这只是一种约定,不会影响 Asset 导入管道。请参阅程序集定义和包,在此文件夹中正确配置特定于编辑器的程序集。 |
Runtime/ |
特定于运行时平台的 Assets 文件夹。这只是一个约定,不会影响资产导入管道。请参阅程序集定义和包,以正确配置此文件夹中的运行时程序集。 |
Tests/ |
用于存储包中包含的任何测试的文件夹。 |
Tests/Editor/ |
编辑器平台特定测试文件夹。请参阅程序集定义和包,在此文件夹中正确配置特定于编辑器的测试程序集。 |
Tests/Runtime/ |
特定于运行时平台的测试。请参阅程序集定义和包,以正确配置此文件夹中的运行时测试程序集。 |
Samples~/ |
用于存储包中包含的任何样品的文件夹。 |
Documentation~ |
用于存储包中包含的任何文档的文件夹。 |
Unity 会忽略以字符结尾的任何文件夹名称的内容,并且不会使用~.meta文件。但是,您需要包括.meta文件的Editor,Runtime和Tests文件夹及其内容,以便它们正常工作。有关.meta文件以及 Unity 如何使用它们进行跟踪,请参阅资产工作流程。