This section explains many of the concepts surrounding the Unity Package Manager functionality:
Multiple versions of each package are available, marking changes to that package along its life cycle. Every time a developer updates the package, they give it a new version number. A change in package version tells you whether it contains a breaking change (major), new backward-compatible functionality (minor), or bug fixes only (patch), following Semantic Versioning.
To view the list of versions available for a specific package, see Finding a specific version.
There are two types of manifest files:
<project>/Packages
directory. The Package Manager uses it to configure many things, including a list of dependencies for that project, as well as any package repository to query for packages. More infomanifest.json
) store information that the Package Manager needs to locate and load the right packages, including a list of packages and versions declared as dependenciespackage.json
) store information about a specific package, and a list of packages and versions that the package requires.Both files use JSON (JavaScript Object Notation) syntax.
In the domain of Unity’s Package Manager, a package registry is a server that stores package contents and information (metadata) on each package version. Unity maintains a central registry of official packages that are available for distribution. By default, all projects use the official Unity package registry, but you can add additional registries to store and distribute private packages or stage custom packages while you are developing them.
The Unity Package Manager is a tool that manages the entire package system. Its primary tasks include the following:
The Unity Package Manager installs samples, tools, and assets on a per-project basis, rather than installing them across all projects for a specific machine or device. It uses a global cache to store downloaded package metadata and contents. Once installed in a project, Unity treats package assets just like any other asset in the project, except that these assets are stored inside the package folder and are immutableYou cannot change the contents of an immutable (read-only) package. This is the opposite of mutable. Most packages are immutable, including packages downloaded from the package registry or by Git URL.
See in Glossary. You can only permanently change content from Local and Embedded package sources.
After developing a package to the point where it is ready for Unity users to test it and provide feedback, a package enters the Preview state. Packages in this state usually appear in the Unity Editor with the preview label and often use preview
as part of their version.
Unity’s release management only grants a package the verified status after it passes several testing stages and validation procedures, which also include checks for appropriate documentation, changelog, and license files. Packages in this state may appear in the Unity Editor with the 2019.4 verified label and never use preview
as part of their version.
If the package developer introduces changing or breaking changes to a package (either by introducing a change that breaks an API or affects its usage), that package returns to the Preview state and the Package Manager does not suggest the new preview package as a possible update for the verified version.
These states indicate where the package is in the development cycle:
State | Description |
---|---|
Custom | The package developer creates the package. Usually this corresponds to having the package embedded in the developer’s project. |
Preview | When the package is ready for testing, the Unity package developer makes sure there is some basic test coverage, and that the package passes testing with the package validation suite. The package also needs at least preliminary documentation, an updated changelog, and licensing before the Unity package developer can apply to publish the package on Unity’s official package registry. At this point, the package is available for testing, so that any eligible Unity user can provide the developer with feedback. Most packages are available to any Unity users, although a few packages are limited to Unity IDs with specific entitlements. Preview packages can go through many changes before they are ready to be verified for a specific version of Unity. At some point in the future, they might pass the verification requirements; however, they might also be deprecated instead. Because there is no guarantee for future support, you should not use preview packages in production. For a list of preview packages available for this version, see Preview packagesA preview package is in development and not yet ready for production. A package in preview might be at any stage of development, from the initial stages to near completion. See in Glossary . |
Verified | The package has undergone rigorous testing and has been verified to work safely with this specific version of Unity, and all other packages verified for the same version. This state is only for packages that Unity develops internally. Contact third-party package developers to ask about their specific processes. When a package is verified for a version of Unity, Unity guarantees to support that verified package for the duration of that version of Unity, throughout the period of long-term support, and does not allow any major or minor updates (that is, changes that break or change an API). With each new version of Unity, each verified package must go through the verification process again before the Package Manager considers it verified. To see a list of packages that are verified for this version of Unity, see Verified packagesWhen a package passes release cycle testing for a specific version of Unity, it receives the Verified For designation. This means that these packages are guaranteed to work with the designated version of Unity. See in Glossary . Note: Some packages are neither verified nor preview packages. In many cases, this is because a package was verified in a previous version of Unity but has not completed the verification process yet for the current version. For a few packages, they were published to the Unity Package Manager registry because they were considered safe to use, but were never verified. In both of these cases, these packages are safe to use in production. |
The Package Manager window displays a tagA reference word which you can assign to one or more GameObjects to help you identify GameObjects for scripting purposes. For example, you might define and “Edible” Tag for any item the player can eat in your game. More info
See in Glossary
that corresponds to some of these states.
Sources describe where the package came from:
Source | Description |
---|---|
Registry | The Unity Package Manager downloads most packages from a package registry server into a global cache on your computer as you request them. These packages are immutable, so you can use them in your project, but you cannot modify them or change their package manifests. |
Built-in | These packages allow you to enable or disable Unity features (for example, Terrain Physics, Animation, etc.). They are immutable. For more information, see 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 . |
Embedded | Any package stored inside your project folder is embedded. This source corresponds with the Custom state because you typically put all the scripts, libraries, samples, and other assets your new package needs in a folder under your project folder when you begin development on a custom package. |
Local | You can install a package from any folder on your computer (for example, if you have cloned a development repository locally). |
Tarball (local) | You can install a package from a tarball file on your computer. The Package Manager extracts the package from the tarball and stores it in the cache. However, these packages are immutable, unlike installations from a local folder. |
Git | The Package Manager installs Git-based packages directly from a Git repository instead of from the package registry server. |
To edit the package manifest for a package, see Inspecting packages.
The Package Manager window displays a tag that corresponds to some of these sources. For more information, see Tags.
Note: The Package Manager stores packages that you download from the Asset StoreA growing library of free and commercial assets created by Unity and members of the community. Offers a wide variety of assets, from textures, models and animations to whole project examples, tutorials and Editor extensions. More info
See in Glossary
in a cache which is separate from the global cache. See Asset Store packages for more information.
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.