Unity and VRChat Creator Tools
Unity and the VRChat SDK already include tools for package management, scene construction, local testing, profiling, rendering inspection, and debugging. Use this index to open the tool that matches the task.
Manage the project outside Unity, build inside Unity, then test in both ClientSim and the VRChat client.
- Use Creator Companion for the supported Unity editor and VPM packages.
- Use Unity's Console, Profiler, and Frame Debugger to diagnose the project.
- Use ClientSim for fast editor tests and Build & Test for final client behavior.
ClientSim reproduces useful VRChat behavior inside the Unity Editor, but VRChat states that it cannot simulate every feature. Test the world in VRChat before publishing it.
Tool Finder
| Task | Tool | Where to open it |
|---|---|---|
| Create or migrate a VRChat project | Creator Companion | Creator Companion Projects |
| Add or update VPM packages | Creator Companion | Project Manage Project |
| Add or remove Unity packages | Unity Package Manager | Window > Package Manager |
| Read compile and import errors | Console | Window > General > Console |
| Validate a VRChat world or avatar | VRChat SDK Control Panel | VRChat SDK > Show Control Panel |
| Test world interactions in the Editor | ClientSim | Enter Play mode in a Worlds SDK project |
| Test the built world in VRChat | Build & Test | SDK Control Panel Builder |
| Record CPU, rendering, memory, or audio data | Profiler | Window > Analysis > Profiler |
| Inspect the draw events that compose a frame | Frame Debugger | Window > Analysis > Frame Debugger |
| View quick rendering statistics | Game view Stats | Stats in the Game view |
| Inspect baked occlusion visibility | Occlusion Culling | Window > Rendering > Occlusion Culling |
| Launch local clients with debug options | VRC Quick Launcher | Creator Companion Tools |
Creator Companion
Creator Companion is the project and package entry point for current VRChat development. It can:
- install the Unity editor version supported by VRChat;
- create World and Avatar projects;
- add existing projects;
- manage official, curated, community, and user VPM packages;
- migrate supported legacy SDK projects;
- create project backups;
- open the VRC Quick Launcher.
Close Unity before changing VPM packages through Creator Companion. Reopen the project after package changes and allow the VPM Resolver and Unity compiler to finish.
For installation and removal details, see Install and Remove Unity Add-ons Safely.
Unity Package Manager
Open Window > Package Manager to inspect packages managed by Unity.
Use it to:
- view packages installed in the project;
- install packages from the Unity Registry;
- add a package by its exact package name;
- add packages from a Git URL, local folder, or tarball;
- import Asset Store packages from My Assets;
- update or remove eligible packages;
- inspect package dependencies and documentation.
Use Creator Companion—not Unity Package Manager—to manage the official VRChat SDK packages in a VPM project.
Console
Open Window > General > Console to read editor messages, warnings, compilation failures, and import errors.
Useful controls include:
- Collapse, which groups repeating messages;
- search and message-type filters;
- Error Pause, which pauses Play mode when a script calls
Debug.LogError; - Open Editor Log, which opens the complete Unity Editor log.
Select an error and read its full message and stack trace. If many errors appear after one package or script change, investigate the earliest relevant error first.
See Unity and VRChat Troubleshooting for the diagnostic sequence.
VRChat SDK Control Panel
Open VRChat SDK > Show Control Panel.
The Control Panel provides:
- Authentication for the VRChat account used by the SDK;
- Builder validation and local build controls;
- content configuration and publishing controls;
- Content Manager access for uploaded content.
For a world, read every required Builder validation message before using a build command. The SDK may offer an automatic repair for some project settings.
ClientSim
ClientSim is part of the VRChat Worlds SDK. It runs in Unity Play mode and can reproduce many common client interactions without opening VRChat.
VRChat documents support for:
- mouse, keyboard, and gamepad player control;
- pickups, interactions, UI, and stations;
- inspection of Udon variables during Play mode;
- spawning remote simulated players;
- removing objects tagged
EditorOnlywhen Play mode begins.
ClientSim is useful for rapid interaction checks, but it does not replace a client build. Networking, rendering, platform behavior, and unsupported ClientSim features still need testing in VRChat.
Build & Test
Use the SDK Builder's local build controls when the world needs the real VRChat client.
Current Builder options include:
- Build & Test Your World, which builds and launches a local world;
- Build & Reload Your World, which sends running watched clients to the new build;
- Test Your Last Build;
- Reload Your Last Build.
Local settings also allow a client count and Force Non-VR. Multiple clients can help test synchronized values and network events, though separate account profiles require an appropriate multi-profile setup.
VRC Quick Launcher
Open Creator Companion and select Tools to access VRC Quick Launcher.
It provides a graphical interface for:
- launching VRChat with debug options;
- configuring local or online instance information;
- maintaining multiple launch profiles;
- launching multiple selected profiles;
- detecting and launching local world builds;
- exporting and importing launcher configurations.
Use it when repeated debug-client launches would otherwise require several shortcuts or command-line configurations.
Unity Profiler
Open Window > Analysis > Profiler.
The Profiler records frames and separates performance information into modules. Unity 2022.3 includes modules for areas such as:
- CPU Usage;
- Rendering;
- Memory;
- Audio;
- Physics;
- UI.
Choose the correct target from Attach to Player. Editor Play mode data includes editor overhead, so profile a built target when the result must represent the player accurately.
Select a frame, then use the module's detail view to find the systems contributing to that frame. Compare measurements before and after an optimization.
Frame Debugger
Open Window > Analysis > Frame Debugger when a rendered frame has unexpected draw order, shader use, passes, or visual output.
The Frame Debugger:
- pauses on a frame;
- lists its rendering events;
- steps through those events;
- shows the graphical state at each point;
- reports event details such as geometry and shader information.
It explains how Unity assembled the frame. It does not measure every performance cost, so pair it with the Profiler when timing matters.
Game View Stats
Select Stats in the Game view for a quick rendering overlay during Play mode.
Unity shows live information such as frame timing, FPS, batches, and other audio or graphics statistics. The exact counters vary by build target.
Use Stats for a quick comparison while editing. Use the Profiler for recorded evidence and deeper analysis.
Occlusion Culling Window
Open Window > Rendering > Occlusion Culling for baked occlusion work.
The window provides:
- object and occlusion-area selection;
- bake settings and controls;
- visualization of cells and visibility;
- a way to inspect which objects a selected camera considers visible.
Always inspect the visualization after baking. Incorrect settings can leave hidden objects visible to the renderer or incorrectly cull visible content.
A Reliable Test Sequence
- Read and clear relevant Console errors.
- Test the interaction in ClientSim.
- Check the Game view Stats for obvious changes.
- Use the Profiler when the issue concerns frame time, memory, rendering, physics, or audio.
- Use the Frame Debugger when the issue concerns how a frame is drawn.
- Run Build & Test Your World.
- Review SDK validation and the VRChat output log if the client result differs.
Troubleshooting
ClientSim does not start in Play mode.
Confirm this is a Worlds SDK project, the project has finished compiling, and ClientSim is enabled in its settings. Resolve Console errors before testing again.
The SDK Control Panel is missing.
Check the Console for compilation errors and confirm the project contains the correct VCC-managed official package. VRChat identifies compile errors and an unsupported Unity version as common causes.
The Profiler shows Editor activity I did not expect.
Check the Attach to Player target. Editor Play mode includes editor work; connect the Profiler to the appropriate built player when you need player-specific measurements.
The Frame Debugger does not explain the slowdown.
The Frame Debugger explains render-event order and state rather than complete frame timing. Capture the issue in the Profiler and inspect CPU Usage, Rendering, or GPU data as appropriate.
ClientSim works but the VRChat build behaves differently.
Treat the client result as authoritative. Reproduce the issue with Build & Test, enable the relevant debug logging, and inspect the VRChat output log and Unity Console.
Official References
- VRChat Creator Companion
- VRChat Package Manager
- VRChat ClientSim
- VRChat Build & Test
- VRC Quick Launcher
- Unity 2022.3: Console
- Unity 2022.3: Profiler
- Unity 2022.3: Frame Debugger
- Unity 2022.3: Game View
- Unity 2022.3: Occlusion Culling