VPM Catalog is a curated list of VPM packages and repositories which can be used with VCC. You can browse the catalog to find packages that you can use in your VRChat avatar of world projects.
VRChat Creator Companion (VCC) is a tool which is officially provided by VRChat to help creators manage their projects. It can be used to import useful tools as VPM packages, manage dependencies, and more. See the VCC documentation for more information.
VRChat Package Manager (VPM) is a package format used by VCC and other compatible tools. You can distribute your assets as VPM packages, and import them into your projects easily with VCC. See the VCC documentation for more information.
To list your packages in the catalog, you need to submit your VPM repository URL. Once your repository is listed, the catalog will automatically fetch the package list from your repository.
See the registration form to submit your repository.
The catalog fetches the package metadata from VPM repositories and fetches README.md file from the latest release zip files.
So if your repository does not have the metadata or README.md file, the catalog will show fewer information.
README.md of your package’s root folder will be used to create the catalog page.
Recommended fields are based on Unity Package Manager (UPM) format. You can provide the metadata in the package.json file and embed them to your repository json.
See the Unity documentation for more information.
Following package.json fields are recommended to be shown in the catalog page:
| Field | Description |
|---|---|
description | A brief description of the package. |
displayName | A user-friendly name to appear in the Unity Editor. |
unity | Indicates the lowest Unity version the package is compatible with. |
author | The author of the package. |
changelogUrl | Custom location for this package’s changelog specified as a URL. |
documentationUrl | Custom location for this package’s documentation specified as a URL. |
license | Identifier for an OSS license using the SPDX identifier format, or a string such as “See LICENSE.md file”. |
licenseUrl | Custom location for this package’s license information specified as a URL. |
There are two options to remove your packages or repositories from the catalog.
'vrc-get'.yanked field in package metadata'vrc-get'.yanked is defined by vrc-get and ALCOM to hide discontinued packages.
VPM Catalog also hides packages when their 'vrc-get'.yanked is a string or true.
{
"name": "com.example.package",
"vrc-get": {
"yanked": "This package is discontinued."
}
}