Quick Start
How to install Avatar Compressor
ALCOM
ALCOM is the recommended package manager for VRChat avatar development.
Add the Repository
Click the button below to add the Limitex VPM repository:
Or manually add the repository:
- Open ALCOM and go to Settings
- Select the Packages tab
- Click Add Repository
- Enter the URL:
https://vpm.limitex.dev/index.json - Click Add
Install the Package
- Open ALCOM and select your project
- Find Avatar Compressor in the package list
- Click Add to install
VCC (VRChat Creator Companion)
Add the Repository
Click the button below to add the Limitex VPM repository:
Or manually add the repository:
- Open VCC and go to Settings
- Select the Packages tab
- Click Add Repository
- Enter the URL:
https://vpm.limitex.dev/index.json - Click Add
Install the Package
- Open VCC and select your project
- Go to Manage Project
- Find Avatar Compressor in the package list
- Click Add to install
vrc-get
vrc-get is a command-line client for VRChat Package Manager.
Add the Repository
vrc-get repo add https://vpm.limitex.dev/index.jsonInstall the Package
Navigate to your Unity project directory, then run:
vrc-get install dev.limitex.avatar-compressorManual Installation
Manual installation is not recommended. Use a package manager for easier updates.
Download the Package
Download the latest .zip from the GitHub Releases page.
Import to Unity
- Extract the
.zipfile - Move the extracted folder to your Unity project's
Packagesfolder - Open Unity and the package will be automatically detected
Dependencies
The following packages will be installed automatically as dependencies.
| Package | Minimum Version |
|---|---|
| VRChat SDK - Avatars | 3.10.0 |
| NDMF | 1.10.0 |
NDMF Installation
NDMF (Non-Destructive Modular Framework) is provided via the Modular Avatar VPM repository. If the installation fails due to NDMF not being found, please add the Modular Avatar repository:
Or manually add the repository URL: https://vpm.nadena.dev/vpm.json