Launch Options: Difference between revisions

From VRChat Wiki
(Draft)
 
(Clean up the initial a bit. Added missing ones from docs.vrchat.com/docs/launch-options)
Line 1: Line 1:
{{Noticebox/Official}}
{{Noticebox/wip}}
Launch Options are special parameters used to modify how VRChat starts.
==How to use Launch Options==
==How to use Launch Options==
TBC
Launch Options are only supported on the following:
 
===Steam===
Steam allows you to set launch options per application, to set launch options for VRChat, right-click VRChat in your game list and click on '''Properties'''. After clicking Properties, under General, click on the box under Launch Options, then put your desired launch options in.
 
===Meta Quest Link App / Manual===
You must create a shortcut to the VRChat executable. After launching Oculus Home, launch this shortcut by clicking its icon. The Oculus launcher does not support launch options natively.
 
=== VRC Quick Launcher ===
The [[VRC Quick Launcher]] allows custom parameters to be set


==List of Launch Options and Arguments==
==List of Launch Options and Arguments==
===General===
{| class="wikitable"
{| class="wikitable"
|+ For debug
|-
|-
! Launch Options !! Descriptions
!Launch Options!!Descriptions
|-
|-
| --enable-debug-gui  || Example
| --no-vr||Forces desktop mode
|-
|-
| --enable-sdk-log-levels || Example
| --fps=x||Example
|-
|-
| --enable-udon-debug-logging || Example
| --profile=x
|Example
|}
 
===Creator===
{| class="wikitable"
|-
|-
| --enable-verbose-logging || Example
!Launch Options!!Descriptions
|-
|-
| --log-debug-levels="<ARG>" || ARG
| --watch-avatars||Example
{| class="wikitable"
|-
|-
! Arguments !! Descriptions
| --watch-worlds||Example
|-
|-
| API; || Example
| --osc=<ARG1>:<ARG2>:<ARG3>
|Example
|-
|-
| All; || Example
| --midi=deviceName
| Example
|}
 
===IK===<!-- I'm pretty sure most of these launch options are removed? Most of these are in the settings menu now. -->
{| class="wikitable"
|-
|-
| Always; || Example
!Launch Options!! Descriptions
|-
|-
| AssetBundleDownloadManager; || Example
| --legacyfbt-calibrate||Example  
|-
|-
| ContentCreator; || Example
| --disable-shoulder-tracking||Example
|-
|-
| Errors; || Example
| --calibration-range="<ARG>"|| Example
|-
|-
| NetworkData; || Example
| --enable-ik-debug-logging||Example
|-
|-
| NetworkProcessing; || Example
| --freeze-tracking-on-disconnect||Example
|-
|-
| NetworkTransport; || Example
| --ignore-trackers=<ARG>||Example
|-
|-
| Warnings" || Example
| --ignore-trackers=serial1,serial2
|}
|Example
|}
|}


===Debug===
{| class="wikitable"
{| class="wikitable"
|+ For general
|-
|-
! Launch Options !! Descriptions
!Launch Options!!Descriptions
|-
| --enable-debug-gui||Enables the [[Debug Menu|debug menu]]
|-
|-
| --no-vr  || Example
| --enable-sdk-log-levels
|Example
|-
|-
| --fps=x || Example
| --enable-udon-debug-logging||Example
|-
|-
| -screen-width  || Example
| --enable-verbose-logging||Example
|-
|-
| -screen-height  || Example
| --log-debug-levels="<ARG>"||ARG
{| class="wikitable"
|-
|-
| -screen-fullscreen || Example
! Arguments !! Descriptions
|-
|-
| -monitor N || Example
|API;
|}
|Example
 
|-
{| class="wikitable"
|All;||Example
|+ For developper
|-
|-
! Launch Options !! Descriptions
|Always;||Example
|-
|-
| --profile=x || Example
|AssetBundleDownloadManager;||Example
|-
|-
| --watch-avatars || Example
|ContentCreator;||Example  
|-
|-
| --watch-worlds || Example
|Errors;||Example  
|}
 
{| class="wikitable"
|+ For OSC
|-
|-
! Launch Options !! Descriptions
|NetworkData;||Example
|-
|-
| --osc=<ARG1>:<ARG2>:<ARG3> || Example
|NetworkProcessing;||Example
|-
|-
| --midi=deviceName || Example
|NetworkTransport;||Example
|-
|-
| --enable-avpro-in-proton || Example
|Warnings"||Example
|}
|}
|}


