The Unity Package Manager is the official package management system for Unity. It does the following:
You can use the Package Manager to define project dependencies, resolve package dependencies, download packages, add packages, and integrate content in your projects.
For general information on what a package is and how the Unity Package Manager works, see the PackagesPackages are collections of assets to be shared and re-used in Unity. The Unity Package Manager (UPM) can display, add, and remove packages from your project. These packages are native to the Unity Package Manager and provide a fundamental method of delivering Unity functionality. However, the Unity Package Manager can also display Asset Store packages that you downloaded from the Asset Store. More info
See in Glossary documentation.
Packages can contain the following:
Note: Package Manager doesn’t support streaming assets in packages. Use the Addressables package instead.
Each package also contains a Package manifestEach package has a manifest, which provides information about the package to the Package Manager. The manifest contains information such as the name of the package, its version, a description for users, dependencies on other packages (if any), and other details. More info
See in Glossary file that includes information such as the package name, its version, a list of its dependencies, and the URL to its repository.
To create a new package:
Create an empty shell for the package using one of these methods:
Make sure the layout of your folder structure follows the package layout convention for Unity packages. For example, if you have Editor and Runtime libraries, make sure you store them under the Editor
and Runtime
folders.
If your package includes code, make sure the package layout you created has the necessary assembly definition files. For information about creating and defining assembly definition files, see Assembly definition and packages. For additional information, see Assembly definitions.
Note: If the console windowA Unity Editor window that shows errors, warnings and other messages generated by Unity, or your own scripts. More info
See in Glossary reports a warning after adding an assembly definition file, save your project, close it, then reopen it.
Add your tools, libraries, and any assets your package requires.
Add tests to your package. Tests are essential for ensuring that the package works as expected in different scenarios:
Tests/Editor
.Tests/Runtime
.If you have samples for your package, add them to the proper samples subfolder.
Note: Packages can contain only samples, but you can also include samples as part of a tool or template package using the same layout and JSON structure.
You can update the CHANGELOG.md
file every time you publish a new version. Every new feature or bug fix should have a trace in this file. For more details on the chosen changelog format, see the Keep a Changelog documentation.
This step is optional for packages that you don’t share, but strongly recommended for shared packages, so that users know which version best suits their needs.
Tip: You can provide a link to an external web page where you host this package’s changelog by setting the changelogUrl property in your package’s package.json
manifest file.
You can include licenses and third-party notices in the LICENSE.md
and THIRD PARTY NOTICES.md
files.
This step is optional for packages that you don’t share, but strongly recommended for shared packages, so that your users don’t misuse your packages or violate any third-party licenses.
Tip: You can provide a link to an external web page where you host this package’s licensing and third-party notices by setting the licensesUrl property in your package’s package.json
manifest file.
Document your package.
Tip: You can provide a link to an external web page where you host this package’s documentation by setting the documentationUrl property in your package’s package.json
manifest file.
Share your package.
Follow these instructions if you want to create a custom package inside your project folder.
Note: These instructions are part of the larger procedure for Creating custom packages.
Open the Unity Hub, and create an empty project on your computer.
You can also use an existing project on your computer, and embed the package under your project or install the package from a local folder. However, starting with a new project makes the package contents less prone to errors.
Using your computer’s file manager (for example the Windows File Explorer or the macOS Finder), navigate to your project folder and locate the Packages
subdirectory.
Create a new subdirectory for your package inside the Packages
folder using a name that matches the package name and follows the naming conventions. For example, if your package name is com.example.mypackage
, create a subdirectory called com.example.mypackage
.
Note: This is particularly important if your package contains assets, because the AssetDatabase looks for an asset path that matches Packages/<your-package-name>/Assets
, regardless of the actual folder name.
Open your preferred text editor and create a JSON file called package.json
in the root of the package folder.
Fill out all required and recommended fields in the package.json
file. You can use the package manifest example as a reference.
When you reopen Unity, the new package appears in the Package Manager window and in the Project windowA window that shows the contents of your Assets
folder (Project tab) More info
See in Glossary, where you can view and modify the package contents. If you select the package.json
file in the Project window, you can also modify its JSON values directly in the InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
See in Glossary window.
Return to the main procedure to complete the creation of your package.
Follow these instructions if you want to create a custom package outside your project folder.
Note: These instructions are part of the larger procedure for Creating custom packages.
Using your computer’s file manager (for example the Windows File Explorer or the macOS Finder), create a folder for your package.
You can also use an existing location if you’ve already created some content for your package.
Open your preferred text editor and create a JSON file called package.json
in the root of the package folder.
Fill out all required and recommended fields in the package.json
file, making sure the name
property follows the naming conventions. You can use the package manifest example as a reference.
In Unity, create a new project or open an existing project.
Open the Package Manager window and follow the instructions for installing a local package, using the package.json
file you just created. This step is essential for ensuring the creation of the required .meta
file.
The new package appears in the Package Manager window and in the Project window, where you can view and modify the package contents. If you select the package.json
file in the Project window, you can also modify its JSON values directly in the Inspector window.
Return to the main procedure to complete the creation of your package.
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.