Embedded dependencies
Embed a package in your project to make it mutable.
Read time 3 minutesLast updated 25 days ago
Any package that appears under your project's folder is embedded in that project. You can create an embedded package in several ways:
Packages- Create a new package directly in your project's folder.
Packages - Manually copy a Unity package from the project's package cache into your project's folder.
Packages - Use a C# script to embed a version of a package that's already installed.
Embedded packages don't need to appear in the project manifest as a dependency. However, if you embedded a version of an installed package, your project manifest still lists the dependency on the original installed version. In that case, the package on disk takes priority over the version of the package listed as a dependency, so it doesn't need to be removed from the project manifest. For example, if the project manifest specifies a dependency on version 1.3.1 of the package but the project also has an embedded package with that name, the Package Manager uses the embedded package, regardless of its apparent version, instead of downloading version 1.3.1 from the registry.
com.unity.exampleMake sure you track the contents of your embedded packages, and any changes you make to it. If your Unity project is under source control, add any packages embedded in that project to the same source control.
Creating a new custom package
To embed a new package, create your new package content inside a folder under the folder. For more information, follow the instructions for creating your own custom package.
PackagesTypically, your new package remains embedded in your project until you are ready to share it with other users and test it in other projects. You can use different methods to share your package, for example, you can host the package on a scoped registry.
Copying a Unity package from the cache
A package installed from a registry is immutable, which means you can't edit it. If you want to edit a package, you can make it mutable by copying it to the subfolder in your folder. This package type is called an embedded package, and it overrides what's in your package cache. Later, you can delete that embedded package's folder from the subfolder, and the Package Manager will automatically change to the immutable, cached package.
PackagesProjectsPackagesImportant
Unity supports the following procedure for creating an embedded package only. Accessing the package cache folder for any other purpose is discouraged and not supported by Unity. Don't manipulate the contents of the package cache folder.
To find your package's folder in the cache, locate the installed version directly in the Unity Editor:
-
Open the Project window by opening the Window menu and selecting General > Project.
-
From the Project window, find the installed package you want to embed.
-
Right-click the folder of the selected package and select Show in Explorer (Windows) or Reveal in Finder (macOS). That package's folder opens directly in a file browser and uses thenaming convention.
<package-name>@<fingerprint>
File browser opened to the package folder under the project's package cache
-
Copy the package folder and paste it directly into your project'ssubfolder, not the
Packagesroot folder. Don't put it inside thePackagesfolder, because the Package Manager doesn't scan that folder for packages.Assets -
Remove thepart of the folder name.
@<fingerprint> -
Add the newly embedded package to source control if your project is already under source control.
If you want to delete the embedded package, use your file browser or command line to locate that package in your folder. Consider backing up the folder for the embedded package, otherwise you'll lose any changes you made to the package. Then, delete the folder for that package from your folder. The Package Manager will automatically revert to the immutable, cached package.
PackagesPackages