Debug Menu: Difference between revisions
From VRChat Wiki
jetdog8808 (talk | contribs) (auto convert from wiki-old) |
jetdog8808 (talk | contribs) m (fixed formatting for media wiki) |
||
| Line 1: | Line 1: | ||
{{Noticebox/official}}{{Noticebox/wip}} | |||
<span id="debug-menus"></span> | <span id="debug-menus"></span> | ||
= Debug Menus = | = Debug Menus= | ||
<span id="world-debug-console"></span> | <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>. | |||
* Press <code>Rshift + Tilde + 1-9</code> with the number corresponding to the menu number you want.<span id="debug-menu-1"></span> | |||
===Debug Menu 1 === | |||
<span id="debug-menu-1"></span> | |||
=== Debug Menu 1 | |||
Debug menu | Debug menu 1 displays information about your connection to the VRChat API.<span id="debug-menu-2"></span> | ||
=== Debug Menu 2=== | |||
<span id="debug-menu-3"></span> | Debug menu 2 displays information about the build of VRChat you are using, also shows your fps.<span id="debug-menu-3"></span> | ||
=== Debug Menu 3 === | ===Debug Menu 3 === | ||
Debug menu 3 displays your output log. | Debug menu 3 displays your output log. | ||
| Line 29: | Line 22: | ||
For additional information you can use two launch parameters. | For additional information you can use two launch parameters. | ||
* <code>--enable-sdk-log-levels</code> | *<code>--enable-sdk-log-levels</code> | ||
* <code>--enable-udon-debug-logging</code> | *<code>--enable-udon-debug-logging</code><span id="debug-menu-4"></span> | ||
===Debug Menu 4=== | |||
<span id="debug-menu-4"></span> | |||
=== Debug Menu 4 === | |||
Debug menu 4 displays stats about users. | Debug menu 4 displays stats about users. | ||
* M: Whether or not the user is the master of the instance | *M: Whether or not the user is the master of the instance | ||
* L: Whether or not the user is the local player | *L: Whether or not the user is the local player | ||
* VR: Whether or not the user is in VR | *VR: Whether or not the user 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 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. | ||
* Ping: The user's ping | *Ping: The user's ping | ||
* Intrvl: The amount of time between the user sending synced data about themselves. | *Intrvl: The amount of time between the user sending synced data about themselves. | ||
* D: The current delay. | *D: The current delay.<span id="debug-menu-5"></span> | ||
===Debug Menu 5=== | |||
<span id="debug-menu-5"></span> | |||
=== Debug Menu 5 === | |||
Debug menu 5 displays graphs related to networking. | Debug menu 5 displays graphs related to networking. | ||
| Line 52: | Line 41: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| style="text-align: right;"| [[File:/template/alert.png|64px|class=align-center|alert.png]] | | style="text-align: right;" |[[File:/template/alert.png|64px|class=align-center|alert.png]] | ||
| '''World debugging menus after 5 are restricted.'''<br /> | |'''World debugging menus after 5 are restricted.'''<br /> | ||
''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.'' | ''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=== | |||
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. | *Name: GameObjects name. | ||
* Owner: The playerid of the owner of the object. | * 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. | *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. | *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. | *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. | *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. | *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. | *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. | *Interval: A rough approximation of how many times this object tries to sync per second.<span id="debug-menu-7"></span> | ||
===Debug Menu 7<!-- currently not displaying anything will need to check with devs. -->=== | |||
<span id="debug-menu-7"></span> | |||
=== Debug Menu 7 | |||
<span id="debug-menu-8"></span> | 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> | *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> | ||
===Debug Menu 9=== | |||
<span id="debug-menu-9"></span> | |||
=== Debug Menu 9 === | |||
Debug menu 9 displays a panel near users to display their networking stats. | Debug menu 9 displays a panel near users to display their networking stats.<span id="avatar-debug-console"></span> | ||
==Avatar Debug Console== | |||
<span id="avatar-debug-console"></span> | |||
== Avatar Debug Console == | |||
Displays information about your currently warn avatar's animator, and other settings. This Console can be found in the [[vrchat/menus/Action Menu|Action Menu]] in <code>Options>Avatar>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. | Displays information about your currently warn avatar's animator, and other settings. This Console can be found in the [[vrchat/menus/Action Menu|Action Menu]] in <code>Options>Avatar>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. | *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. | |||
* 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> | |||
* Right column: Lists all the layers for each Playable Layer and their current weight and state. | ==Avatar Dynamics Overlay== | ||
<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 [[vrchat/menus/Action Menu|Action Menu]] in <code>Options>Avatar>Avatar Overlay</code> | These options allow you to visualize Avatar Dynamics features like PhysBones, and Contacts. These options can be found in the [[vrchat/menus/Action Menu|Action Menu]] in <code>Options>Avatar>Avatar Overlay</code> | ||
* None: Turns off all the Overlays. | * None: Turns off all the Overlays. | ||
* Physbones Proximity: visualizes Physbones near your hands. | *Physbones Proximity: visualizes Physbones near your hands. | ||
* Physbones: visualizes Physbones on all avatars. | *Physbones: visualizes Physbones on all avatars. | ||
* Contacts: shows all contacts on avatar and their current contact state. | *Contacts: shows all contacts on avatar and their current contact state. | ||
[https://www.youtube.com/watch?v=8hqDquZWvhY Video example] | [https://www.youtube.com/watch?v=8hqDquZWvhY Video example] | ||
<span id="osc-debug-console"></span> | <span id="osc-debug-console"></span> | ||
== OSC Debug Console == | ==OSC Debug Console== | ||
Revision as of 22:17, 7 June 2024
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.]
[Reason: No reason provided.]
Debug Menus
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
Rshift + Tilde + 1-9with the number corresponding to the menu number you want.
Debug Menu 1
Debug menu 1 displays information about your connection to the VRChat API.
Debug Menu 2
Debug menu 2 displays information about the build of VRChat you are using, also shows your fps.
Debug Menu 3
Debug menu 3 displays your output log.
For additional information you can use two launch parameters.
--enable-sdk-log-levels--enable-udon-debug-logging
Debug Menu 4
Debug menu 4 displays stats about users.
- M: Whether or not the user is the master of the instance
- L: Whether or not the user is the local player
- VR: Whether or not the user 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.
- Ping: The user's ping
- Intrvl: The amount of time between the user sending synced data about themselves.
- D: The current delay.
Debug Menu 5
Debug menu 5 displays graphs related to networking.
| alert.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
Debug menu 6 displays all networked objects in the world. Showing networking stats of that object.
- 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.
Debug Menu 7
Debug menu 7 displays the same information as 6, but sorts the objects from highest networking impact to least.
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, orDiscontinuity
Debug Menu 9
Debug menu 9 displays a panel near users to display their networking stats.
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 Options>Avatar>Debug To navigated up and down you can press Page Up to scroll up, and Page Down 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:
- Tracking control: shows if the parts of the avatars body has IK enabled or disabled.
- 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.
