Debug Menu: Difference between revisions

From VRChat Wiki
(added external link to docs)
m (Fixed empty heading..)
 
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Noticebox/official}}{{Noticebox/wip}}
{{Noticebox/Official}}
The '''Debug Menu''' consists of multiple menus and consoles which are windows within the [[Special:MyLanguage/VRChat|VRChat]] client that display various pools of data, and are used for troubleshooting. There are different debugging windows for [[Special:MyLanguage/Worlds|Worlds]], [[Special:MyLanguage/Avatars|Avatars]], and even [[Open Sound Control|OSC]].
==Avatar Debug Console==
 
The Avatar Debug Console displays information about your current avatar's animator, and other settings. This console can be found in the [[Special:MyLanguage/Action Menu|Action Menu]] in <code>Options &gt; Avatar &gt; Debug</code>. To scroll up and down you can press <code>Page Up</code>, and <code>Page Down</code> on desktop.
 
*Left column: Lists the avatars parameters.
**'''Parameter''': Name of the parameter.
**'''Type''': What variable type the parameter is. Available types are Bool, Float, and Int.
**'''Value''': Their current value.
*Center column: Contains 3 sections. 
**'''Tracking control''': Shows if the parts of the avatars body has IK enabled or disabled.
***'''Name''': Name of the avatars body part.
***'''Value''': What type of tracking its using. Either tracking the Ik, or an animation.
**'''Animation Controllers''': Shows the current weight of the avatars Playable Layers.
**'''Miscellaneous''':
*Right column: Lists all the layers for each Playable Layer and their current weight and state.<span id="avatar-dynamics-overlay"></span>
==Avatar Dynamics Overlay==
 
These options allow you to visualize Avatar Dynamics features like PhysBones, and Contacts. These options can be found in the [[Special:MyLanguage/Action Menu|Action Menu]] in <code>Options &gt; Avatar &gt; Avatar Overlay</code>
 
*'''None''': Turns off all the Overlays.
*'''PhysBones Proximity''': Visualizes PhysBones near your hands.
*'''PhysBones''': Visualizes PhysBones on all avatars.
*'''Contacts''': Shows all contacts on avatar and their current contact state.
 
