The VRChat Documentation Hub

Welcome to the VRChat Documentation hub. You'll find comprehensive guides and documentation to help you start working with VRChat as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Configuration File

There are a few systems in VRChat that have configurable options or properties. These systems aren't customized with settings you can set in the application, as the default settings are sufficient for the vast majority of VRChat players.

However, we have provided a way for you to customize some of these values in case you want to change how they work!

Configuration File Location

The configuration file is stored in %AppData%\..\LocalLow\VRChat\vrchat. The file must be named config.json and must consist of a valid JSON structure.

An example configuration file might look like this:

{
    "betas": [
        "particle_system_limiter"
    ],
    "ps_max_particles": 50000,
    "ps_max_systems": 200,
    "ps_max_emission": 5000,
    "ps_max_total_emission": 40000,
    "ps_mesh_particle_divider": 60,
    "ps_mesh_particle_poly_limit": 50000,
    "ps_collision_penalty_high": 50,
    "ps_collision_penalty_med": 30,
    "ps_collision_penalty_low": 10,
    "ps_trails_penalty": 10,
    "dynamic_bone_max_affected_transform_count" : 32,
    "dynamic_bone_max_collider_check_count" : 8,
    "cache_directory" : "C:/VRCCache/"
}

These properties will be described below.

Configuration File Uses

The configuration file may be used to customize several systems in VRChat.

Rich Presence

You can disable the Discord and Steam Rich Presence functionality by adding this value to your configuration file.

Property Name

Purpose

Valid Values

disableRichPresence

Disables the Steam and Discord Rich Presence integration.

Bool, true or false

Cache Location

Normally, VRChat stores its cache in %AppData%\..\LocalLow\VRChat\vrchat in several sub-folders. This is the location that Microsoft Windows expects temporary program files to be stored, but advanced users may wish to move this cache in case of smaller OS drives or some other reason.

Property Name

Purpose

Valid Values

cache_directory

Defines the location where VRChat should store its cache data.

Any valid path. Do not use \ as a path symbol-- this indicates an escape symbol in JSON. Use \\ or / instead.

The config file and output logs will still be present in the default location, but all cache will be stored in the defined directory by this property.

When this value is not present, the default value of %AppData%\..\LocalLow\VRChat\vrchat is used.

🚧

Cache Size

The cache will limit itself to 20 gigabytes. It may hover slightly above or below this value depending on the size of the assets present. Files will be removed based on how long it has been since that file has been accessed.

*You should not be clearing your cache on a regular basis! Doing so will incur unnecessary downloads. Clearing your cache is a troubleshooting step, not a normal maintenance process. It will manage itself without intervention.

To prevent abuse and heavy particle use affecting performance, Particle Systems can be limited when used on avatars. Click the section header to see the documentation page describing this system.

Dynamic Bone is a very performance-heavy component, and it is easy for an avatar creator to overuse the component. VRChat has provided a method by which users can limit the number of Dynamic Bones permitted on avatars. Click the section header to see the documentation page describing this system.

Camera and Screenshot Settings

You can adjust the resolution of your camera's images and screenshot settings with some configuration options.

Property Name

Purpose

Valid Values

camera_res_height

Adjusts the height of images taken with the VR camera.

720 to 2160

camera_res_width

Adjusts the width of images taken with the VR camera.

1280 to 3840

screenshot_res_height

Adjusts the height of images taken with the F12 key.

720 to 2160

screenshot_res_width

Adjusts the width of images taken with the F12 key.

1280 to 3840

Updated 9 days ago


Configuration File


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.