Finding package documentation

The Unity Manual provides documentation for a specific version of Unity. 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 micro-site on Unity’s documentation server.

To access the documentation for a specific package, you have two options:

• Get documentation for the latest version (from the Unity Manual).
• Get documentation for a specific package version (from the Package Manager window).

When the package page opens, you can see four links at the top of the page.

To switch back and forth between the Manual documentation, the Scripting API documentation, the Changelog, and the License information for this package, click the corresponding link at the top of the page.

Getting documentation for the latest version

Each version of the Unity Manual documentation provides a list of verified and preview packages, a list of built-in packages, and a list of keywords with 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 click the link in the list to open the latest version of that package documentation, where latest means the highest version generated. If you can’t find the package you want in this list, there might be several reasons:

• It isn’t released for this version of Unity.
• It is a preview package. The packages list includes only a limited number of preview packages.
• It is a private package. Some packages are not available to everyone because someone outside of Unity is developing them or because they are under a special license.

You might be able to access the documentation through the Package Manager window for packages released in another version of Unity. In the case of private packages, try to contact the developer directly to request access.

Getting documentation for a specific package version

You can find out more about a package by viewing its documentation, changelog, or license information.

To access any of these pages, you can click the View documentation, View changelog, or View licenses links from inside the Package Manager window.

To access the documentation for a specific package version:

1. Open the Package Manager window in Unity.

2. If you are looking for a preview package, select Show preview packages from the Advanced drop-down menu.

   

3. Select the package you want information for from the list on the left.

4. Expand the arrow to the left of the package in the list.

   A new row appears, displaying the See all versions link.

   

5. Click the See all versions link.

   A scrollable list appears with all available versions.

   

6. Click on another version to select it.

   The package details appear in the pane on the right.

   

   Notice the verified tag no longer appears in this example because version 1.2.4 of the TextMesh Pro package is not verified for Unity version 2019.1.

7. Click the View documentation link to open the documentation for the selected version of the package.

   

   NOTE: If you are offline when you click the View documentation link and the package is on your computer (that is, embedded or installed from a local folder), the Package Manager opens the first MD file it finds under the <package-root-folder>/Documentation~ folder in your default MD viewer. If the Package Manager installed the package from a server (that is, from a package registry server or a Git remote repository), the following message appears instead:

   

You can follow this procedure for any version of any package. Note that the documentation is not necessarily different for each package version release, since some version updates (patches) involve only bug fixes or trivial changes.