Add TsVRC to your project
Get TsVRC into a Unity project either through the VRChat Creator Companion (VCC) or by
importing a .unitypackage by hand. VCC is strongly recommended: it resolves the VRChat
Worlds SDK version TsVRC depends on for you, something a .unitypackage import leaves
you to sort out yourself.
Requirements
- Unity 2022.3. TsVRC's package manifest targets this version specifically.
- A Unity world project with the VRChat Worlds
SDK
3.5.x. VCC resolves this automatically when you install TsVRC; importing the.unitypackageneeds it already in your project.
Install the package
- VRChat Creator Companion (recommended)
- .unitypackage
- Open the Creator Companion, select your project, and click Manage Project.
- Find TsVRC (
com.tsvrc.core) in the package list. If it isn't there yet, add TsVRC's package repository to your Creator Companion first, the same one-time step as adding any other community repository. - Press the + next to TsVRC to install it.
- Wait for Unity to finish importing and recompiling.
- Download the latest
.unitypackagefrom TsVRC's GitHub Releases. - With your project open, double-click the downloaded file (or use Assets > Import Package > Custom Package) and import everything.
- Wait for Unity to finish importing and recompiling.
Nothing here resolves the VRChat Worlds SDK version for you, so confirm it's already at
3.5.x before importing. If your project also uses VCC for other packages, prefer the
VCC tab instead: mixing a hand-imported package with VCC-managed ones makes future
updates and dependency resolution your own responsibility to track.
You'll know it worked when Unity's menu bar gains a Tsvrc menu. Everything TsVRC does from here runs from there.
What you just added
TsVRC's manifest description sums it up: structured initialization, dependency wiring,
and editor codegen tooling for building VRChat worlds with UdonSharp. Concretely, the
package compiles as one runtime assembly (Tsvrc.Runtime), the base classes your world's
scripts extend and call into, and one editor-only assembly (Tsvrc.Editor) holding all
the codegen and Configure-window tooling. See How TsVRC fits
together for how those two halves relate.
Three further assemblies, Tsvrc.Testing.Framework, Tsvrc.Testing.Behaviours, and
Tsvrc.Testing.UI, exist purely to support testing a consumer's own project, kept
separate from each other and from Tsvrc.Runtime/Tsvrc.Editor for the reasons covered
in Testing your world.
Next
Continue to Build your first behaviour to initialize TsVRC in a scene and get a script running.