See also, '''VRChat Learning Channel's''' [https://www.youtube.com/watch?v=8hqDquZWvhY Avatar Dynamics Debugging Overlay Demonstration] on ''YouTube''.<span id="osc-debug-console"></span>
==OSC Debug Console==
[[File:Osc debug.png|thumb|Screenshot of OSC debug console.]]
Displays incoming OSC messages to VRChat, and their values. The OSC console can be found in the [[Special:MyLanguage/Action Menu|Action Menu]] in <code>Options &gt; OSC &gt; OSC Debug</code>. To scroll up and down, you can press <code>Page Up</code>, and <code>Page Down</code> on desktop, or use the scroll bar in VR mode. See also VRChat's [https://docs.vrchat.com/docs/osc-debugging| OSC Debugging page].


<span id="debug-menus"></span>
= Debug Menus=
<span id="world-debug-console"></span>
==World Debug Console==
==World Debug Console==


This console is used to debug your worlds in-game.
This console is used to debug your worlds in-game.


*In order to access you must add the launch parameter <code>--enable-debug-gui</code>.
*In order to access, you must add the launch parameter <code>--enable-debug-gui</code>.
* Press <code>Rshift + Tilde + 1-9</code> with the number corresponding to the menu number you want.<span id="debug-menu-1"></span>
*Press <code>Right Shift + Tilde (~) + 1-9</code> with the number corresponding to the menu number <span id="debug-menu-1"></span>you want.
===Debug Menu 1 ===


Debug menu 1 displays information about your connection to the VRChat API.
More information can be accessed at {{VRC link|https://creators.vrchat.com/worlds/udon/world-debug-views/|World Debug View}} on ''creators.vrchat.com''.
 
===Debug Menu 1===
 
Debug Menu 1 displays information about your connection to the [[VRChat API]].
[[File:World Debug Menu 1.png|none|thumb|Screenshot of World Debug Menu 1]]
[[File:World Debug Menu 1.png|none|thumb|Screenshot of World Debug Menu 1]]


=== Debug Menu 2===
===Debug Menu 2===
Debug menu 2 displays information about the build of VRChat you are using, also shows your fps.
Debug Menu 2 displays information about the build of VRChat you are using, also shows your frames per second (FPS).
[[File:World Debug Menu 2.png|none|thumb|Screenshot of World Debug Menu 2]]
[[File:World Debug Menu 2.png|none|thumb|Screenshot of World Debug Menu 2]]


===Debug Menu 3 ===
===Debug Menu 3 ===


Debug menu 3 displays your output log.
Debug Menu 3 displays your output log. Hold <code>Tab</code> to activate the mouse cursor so you can use the buttons at the top as well as scroll the log output.


For additional information you can use two launch parameters.
For additional information, you can use two launch parameters, if you're using VRChat on Steam or SteamVR: 


*<code>--enable-sdk-log-levels</code>
*<code>--enable-sdk-log-levels</code>
Line 31: Line 60:
===Debug Menu 4===
===Debug Menu 4===


Debug menu 4 displays stats about users.
Debug Menu 4 displays stats about players.


*M: Whether or not the user is the master of the instance
*'''M''': Whether or not the player is the master of the instance
*L: Whether or not the user is the local player
*'''L''': Whether or not the player is the local player
*VR: Whether or not the user is in VR
*'''VR''': Whether or not the player is in VR
* Group: The current group that the user is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
*'''Group''': The current group that the player is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
*Ping: The user's ping
*'''Ping''': The player's ping
*Intrvl: The amount of time between the user sending synced data about themselves.
*'''Intrvl''': The amount of time between the player sending synced data about themselves.
*D: The current delay.<span id="debug-menu-5"></span>
*'''D''': The current delay.<span id="debug-menu-5"></span>
[[File:World Debug Menu 4.png|none|thumb|Screenshot of World Debug Menu 4]]
[[File:World Debug Menu 4.png|none|thumb|Screenshot of World Debug Menu 4]]


===Debug Menu 5===
===Debug Menu 5===


Debug menu 5 displays graphs related to networking.
Debug Menu 5 displays graphs related to networking.
[[File:World Debug Menu 5.png|none|thumb|Screenshot of World Debug Menu 5]]
[[File:World Debug Menu 5.png|none|thumb|Screenshot of World Debug Menu 5]]


{{Noticebox|Warning-icon-png-2749.png|World debugging menus after 5 are restricted.|By default, only the creator of the world can access these menus. However the world creator can allow others to see them by enabling World Debugging in the world's settings on the website.|size=24px|border=#F8CC3A|border-width=2px|background=#F5EFDC|textcolor=#000022}}
{{Noticebox|Warning-icon-png-2749.png|World debugging menus after 5 are restricted.|By default, only the creator of the world can access these menus. However, the world creator can allow others to see them by enabling World Debugging in the world's settings on the website.|size=24px|border=#F8CC3A|border-width=2px|background=#F5EFDC|textcolor=#000022}}


===Debug Menu 6===
===Debug Menu 6 & 7===


Debug menu 6 displays all networked objects in the world. Showing networking stats of that object.  
Debug Menu 6 displays all networked objects in the world. Showing networking stats of that object.


*Name: GameObjects name.
Debug Menu 7 displays the same information as Debug Menu 6, but sorts the objects from highest networking impact to least.
* Owner: The playerid of the owner of the object.
*'''Name''': GameObjects name.
*Group: The current group that this object is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
*'''Owner''': The PlayerID of the owner of the object.
*Sleeping: Whether or not the object is sleeping. Only objects with VRCObjectSync can sleep. Sleeping causes the object to stop transmitting data.
*'''Group''': The current group that this object is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
*Delay: The current delay of this object between the owner and the viewer.
*'''Sleeping''': Whether or not the object is sleeping. Only objects with VRCObjectSync can sleep. Sleeping causes the object to stop transmitting data.
*Size: The current number of bytes per serialization of this object. Every time it needs to sync, it will send this many bytes.
* '''Delay''': The current delay of this object between the owner and the viewer.
*Bps: A rough approximation of how many bytes per second this object is using up.
*'''Size''': The current number of bytes per serialization of this object. Every time it needs to sync, it will send this many bytes.
*Since Last: A running counter of how long it has been since the last time this object has sent data.
* '''Bps''': A rough approximation of how many bytes per second this object is using up.
*Interval: A rough approximation of how many times this object tries to sync per second.<span id="debug-menu-7"></span>
*'''Since Last''': A running counter of how long it has been since the last time this object has sent data.
*'''Interval''': A rough approximation of how many times this object tries to sync per second.<span id="debug-menu-7"></span>
[[File:World Debug Menu 6.png|none|thumb|Screenshot of World Debug Menu 6]]
[[File:World Debug Menu 6.png|none|thumb|Screenshot of World Debug Menu 6]]


===Debug Menu 7<!-- currently not displaying anything will need to check with devs. -->===
Debug menu 7 displays the same information as 6, but sorts the objects from highest networking impact to least.<span id="debug-menu-8"></span>
===Debug Menu 8===
===Debug Menu 8===


Debug menu 8 displays a panel on top of every synced object in the world. Each panel displays stats about that object.
Debug Menu 8 displays a panel on top of every synced object in the world. Each panel displays stats about that object.  


*P: Ping of the owner
*'''P''': Ping of the owner
*Q: Quality of the data (100% is no dropped packets)
*'''Q''': Quality of the data (100% is no dropped packets)
*O: PlayerID of the owner of the object
*'''O''': PlayerID of the owner of the object
*G: The current group that this object is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
*'''G''': The current group that this object is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
*Held: Whether or not this object is held, if it is a pickup
*'''Held''': Whether or not this object is held, if it is a pickup
*Status: Displays various things about what this object is doing, such as <code>Should Sleep</code>, <code>Player</code>, <code>Held</code>, or <code>Discontinuity</code><span id="debug-menu-9"></span>
*'''Status''': Displays various things about what this object is doing, such as <code>Should Sleep</code>, <code>Player</code>, <code>Held</code>, or <code>Discontinuity</code><span id="debug-menu-9"></span>
[[File:World Debug Menu 8.png|none|thumb|Screenshot of World Debug Menu 8]]
[[File:World Debug Menu 8.png|none|thumb|Screenshot of World Debug Menu 8]]


===Debug Menu 9===
===Debug Menu 9===


Debug menu 9 displays a panel near users to display their networking stats.
Debug Menu 9 displays a panel near players to display their networking stats.
[[File:World Debug Menu 9.png|none|thumb|Screenshot of World Debug Menu 9]]
[[File:World Debug Menu 9.png|none|thumb|Screenshot of World Debug Menu 9]]


==Avatar Debug Console==
Displays information about your currently warn avatar's animator, and other settings. This Console can be found in the [[Action Menu]] in <code>Options&gt;Avatar&gt;Debug</code> To navigated up and down you can press <code>Page Up</code> to scroll up, and <code>Page Down</code> to scroll down.
*Left column: lists the avatars parameters.
**Parameter: name of the parameter.
**Type: What variable type the parameter is. Available types are Bool, Float, and Int.
**Value: Their current value.
*Center column: contains 3 sections.
**Tracking control: shows if the parts of the avatars body has IK enabled or disabled.
***Name: name of the avatars body part.
***Value: what type of tracking its using. Either tracking the Ik, or an animation.
**Animation Controllers: Shows the current weight of the avatars Playable Layers.
**Miscellaneous:
*Right column: Lists all the layers for each Playable Layer and their current weight and state.<span id="avatar-dynamics-overlay"></span>
==Avatar Dynamics Overlay==
These options allow you to visualize Avatar Dynamics features like PhysBones, and Contacts. These options can be found in the [[Action Menu]] in <code>Options&gt;Avatar&gt;Avatar Overlay</code>


* None: Turns off all the Overlays.
==Official Resources==
*Physbones Proximity: visualizes Physbones near your hands.
*{{VRC link|https://creators.vrchat.com/worlds/udon/world-debug-views|World Debug View}} page in the VRChat Documentation
*Physbones: visualizes Physbones on all avatars.
*[https://docs.vrchat.com/docs/osc-debugging| OSC Debugging] page in the VRChat Documentation
*Contacts: shows all contacts on avatar and their current contact state.
 
[https://www.youtube.com/watch?v=8hqDquZWvhY Video example]
 
<span id="osc-debug-console"></span>
==OSC Debug Console==
[[File:Osc debug.png|thumb|screenshot of OSC debug console]]
Displays incoming osc messages to vrchat and their values. Can be found in the [[Action Menu]] in <code>Options&gt;OSC&gt;OSC Debug</code>. To navigated up and down you can press <code>Page Up</code> to scroll up, and <code>Page Down</code> to scroll down.


== External Links ==
[[Category:User Interface]]
[https://creators.vrchat.com/worlds/udon/world-debug-views World Debug Views] in the VRChat Documentation
[[Category:Menus]]

Latest revision as of 03:05, 13 September 2024

VRLogo.png
V · EThis is an official VRChat information page!
It is written and maintained by Wiki Maintainers and VRChat Staff.

The Debug Menu consists of multiple menus and consoles which are windows within the VRChat client that display various pools of data, and are used for troubleshooting. There are different debugging windows for Worlds, Avatars, and even OSC.

Avatar Debug Console

The Avatar Debug Console displays information about your current avatar's animator, and other settings. This console can be found in the Action Menu in Options > Avatar > Debug. To scroll up and down you can press Page Up, and Page Down on desktop.

  • Left column: Lists the avatars parameters.
    • Parameter: Name of the parameter.
    • Type: What variable type the parameter is. Available types are Bool, Float, and Int.
    • Value: Their current value.
  • Center column: Contains 3 sections.
    • Tracking control: Shows if the parts of the avatars body has IK enabled or disabled.
      • Name: Name of the avatars body part.
      • Value: What type of tracking its using. Either tracking the Ik, or an animation.
    • Animation Controllers: Shows the current weight of the avatars Playable Layers.
    • Miscellaneous:
  • Right column: Lists all the layers for each Playable Layer and their current weight and state.

Avatar Dynamics Overlay

These options allow you to visualize Avatar Dynamics features like PhysBones, and Contacts. These options can be found in the Action Menu in Options > Avatar > Avatar Overlay

  • None: Turns off all the Overlays.
  • PhysBones Proximity: Visualizes PhysBones near your hands.
  • PhysBones: Visualizes PhysBones on all avatars.
  • Contacts: Shows all contacts on avatar and their current contact state.

See also, VRChat Learning Channel's Avatar Dynamics Debugging Overlay Demonstration on YouTube.

OSC Debug Console

Screenshot of OSC debug console.

Displays incoming OSC messages to VRChat, and their values. The OSC console can be found in the Action Menu in Options > OSC > OSC Debug. To scroll up and down, you can press Page Up, and Page Down on desktop, or use the scroll bar in VR mode. See also VRChat's OSC Debugging page.

World Debug Console

This console is used to debug your worlds in-game.

  • In order to access, you must add the launch parameter --enable-debug-gui.
  • Press Right Shift + Tilde (~) + 1-9 with the number corresponding to the menu number you want.

More information can be accessed at Official VRChat source World Debug View on creators.vrchat.com.

Debug Menu 1

Debug Menu 1 displays information about your connection to the VRChat API.

Screenshot of World Debug Menu 1

Debug Menu 2

Debug Menu 2 displays information about the build of VRChat you are using, also shows your frames per second (FPS).

Screenshot of World Debug Menu 2

Debug Menu 3

Debug Menu 3 displays your output log. Hold Tab to activate the mouse cursor so you can use the buttons at the top as well as scroll the log output.

For additional information, you can use two launch parameters, if you're using VRChat on Steam or SteamVR:

  • --enable-sdk-log-levels
  • --enable-udon-debug-logging
Screenshot of World Debug Menu 3

Debug Menu 4

Debug Menu 4 displays stats about players.

  • M: Whether or not the player is the master of the instance
  • L: Whether or not the player is the local player
  • VR: Whether or not the player is in VR
  • Group: The current group that the player is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
  • Ping: The player's ping
  • Intrvl: The amount of time between the player sending synced data about themselves.
  • D: The current delay.
Screenshot of World Debug Menu 4

Debug Menu 5

Debug Menu 5 displays graphs related to networking.

Screenshot of World Debug Menu 5


Warning-icon-png-2749.png
World debugging menus after 5 are restricted.
By default, only the creator of the world can access these menus. However, the world creator can allow others to see them by enabling World Debugging in the world's settings on the website.


Debug Menu 6 & 7

Debug Menu 6 displays all networked objects in the world. Showing networking stats of that object.

Debug Menu 7 displays the same information as Debug Menu 6, but sorts the objects from highest networking impact to least.

  • Name: GameObjects name.
  • Owner: The PlayerID of the owner of the object.
  • Group: The current group that this object is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
  • Sleeping: Whether or not the object is sleeping. Only objects with VRCObjectSync can sleep. Sleeping causes the object to stop transmitting data.
  • Delay: The current delay of this object between the owner and the viewer.
  • Size: The current number of bytes per serialization of this object. Every time it needs to sync, it will send this many bytes.
  • Bps: A rough approximation of how many bytes per second this object is using up.
  • Since Last: A running counter of how long it has been since the last time this object has sent data.
  • Interval: A rough approximation of how many times this object tries to sync per second.
Screenshot of World Debug Menu 6

Debug Menu 8

Debug Menu 8 displays a panel on top of every synced object in the world. Each panel displays stats about that object.

  • P: Ping of the owner
  • Q: Quality of the data (100% is no dropped packets)
  • O: PlayerID of the owner of the object
  • G: The current group that this object is in. Grouping in this context is an internal networking system used to combine multiple objects together by distance so that their data can be sent together.
  • Held: Whether or not this object is held, if it is a pickup
  • Status: Displays various things about what this object is doing, such as Should Sleep, Player, Held, or Discontinuity
Screenshot of World Debug Menu 8

Debug Menu 9

Debug Menu 9 displays a panel near players to display their networking stats.

Screenshot of World Debug Menu 9


Official Resources