Install and Remove Unity Add-ons Safely
“Add-on” can mean a VPM package, a Unity Package Manager package, an Asset Store package, or files imported from a .unitypackage. Identify the format first, because each type has a different install, update, and removal path.
Make a project backup, identify the package manager, and record the package name and version.
- Use Creator Companion for VRChat SDK and VPM packages.
- Use Unity Package Manager for UPM and Asset Store packages.
- Review every file before importing a custom
.unitypackage.
VRChat SDK packages in a Creator Companion project are managed by VPM. Do not import a legacy VRCSDK .unitypackage into that project.
Identify the Add-on Type
| What you received | Use this tool | Typical location |
|---|---|---|
| Package shown under Manage Project in Creator Companion | VRChat Package Manager | Packages and the VPM manifest |
Package name such as com.unity.probuilder |
Unity Package Manager | Packages/manifest.json |
Git URL, local package folder, or .tgz package |
Unity Package Manager | Referenced through the project manifest |
| Asset Store purchase or download | Package Manager My Assets | Imported files under Assets |
Local .unitypackage file |
Assets > Import Package > Custom Package | Imported files under Assets |
| Loose files or folders | Project window | Copied directly under Assets |
Do not assume two similarly named add-ons use the same manager. Follow the publisher's current installation documentation and preserve the package identifier it provides.
Create a Backup
For a VRChat project:
- Close Unity.
- Open the project in Creator Companion.
- Select Make Backup.
- Wait for the backup ZIP to finish before changing packages.
Creator Companion stores backups under %LOCALAPPDATA%\VRChatCreatorCompanion\Project Backups by default. Source control is also useful, but Unity's Library folder should not be treated as source content.
Install a VPM Package
Use Creator Companion for official, curated, community, and user VPM packages:
- Open Creator Companion and select Projects.
- Select Manage Project for the correct project.
- Find the package and review its installed and available versions.
- Select the version documented for the project, or use the available add control.
- Open the project and allow Unity to finish resolving and compiling.
- Check the Console before opening important scenes.
Creator Companion distinguishes:
- Official Packages, including VRChat Base, Worlds, and Avatars;
- Curated Packages listed by VRChat;
- Community Packages supplied through added repositories;
- User Packages loaded from local package folders.
A curated listing does not replace the package author's documentation. Check the package's supported Unity, SDK, project type, and platform versions before installing it.
Add a Community Repository
Only add a repository from a publisher you intend to trust:
- Open Creator Companion Settings.
- Open the Packages tab.
- Select Add Repository.
- Enter the repository URL supplied by its publisher.
- Review the repository name and included packages before confirming.
Removing a repository stops it from appearing as a source in Creator Companion. It does not automatically prove that packages previously added from that repository are safe to remove from a project.
Install a Unity Package Manager Package
Open Window > Package Manager in Unity.
The install menu supports several sources:
| Install option | Use it when |
|---|---|
| Registry list | The package is visible in Unity Registry or another configured registry. |
| Add package by name | Official documentation gives an exact package ID. |
| Add package from Git URL | The publisher documents a Git repository URL and revision. |
| Add package from disk | A local folder contains a valid package.json. |
| Add package from tarball | The publisher supplies a UPM .tgz archive. |
For Add package by name, copy the complete identifier exactly. Do not guess a version number. If a specific version is required, use the version documented for the project.
After installation:
- Wait for package resolution and script compilation.
- Read the Unity Console.
- Open the package's documentation or Samples tab when provided.
- Test its editor window or component in a disposable scene.
Import an Asset Store Package
Open Window > Package Manager, then select My Assets:
- Sign in through Unity Hub if prompted.
- Find the asset.
- Download the required version.
- Select Import.
- Review the file list and deselect demo content or optional files you do not need.
- Complete the import and inspect the Console.
Asset packages copy files into Assets. They are not the same as UPM packages referenced by Packages/manifest.json.
Import a Custom .unitypackage
Use Assets > Import Package > Custom Package, select the file, and inspect the import list.
Before selecting Import, check for:
- project settings or editor configuration;
- scripts and precompiled plug-ins;
- shader and render-pipeline dependencies;
- folders that overlap existing assets;
- demo scenes, textures, and models you do not need;
- files with names already present in the project.
A .unitypackage import can merge files directly into existing folders. A backup is the reliable rollback path if the package does not provide a complete uninstall list.
Update One Package at a Time
Before updating:
- Read the package changelog.
- Confirm its Unity and VRChat SDK compatibility.
- Back up the project.
- Update one package through the manager that installed it.
- Open or return to Unity and wait for compilation.
- Test the affected scene, avatar, prefab, or editor window.
- Run the relevant VRChat build validation.
Do not update unrelated packages during the same diagnostic pass. If an error appears, the changed package and version should be unambiguous.
Remove the Correct Package Type
Remove a VPM package
Remove VPM packages with Creator Companion or other documented VPM tooling instead of deleting their folders under Packages. Open the project's Manage Project screen and use the available package controls.
Do not force-remove VRChat Base or another required dependency simply to clear an error. VRChat's VPM command documentation warns that forced removal can break the project.
Remove a UPM package
In Unity:
- Open Window > Package Manager.
- Select In Project.
- Select the package.
- Review its dependencies.
- Select Remove.
Unity disables removal when another installed package or feature set requires the package. Removing a direct dependency from the manifest does not necessarily remove it when another package still depends on it.
Remove imported assets
Files imported from My Assets or a custom .unitypackage are stored under Assets. Do not use the UPM removal instructions for them.
Unity 2022.3 does not track dependencies between imported assets. To remove an imported Asset Store package:
- Open Window > Package Manager and select My Assets.
- Select the package and note its package and publisher names.
- In the Project window, locate the publisher's imported files under
Assets. - Confirm which scenes, prefabs, materials, and scripts use those files.
- Delete only the identified assets, or restore the pre-import backup when the package merged into shared folders.
Removing imported files from the project does not remove the downloaded .unitypackage from Unity's Asset Store cache or from the My Assets list.
Verify the Project
After installing, updating, or removing an add-on:
- wait until Unity finishes compiling;
- inspect the Console for new errors and warnings;
- confirm the package no longer reports missing dependencies;
- open the scenes or prefabs that use it;
- run VRChat SDK validation;
- perform a local avatar or world test when runtime content changed.
Troubleshooting
The add-on does not appear in Creator Companion.
Confirm that it is a VPM package and that its official, curated, community, or user repository is enabled. A UPM package or unitypackage will not appear in Creator Companion's package list.
Unity Package Manager cannot find the package name.
Copy the exact package ID from its official documentation and confirm the required registry is configured. A display name is not necessarily the package ID.
The Remove button is disabled.
Review the package's dependencies in Package Manager. Unity prevents removal when another installed package or feature set still requires it.
A custom unitypackage overwrote existing files.
Stop making further changes and restore the backup or source-control state created before the import. Deleting only the obvious new folder may not restore files that were merged or overwritten elsewhere.
The project has compile errors after an update.
Record the first relevant Console error, package ID, old version, and new version. Restore the backup or return to the documented compatible version through the same manager used for installation.
I removed the imported files, but the package remains in My Assets.
My Assets lists packages associated with the Unity account and cache. Removing files from the current project's Assets folder does not remove that listing or the cached download.
Official references
- Unity Package Manager Window
- Unity: Add and Remove Packages
- Unity: Add a Package by Name
- Unity: Import a Custom Asset Package
- Unity: Remove Imported Assets
- Creator Companion Package Manager
- VPM Package Types
- VPM command-line package controls
- Creator Companion Community Repositories
- VRChat Curated Community Packages
- Creator Companion FAQ