===System===
{| class="wikitable"
{| class="wikitable"
|+ For IK/Tracking
|-
|-
! Launch Options !! Descriptions
!Launch Options!!Descriptions
|-
|-
| --legacyfbt-calibrate || Example
| --disable-hw-video-decoding|| rowspan="2" |Example
|-
|-
| --disable-shoulder-tracking || Example
| --enable-hw-video-decoding
|-
|-
| --calibration-range="<ARG>" || Example
| --affinity=<ARG>||Example
|-
|-
| --enable-ik-debug-logging || Example
| --process-priority=<ARG>
|ARG
{| class="wikitable"
|-
|-
| --freeze-tracking-on-disconnect || Example
| --process-priority=<ARG>||Example
|-
|-
| --ignore-trackers=<ARG> || Example
| --main-thread-priority=<ARG>||Example
|}
|}
 
|-
| --main-thread-priority=<ARG>
|ARG
{| class="wikitable"
{| class="wikitable"
|+ For AMD Users
|-
|-
! Launch Options !! Descriptions
| --process-priority=<ARG>||Example
|-
|-
| --affinity=<ARG> || Example
| --main-thread-priority=<ARG>||Example
|}
|-
|-
| --disable-hw-video-decoding || Example
| --skip-registry-install
|Example
|-
| --disable-amd-stutter-workaround
|Example
|-
| --enable-avpro-in-proton
|Example
|}
|}


===Unity===
Unity comes with built-in launch options. These are not supported or guaranteed to work. You can view the full list [https://docs.unity3d.com/2022.3/Documentation/Manual/PlayerCommandLineArguments.html here].
Some useful ones are listed below:
{| class="wikitable"
{| class="wikitable"
|+ For CPU Process and Thread
|-
|-
! Launch Options !! Descriptions
!Launch Options!!Descriptions
|-
|-
| --process-priority=<ARG> || ARG
| -screen-width||Example
{| class="wikitable"
|-
| --process-priority=<ARG> || Example
|-
| --main-thread-priority=<ARG> || Example
|}
|-
|-
| --main-thread-priority=<ARG> || ARG
| -screen-height||Example
{| class="wikitable"
|-
|-
| --process-priority=<ARG> || Example
| -screen-fullscreen||Example
|-
|-
| --main-thread-priority=<ARG> || Example
| -monitor N||Example
|}
|}
|}
==References==
[https://docs.vrchat.com/docs/launch-options docs.vrchat.com - Launch Options]
[[Category:Guides{{#translation:}}]]

Revision as of 21:37, 13 March 2025

VRLogo.png
V · EThis is an official VRChat information page!
It is reviewed and approved by the VRCWiki Team. Learn how to contribute to this page by reading the Contribution Guide.
Tools.png
V · EThis page is a work in progress
This page is actively being worked on, information may be incomplete or out of date. You can help the VRChat Wiki by editing it.
[Reason: No reason provided.]

Launch Options are special parameters used to modify how VRChat starts.

How to use Launch Options

Launch Options are only supported on the following:

Steam

Steam allows you to set launch options per application, to set launch options for VRChat, right-click VRChat in your game list and click on Properties. After clicking Properties, under General, click on the box under Launch Options, then put your desired launch options in.

Meta Quest Link App / Manual

You must create a shortcut to the VRChat executable. After launching Oculus Home, launch this shortcut by clicking its icon. The Oculus launcher does not support launch options natively.

VRC Quick Launcher

The VRC Quick Launcher allows custom parameters to be set

List of Launch Options and Arguments

General

Launch Options Descriptions
--no-vr Forces desktop mode
--fps=x Example
--profile=x Example

Creator

Launch Options Descriptions
--watch-avatars Example
--watch-worlds Example
--osc=<ARG1>:<ARG2>:<ARG3> Example
--midi=deviceName Example

IK

Launch Options Descriptions
--legacyfbt-calibrate Example
--disable-shoulder-tracking Example
--calibration-range="<ARG>" Example
--enable-ik-debug-logging Example
--freeze-tracking-on-disconnect Example
--ignore-trackers=<ARG> Example
--ignore-trackers=serial1,serial2 Example

Debug

Launch Options Descriptions
--enable-debug-gui Enables the debug menu
--enable-sdk-log-levels Example
--enable-udon-debug-logging Example
--enable-verbose-logging Example
--log-debug-levels="<ARG>" ARG
Arguments Descriptions
API; Example
All; Example
Always; Example
AssetBundleDownloadManager; Example
ContentCreator; Example
Errors; Example
NetworkData; Example
NetworkProcessing; Example
NetworkTransport; Example
Warnings" Example

System

Launch Options Descriptions
--disable-hw-video-decoding Example
--enable-hw-video-decoding
--affinity=<ARG> Example
--process-priority=<ARG> ARG
--process-priority=<ARG> Example
--main-thread-priority=<ARG> Example
--main-thread-priority=<ARG> ARG
--process-priority=<ARG> Example
--main-thread-priority=<ARG> Example
--skip-registry-install Example
--disable-amd-stutter-workaround Example
--enable-avpro-in-proton Example

Unity

Unity comes with built-in launch options. These are not supported or guaranteed to work. You can view the full list here.

Some useful ones are listed below:

Launch Options Descriptions
-screen-width Example
-screen-height Example
-screen-fullscreen Example
-monitor N Example

References

docs.vrchat.com - Launch Options

Retrieved from "https://wiki.vrchat.com/index.php?title=Launch_Options&oldid=26322"