vrctools docs

Getting Started

Add the VRCTools package repository to your package manager and install packages into a world project.

Requirements

  • A VRChat world project (optimally managed by the VRChat Creator Companion (VCC) or a compatible package manager such as ALCOM or vrc-get)
  • Unity 2022.3 (the version currently used by the VRChat SDK)
  • VRChat Worlds SDK 3.7.0 or newer

Add the package repository

All public VRCTools packages are published through a single VPM repository:

https://vrctools.github.io/VPM/index.json

The quickest way is to let your browser hand the repository over to Creator Companion:

+ Add to VCC

If the button does nothing (for example because VCC is not installed or the link handler is not registered):

  1. Open Creator Companion and go to Settings
  2. Select the Packages tab
  3. Click Add Repository
  4. Paste https://vrctools.github.io/VPM/index.json and click Add
  5. Review the repository information and confirm with I Understand, Add Repository

Using the command line instead? With vrc-get:

$ vrc-get repo add https://vrctools.github.io/VPM/index.json
$ vrc-get install io.vrctools.world

Install a package

Open your world project in Creator Companion, choose Manage Project and add the package you need, for example VRCTools - World Utilities. Dependencies (such as the Event System and the VRCTools common library) are resolved and installed automatically.

Pre-built .unitypackage files are also attached to each release on GitHub. Manual installation does not install dependencies - you will need to import every required package yourself and keep them up to date.

Where to find things

Installed packages show up under the Packages section of Unity’s project window, prefixed with VRCTools - (for example VRCTools - World Utilities). On disk the folder is named after the package id (e.g. Packages/io.vrctools.world). Every package follows the same layout:

VRCTools - <package name>
├── Editor/                   custom inspectors, editor windows & menus
├── Runtime/
│   ├── Materials/            materials for 3D objects and UI elements
│   ├── Prefabs/              ready to use component setups
│   ├── Shaders/              shaders (where applicable)
│   ├── Textures/             UI textures, default & error images
│   ├── UdonScripts/          UdonSharp behaviours
│   └── VRCTools.<name>.asmdef
├── Samples/                  example scenes and assets
└── LICENSE

The fastest way to learn a package is usually its sample scene. For World Utilities, open Packages/VRCTools - World Utilities/Samples/Example.unity.

Getting help

Stuck, found a bug or have an idea? Join the VRCTools Discord - it’s the place for support, questions and feedback. Please read the server rules first. Bugs in a specific package can also be reported as an issue on its GitHub repository.

discord --join

Next steps