You can specify a dependency as any local folder or tarball that contains a package. This feature is helpful for local offline development and testing.
Note: If you want to reference a package on the local file system as a Git dependency, use the file://<url>
format instead. Unity doesn’t support directly referencing a locally accessible Git repository with a file path. For more information on the file://<url>
format, refer to Git dependenciesThe Package Manager retrieves Git dependencies from a Git repository directly rather than from a package registry. Git dependencies use a Git URL reference instead of a version, and there’s no guarantee about the package quality, stability, validity, or even whether the version stated in its package.json
file respects Semantic Versioning rules with regards to officially published releases of this package. More info
See in Glossary.
This section describes how to use the project manifestEach Unity project has a project manifest, which acts as an entry point for the Package Manager. This file must be available in the <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 info
See in Glossary to set up a local dependency. If you want to use the Package Manager window instead, follow the instructions on these pages:
The path reference always begins with the file:
prefix, and uses forward slashes (/
) for path separators.
Note: On Windows, you can also use backslashes (\
), but only if you escape each one (for example, "file:..\\github\\my_package_folder"
or "file:C:\\Users\\my_username\\github\\my_package_folder"
). These paths aren’t as easy to read as the forward slashes, they’re prone to typing errors, and you can’t use them anywhere but on a Windows machine. For these reasons, using forward slashes is preferable.
You can use either absolute paths, or paths that are relative to the project’s Packages
folder (that is, the root folder of the project manifest). In other words, a path preceded with two dots (..
) refers to the root of the project path, so that ../another_folder
is a sibling of the Packages
folder.
Tip: Relative paths with forward-slashes offer better portability across different machines and operating systems when tracking a project and packages in the same repository.
For Windows absolute paths, the drive letter and its colon (usually C:
) follows the file:
prefix but is otherwise the same as Linux or macOS paths.
After the file:
prefix, the path is a standard relative path. In the following example:
Packages
folder is C:\Users\my_username\Projects\my_project\Packages
.Projects
, github
, and Downloads
folders are peer folders.my_package_c
is an embedded packageAn embedded package is a mutable package that you store under the Packages
directory at the root of a Unity project. This differs from most packages which you download from a package server and are immutable. More infoPackages
folder, to make it mutable).{ "dependencies": { "my_package_a": "file:../github/my_package_folder", "my_package_b": "file:../Downloads/my_package_tarball.tgz" "my_package_c": "file:com.unity.textmeshpro" } }
After the file:
prefix, the path is a standard Portable Operating System Interface (POSIX) path, starting with a forward slash /
:
{ "dependencies": { "my_package_a": "file:/Users/my_username/github/my_package_folder", "my_package_b": "file:/Users/my_username/Downloads/my_package_tarball.tgz" } }
Notice that the drive letter immediately follows the file:
prefix:
{ "dependencies": { "my_package_a": "file:C:/Users/my_username/github/my_package_folder", "my_package_b": "file:C:/Users/my_username/Downloads/my_package_tarball.tgz" } }
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.