The Unity Manual provides documentation for a specific version of Unity. For package documentation, each package has its own version, so each package provides documentation for a specific version of that package. For this reason, the package documentation isn’t part of the main Unity Manual documentation. Instead, documentation for each package lives on its own website on Unity’s documentation server.
To access the documentation for a specific package, you have two options:
When the package page opens, the top of the page has four links (A) and a drop-down menu (B) where you can select a different version:
Use the links at the top of the page to view the documentation for the package’s core usage (Manual), the package’s Scripting API documentation, the Changelog for the package, and the License information for the package.
Each version of the Unity Manual documentation provides a list of released and pre-release packages, a list of built-in packagesBuilt-in packages allow users to toggle Unity features on or off through the Package Manager. Enabling or disabling a package reduces the run-time build size. For example, most projects don’t use the legacy Particle System. By removing the abstracted package of this feature, the related code and resources are not part of the final built product. Typically, these packages contain only the package manifest and are bundled with Unity (rather than available on the package registry).
See in Glossary, and a list of packages by keyword. Each list has links to the matching package documentation which you can use with that version of Unity. Note: Only packages that are compatible with the version of Unity matching the documentation appear in these lists.
You can expand the entries in the sidebar navigation (A) to access specific information about each package. Information includes the list of compatible versions, a brief description of the package, and any associated keywords. Or you can click the link on the list pages (B) to directly open the most compatible version of that package documentation that matches the documentation version.
If you can’t find the package you want in this list, there might be several reasons:
You might be able to access the documentation through the Package Manager window for packages released in another version of Unity. For private packages, try to contact the developer directly to request access.
You can find out more about a package that comes from a registry (not Asset Store) by viewing its documentation, changelog, or license information.
To access any of these pages, you can click the Documentation, Changelog, or Licenses links from inside the Package Manager window.
To access the documentation for a specific package version:
Open the Package Manager window in Unity.
Follow the guidelines in Finding packages to locate the specific package and version number you want.
Click the Documentation link to open the documentation for the selected version of the package.
Note: If the package is installed, you can right-click the Documentation, Changelog, or Licenses links and select Open Locally. The Package Manager opens your file browser at the appropriate folder.
You can follow this procedure for any version of a package that comes from a registry (not Asset Store). Note that the documentation isn’t necessarily different for each package version release, because some version updates (patches) involve only bug fixes or trivial changes.
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.