Installing Project Auditor

July 17, 2023 ยท View on GitHub

There are several ways to install Project Auditor. Choose the most appropriate method based on your needs.

Note: To install Project Auditor for development purposes, go to this page instead.

Installing as read-only Package

At this time, Project Auditor is not discoverable via Package Manager. The installation process depends on your Unity version.

Version 2021.1 and later

To install this package, follow the instructions for adding a package by name in the Unity Editor. The package's name is com.unity.project-auditor.

Version 2020.3 and earlier

The package can be installed directly from its public Git repository. The instructions that follow are specific to Project Auditor, however, more information on how a package can be added to a project as a dependency from Git, you can check the Package Manager documentation.

The easiest way to install Project Auditor in Unity 2018 (or newer) is via Package Manager with the following steps:

Click on Code and copy the repository HTTPS URL to the clipboard

In Package Manager, click on the + button (top left) and select Add package from git URL

Finally, paste the URL and click Add

Note that to install a specific version, simply add #<version> at the end of the URL. For example:

https://github.com/Unity-Technologies/ProjectAuditor.git#0.8.2-preview

A list of releases can be found here.

Upgrade to a newer version

Under the hood, the method described above adds com.unity.project-auditor as a dependency in the project Packages/manifest.json file. To upgrade to a new Project Auditor version, you can simply modify the tag. For example:

{
  "dependencies": {
    "com.unity.project-auditor": "https://github.com/Unity-Technologies/ProjectAuditor.git#0.8.2-preview",
  }
}

Install as a tarball

If you are working in an old version of Unity (2020.3 or earlier) and cannot install the package directly from the Git URL for some reason, another option is to install the package from a tarball. See the Package Manager documentation about tarballs for more information.