VRChat Wiki - User contributions [en]

Debug Menu

2024-08-10T20:32:04Z

VEvQSNOgXh: Debug menus specifically related to players not users, replace usages of user with player

{{Noticebox/official}}
=Debug Menus=
Debug Menus and consoles 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 <code>Options > Avatar > 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.
==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 > Avatar > 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''.
==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 [[Action Menu]] in <code>Options > OSC > 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 {{VRC link|https://docs.vrchat.com/docs/osc-debugging|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 <code>--enable-debug-gui</code>.
*Press <code>Right Shift + Tilde (~) + 1-9</code> with the number corresponding to the menu number you want.

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]]

===Debug Menu 2===
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]]

===Debug Menu 3 ===

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, if you're using VRChat on Steam or SteamVR:

*<code>--enable-sdk-log-levels</code>
*<code>--enable-udon-debug-logging</code>
[[File:World Debug Menu 3.png|none|thumb|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.
[[File:World Debug Menu 4.png|none|thumb|Screenshot of World Debug Menu 4]]

===Debug Menu 5===

Debug Menu 5 displays graphs related to networking.
[[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}}

===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.
[[File:World Debug Menu 6.png|none|thumb|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 <code>Should Sleep</code>, <code>Player</code>, <code>Held</code>, or <code>Discontinuity</code>
[[File:World Debug Menu 8.png|none|thumb|Screenshot of World Debug Menu 8]]

===Debug Menu 9===

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]]

==Official Resources==
*{{VRC link|https://creators.vrchat.com/worlds/udon/world-debug-views|World Debug Views}} page in the VRChat Documentation
*{{VRC link|https://docs.vrchat.com/docs/osc-debugging|OSC Debugging}} page in the VRChat Documentation.

Instances

2024-08-03T03:03:13Z

VEvQSNOgXh: expanded information on instance owner and world author moderation powers

{{Stub}}{{noticebox/official}}'''Instances''' are unique sessions for a [[world]]. Users can create and join instances of a world, and users in the same instance can perceive and interact with each other in the shared world space, but not with users in other instances of the same world. Instances themselves can have specific properties that affect who is allowed to join, invite, or see who is in the instance. They also have a region, which correlates to a real world server that handles passing connection information between the users in the session.

==Instance Types==
There are many public and private environments of all genres that the user can explore. Users may also create and join various community groups to meet other users with mutual interests. Users can choose to join a public instance, or create a private instance to be alone or invite friends after adding them. The type of privacy of created instances is up to the user, and follows under the various tiers:
{| class="wikitable"
|+
!'''Public'''
|A publicly listed instance to which anyone can join.
|-
!'''Friends+'''
|Your friends, and their friends, and so on can join.
|-
!'''Friends'''
|Only your friends may join; friends of friends are excluded.
|-
!'''Invite+'''
|Users and friends of users must request to join your instance, unless you or an invited user's social status is set to "Join Me".
|-
!'''Invite'''
|Users must send a join request to join you, unless your social status is set to "Join Me"; friends of friends are excluded.
|-
!'''Group'''
|An instance that only members of a group, or specific roles within that group can access.
|-
!'''Group+'''
|An instance hosted by a group, in which friends of group members, friends of their friends, and so on, can join. Group+ instances may have appointed group moderators to manage an instance. Being a member of the hosting group is not required to join the instance.
|-
!'''Group Public'''
|A publicly listed instance, hosted by a group, to which anyone can join. Group Public instances may have appointed group moderators to manage an instance.
|}
{| class="wikitable"
|+Who can join specific instance types
!
!Anyone
!User
friends
!Invited
user

friends
!Owner
friends
!Invited
owner

friends
!Selected
group role

members
!All group
members
|-
!Public
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" | -
| style="text-align:center;" | -
|-
!Friends+
| style="text-align:center;" |
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" | -
| style="text-align:center;" | -
|-
!Friends
| style="text-align:center;" |
| style="text-align:center;" |
| style="text-align:center;" |
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" | -
| style="text-align:center;" | -
|-
!Invite+
| style="text-align:center;" |
| style="text-align:center;" |
| style="text-align:center;" |✔️
| style="text-align:center;" |
| style="text-align:center;" |✔️
| style="text-align:center;" | -
| style="text-align:center;" | -
|-
!Invite
| style="text-align:center;" |
| style="text-align:center;" |
| style="text-align:center;" |
| style="text-align:center;" |
| style="text-align:center;" |✔️
| style="text-align:center;" | -
| style="text-align:center;" | -
|-
!Group
| style="text-align:center;" |
| style="text-align:center;" |
| style="text-align:center;" |
| style="text-align:center;" | -
| style="text-align:center;" | -
| colspan="2" style="text-align:center;" |✔️1
|-
!Group+
| style="text-align:center;" |
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" | -
| style="text-align:center;" | -
| style="text-align:center;" | -
| style="text-align:center;" |✔️
|-
!Group Public
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" |✔️
| style="text-align:center;" | -
| style="text-align:center;" | -
| style="text-align:center;" | -
| style="text-align:center;" |✔️
|}
''1 All or selected roles ("Join Group Instances" group role permission required).''

===Public Instances===
Public instances are considered easily accessible and include Public and Group Public types.<ref name=":0">https://hello.vrchat.com/community-guidelines</ref>

===Private Instances===
Private instances require an invitation or a way to get in and include Friends, Friends+, Invite, Invite+, Group, and Group+ types.<ref name=":0" />

===Group Instances ===
Group instances are created by a group and include Group Public, Group+, and Group types.

==Regions==
Whilst selecting an instance type, there are choices for varying regions to better optimize their experience. Choosing an instance closest to your location will see a decrease in [[Terminology#Ping|ping]], and ensuring a more stable connection to the instance, preventing disconnections and lag.

Historically, VRChat ran solely on the U.S. West server. On June 16, 2021, two extra regions - '''Europe, and Japan''' were added to the platform in the {{VRC link|https://docs.vrchat.com/docs/vrchat-202124|Regions update}}<ref>https://docs.vrchat.com/docs/vrchat-202124</ref> to distribute server load, and offset increasing user count. On December 1, 2021, VRChat added the '''U.S. East'''<ref>https://docs.vrchat.com/docs/vrchat-202142</ref> region, and renamed the current USA server to ''''U.S. West'''<nowiki/>'. Users are also encouraged to check VRChat's {{VRC link|https://status.vrchat.com|server status}} website or their [https://x.com/VRChat_Status VRChat Status account] on social media for outages, or upon discovering issues when connecting to VRChat.
{| class="wikitable"
|+
!Token
!Region
!Location
|-
|usw
|U.S. West
|San José
|-
|use
|U.S. East
|Washington D.C.
|-
|eu
|Europe
|Amsterdam
|-
|jp
|Japan
|Tokyo
|}

== Instance Owner ==
An owner of an instance is its creator and depending on its type can be either a user or a group. Instance owner cannot be changed.

Instance owners have permission to moderate users, including kicking, warning or muting them. In case of a group instance, moderators and their powers depend on [[Groups#Group Roles and Permissions|group roles and permissions]].

Instances of Public type do not have an instance owner leaving the only user with comparable powers being the world author.
{| class="wikitable"
|+
!Instance type
|'''Public'''
|'''Friends+'''
|'''Friends'''
|'''Invite+'''
|'''Invite'''
|'''Group Public'''
|'''Group+'''
|'''Group'''
|-
!Instance owner
|None
|User
|User
|User
|User
|Group
|Group
|Group
|}

== World Author ==
The author of the world has the same core set of powers as the instance author, being able to moderate users in the form of kicking, warning and muting. The author has these additional powers depending on instance type.
{| class="wikitable"
|+
!Instance type
|'''Public'''
|'''Friends+'''
|'''Friends'''
|'''Invite+'''
|'''Invite'''
|'''Group Public'''
|'''Group+'''
|'''Group'''
|-
|Has powers
|Yes
|Yes
|Yes
|Yes
|Yes
|Yes
|No
|No
|}

==References==

<references />

Talk:Worlds

2024-08-02T01:22:10Z

VEvQSNOgXh: reply to USW edit comment

== Instance Regions ==
Is it USE (US East), USW (US West), EU (Europe), JP (Japan)
 
or
 
US (USA), EU (Europe), JP (Japan)
 
in-game it is the former, if there is a source on this pls link it somewhere.
[[User:Usr 6909a532-22e9-49f7-81e3-e964fe7dc00a|Usr 6909a532-22e9-49f7-81e3-e964fe7dc00a]] ([[User talk:Usr 6909a532-22e9-49f7-81e3-e964fe7dc00a|talk]]) 00:35, 2 August 2024 (UTC)

: Hello, I have added references for the Regions update, and the update for 2021.4.2, which includes U.S. East region. I originally thought U.S. East was included in the original Regions update, but I was mistaken. I have gone back to correct this. Thanks for catching this! [[User:Usr 8ee44c1a-f905-4e08-bb61-e1cd34e09fc0|Usr 8ee44c1a-f905-4e08-bb61-e1cd34e09fc0]] ([[User talk:Usr 8ee44c1a-f905-4e08-bb61-e1cd34e09fc0|talk]]) 00:33, 2 August 2024 (UTC)

:It's the former in terms of visible listed shorthand names, ''however'' when constructing an instance id it's slightly different, USW is "us", so ~region(us) rather than ~region(usw) which would invalid syntax though may work as USW is the default region. This being the case as USE did not exist until much later. I'm not sure on a source outside myself (I wrote the the regions system) --[[User:VEvQSNOgXh|VEvQSNOgXh]] ([[User talk:VEvQSNOgXh|talk]]) 00:40, 2 August 2024 (UTC)

:To expand on "Historically, VRChat ran solely on the U.S. West server." a little titbit is this wasn't always the case, prior to the beginning of 2018 VRChat ran out of US East. The switch occurred when moving to a beefier setup as the massive surge in users at the time caused the region to fail.--[[User:VEvQSNOgXh|VEvQSNOgXh]] ([[User talk:VEvQSNOgXh|talk]]) 00:51, 2 August 2024 (UTC)
:: A source for this is https://docs.vrchat.com/docs/patch-notes-pre-2018#vrchat-0120p10, this would have been the update the switch occurred in--[[User:VEvQSNOgXh|VEvQSNOgXh]] ([[User talk:VEvQSNOgXh|talk]]) 01:07, 2 August 2024 (UTC)

:If you (or someone else) could give us an external source or something it would help us a lot. It does sound right the way you describe it here, but this is also out of my scope unfortunately. That is why I initially rejected your edit to make USW and USE into just US. [[User:Usr 6909a532-22e9-49f7-81e3-e964fe7dc00a|Usr 6909a532-22e9-49f7-81e3-e964fe7dc00a]] ([[User talk:Usr 6909a532-22e9-49f7-81e3-e964fe7dc00a|talk]]) 01:09, 2 August 2024 (UTC)
::USW and USE should not be merged it's that specifically for USW the shortcode when creating an instance is "us" not "usw", in it's display it's still USW, initially when reading I assumed it was referring to that particular shortcode not the displayed shorthand, so it was right to reject unless another column were to be added listing the shortcodes for each region.--[[User:VEvQSNOgXh|VEvQSNOgXh]] ([[User talk:VEvQSNOgXh|talk]]) 01:22, 2 August 2024 (UTC)

Talk:Worlds

2024-08-02T00:51:02Z

VEvQSNOgXh: reply to how regions are setup

Talk:Worlds

2024-08-02T00:40:52Z

VEvQSNOgXh: reply to how regions are setup

Worlds

2024-08-02T00:14:08Z

VEvQSNOgXh: fixed incorrect region details

{{noticebox/official}}
Worlds are the virtual spaces inhabited by users on the VRChat platform within, which you can interact with both users, and the environment. VRChat worlds can be created by members of the community, and are uploaded publicly or privately to the platform using the [[VRChat SDK]], intended for others to join.

There's a variety of world types covering topics ranging from social hangouts, games, avatar showcases, scenic views, and more. Each world can have multiple copies running at the same time referred to as "instances", which have a global region they're linked to, a maximum user capacity set by the world author, and an instance type which controls who can join and moderate the world instance.
=Finding and Joining Worlds=
When you launch VRChat, you will begin in your '''Home''' world, which is an Invite-only instance in the [[VRChat Home]] by default. Your Home world and instance type for your Home world can be changed at any time. One can also choose to log into the VRChat website, or use the main page of VRChat on Mobile to browse worlds, and launch VRChat.
==Using the Menu==
When opening the [[Quick Menu]], there's a few different routes you can take to join a new world.
=="Worlds" Quick Link / Tab==
Using the Quick Links tile for '''Worlds''' will take you to the [[Main Menu|main]] page, displaying VRCat's Variety Box, which features a random selection from various different world categories. On the left you can select a specific world category such as "Trending", "Avatar Worlds - Trending", "Games - Active", "New & Noteworthy", and etc. This can be useful for quickly finding popular worlds in different categories. Clicking on a world tile here will take you to the detailed menu page for that world, giving you options to select an existing instance to join or to create a new one, and to either join directly or drop a world portal. Each world is represented with a [[World Thumbnail|thumbnail]], giving insight to its contents.

When anywhere on the main menu, you can also get to this page by using the World tab at the bottom.
==Search==
From the Worlds page you can use the "Search" feature to search for a specific world by title, description, tag, author, and etc. These can also be sorted by Relevance, Last Updated, and Popular.

When anywhere on the main menu, you can also get to this page by using the Search tab at the bottom.
=Portals=
{{Main|Portals}}
Portals provide a quick way for users to access a specific world and instance without having to individually find it through the menu. The portal will effect displays the world image inside of itself, and they will usually have the title above alongside other details such as user capacity and region. By default walking into the portal will transfer you to the associated world, but settings can be changes so that it requires user confirmation to prevent accidentally using them. Portals come in two varieties:
==Static Portals==
Worlds themselves often have portals that they themselves feature to serve as a link to other worlds. These are part of the world, and as such usually stay there permanently, ready for people to interact with.
==User Placed Portals==
Users can place portals to a world instance using the menu. These look appear the same as static portals, except they can be placed by the user anywhere in the world that is convenient and that the world allows (they can't be placed on users or on a spawn area), and they feature a countdown timer above them. Once the timer expires, the portal disappears.
=Instance Types=
There are many public and private environments of all genres that the user can explore. You may also create and join various community groups to meet other users with mutual interests. Users can choose to join a public instance, or create a private instance to be alone or invite friends after adding them. The type of privacy of created instances is up to the user, and follows under the various tiers:

* '''Public''' - Anyone can join.
* '''Friends+''' - Your friends, and their friends, and so on can join.
* '''Friends''' - Only your friends may join; friends of friends are excluded.
* '''Invite+''' - Users and friends of users must request to join your instance, unless you or an invited user's social status is set to "Join Me".
* '''Invite''' - Users must send a join request to join you, unless your social status is set to "Join Me"; friends of friends are excluded.
* '''Group''' - An instance that only members of a group, or specific roles within that group can access.
* '''Group+''' - An instance hosted by a group, in which friends of group members, friends of their friends, and so on, can join. Group+ instances may have appointed group moderators to manage an instance. Being a member of the hosting group is not required to join the instance.
* '''Group Public''' - A publicly listed instance, hosted by a group, to which anyone can join. Group Public instances may have appointed group moderators to manage an instance.

==Regions==
Whilst selecting an instance type, there are choices for varying regions to better optimize their experience. Choosing an instance closest to your location will see a decrease in [[Terminology#Ping|ping]], and ensuring a more stable connection to the instance, preventing disconnections and lag.

Historically, VRChat ran solely on the U.S. West server. On June 16, 2021, three extra regions were added to the platform in the {{VRC link|https://docs.vrchat.com/docs/vrchat-202124|Regions update}} to distribute server load, and offset increasing user count. Users are also encouraged to check VRChat's {{VRC link|https://status.vrchat.com|server status}} website or their [https://x.com/VRChat_Status VRChat Status account] on social media for outages, or upon discovering issues when connecting to VRChat.
{| class="wikitable"
|+
!Token
!Region
!Location
|-
|usw
|U.S. West
|San José
|-
|use
|U.S. East
|Washington D.C.
|-
|eu
|Europe
|Amsterdam
|-
|jp
|Japan
|Tokyo
|}


[[Category:Features]]