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 and add packages as needed, 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. There are two types of packages supported in Unity: Asset packages and packages available through the Unity Package Manager (UPM). Packages available through the Unity Package Manager are a fundamental method of delivering Unity functionality. More info
See in Glossary documentation.
Packages can contain the following:
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 dependents, and the URL to its repository.
To create a new package:
Create an empty shell for the package using one of these methods:
Implement your tools, libraries, and any Assets your package requires.
Make sure the layout of your package follows the package layout convention for Unity packages.
Add tests to your package. Tests are essential for ensuring that the package works as expected in different scenarios:
Tests/Editor
.Tests/Runtime
.Rename and update the assembly definition files.
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 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.
You can include licenses and third-party notices in the LICENSE.md
and THIRD PARTY NOTICES.md
files.
This 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.
Share your package.
Follow these instructions if you want to create a custom package inside your Project folder.
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 it as a local package. 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
subfolder.
Create a new subfolder for your package inside the Packages
folder.
Open your preferred text editor and create a JSON file called package.json
.
Save it under the new package root folder you created.
Fill out all required and mandatory fields in the package manifest (package.json
) file.
When you reopen Unity, the new package appears in the Packages 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 contents directly in the InspectorA Unity window that displays information about the currently selected GameObject, Asset or Project Settings, alowing you to inspect and edit the values. More info
See in Glossary window.
Follow these instructions if you want to create a custom package outside your Project folder:
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.
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 they are stored under the Editor
and Runtime
folders.
Open your preferred text editor and create a JSON file called package.json
.
Save it under the package root folder.
Fill out all required and mandatory fields in the package manifest (package.json
) file.
In Unity, create a new Project or open an existing Project.
Open the Packages window and follow the instructions for installing a local package, using the package.json
file you just created.
The new package appears in the Packages 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 contents directly in the Inspector window.
2019–04–25 Page published with editorial review
Custom Packages added in Unity 2019.1 NewIn20191
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?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
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:
Thanks for helping to make the Unity documentation better!