|How do you use documentation throughout your workflow? Share your experience with us by taking this survey.|
This is the package layout recommended for custom packages:
<root> ├── package.json ├── README.md ├── CHANGELOG.md ├── LICENSE.md ├── Third Party Notices.md ├── Editor │ ├── Unity.[YourPackageName].Editor.asmdef │ └── EditorExample.cs ├── Runtime │ ├── Unity.[YourPackageName].asmdef │ └── RuntimeExample.cs ├── Tests │ ├── Editor │ │ ├── Unity.[YourPackageName].Editor.Tests.asmdef │ │ └── EditorExampleTest.cs │ └── Runtime │ ├── Unity.[YourPackageName].Tests.asmdef │ └── RuntimeExampleTest.cs ├── Samples~ │ ├── SampleFolder1 │ ├── SampleFolder2 │ └── ... └── Documentation~ └── [YourPackageName].md
Many official Unity packages also implement this structure.
||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, which defines the package dependencies
See in Glossary and other metadata.
||Developer package documentation. This is generally documentation to help developers who want to modify the package or push a new change on the package master source repository.|
||Description of package changes in reverse chronological order. It is good practice to use a standard format, like Keep a Changelog.|
||Contains the package license text. Usually the Package Manager copies the text from the selected SPDX list website.|
||Editor platform-specific Assets folder. Unlike Editor folders under Assets, this is only a convention and does not affect the Asset import pipeline. See Assembly definition and packages to properly configure Editor-specific assemblies in this folder.|
||Runtime platform-specific Assets folder. This is only a convention and does not affect the Asset import pipeline. See Assembly definition and packages to properly configure runtime assemblies in this folder.|
||Folder to store any tests included in the package.|
||Editor platform specific tests folder. See Assembly definition and packages to properly configure Editor-specific test assemblies in this folder.|
||Runtime platform specific tests. See Assembly definition and packages to properly configure runtime test assemblies in this folder.|
||Folder to store any samples included in the package.|
||Folder to store any documentation included in the package.|
Unity ignores the contents of any folder name that ends with the
~ character and does not track them with
.meta files. However, you need to include
.meta files for the
Tests folders and their contents in order for them to work properly. For more information on
.meta files and how Unity uses them for tracking, see Asset workflow.