Community:VRCX: Difference between revisions

From VRChat Wiki
Tony Lewis (talk | contribs)
Making baseline, image to be replaced
Hackebein (talk | contribs)
move 3th party api use message, add os info, sort features
 
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{stub}}
[[Category:Empty]]
{{Noticebox/Community}}
{{Noticebox/Community}}
{{Noticebox/Third-party API usage}}
<infobox type="App" theme="community">
<infobox type="App" theme="community">
<group>
<group>
<title source="name"><default>'''VRCX'''</default></title>
<title source="name"><default>VRCX</default></title>
<image source="image"><default>[[File:VRCX_Logo.webp|VRCX]]</default></image>
<image source="image"><default>[[File:VRCX_Logo.webp|VRCX]]</default></image>
<data source="author"><label>Author</label><default>'''VRCX Team'''</default></data>
<data source="author"><label>Author</label><default>VRCX Team</default></data>
      <data source="platforms"><label>Platforms</label><default>'''Windows/Linux'''</default></data>
    <data source="platforms"><label>Platforms</label><default>Windows, Linux, macOS</default></data>
     <data source="languages"><label>Languages</label><default>'''
     <data source="languages"><label>Languages</label><default>English, French, Japanese, Simplified Chinese, Italian, Russian, Spanish, Polish</default></data>
    English
    French
    Japanese
    Simplified Chinese
    Italian
    Russian
    Spanish
    Polish
    '''</default></data>
     <data source="url"><label>URL</label>
     <data source="url"><label>URL</label>
           <default>'''[[https://github.com/vrcx-team/VRCX|"GitHub"]]'''</default>
           <default>[https://github.com/vrcx-team/VRCX GitHub]</default>
           </data>
           </data>
         <header>App history</header>
         <header>App history</header>
         <data source="published"><label>Published</label><default>'''16th Aug 2019'''</default></data>
         <data source="published"><label>Published</label><default>August 16, 2019</default></data>
   </group>
   </group>
</infobox>
</infobox>
VRCX is an assistant/companion application for VRChat that provides information about and helps you accomplish various things related to VRChat in a more convenient fashion than relying on the plain VRChat client (desktop or VR), or website alone.  
'''VRCX''' is a VRChat-focused [[wikipedia:Open source|open-source]] third-party application for Windows, Linux, and macOS, which provides a [[wikipedia:Graphical_user_interface|graphical user interface (GUI)]] for interacting with VRChat via the [[VRChat API]].


It also includes some other neat features outlined below.
==Features==


=Getting Started=
===Friends and social===
Download and install the latest installer (VRCX_Setup.exe) from [[https://github.com/vrcx-team/VRCX/releases/latest|"here"]]
*Manage friends list and organize friend lists outside of VRChat.
*Track friends' online status, world activities, and avatar changes.
*Log when friends were added, when last seen, and time spent together in worlds.
*Monitor name changes and store personal notes to remember how you met.
*View mutual friends and groups on user profiles, with an interactive graph visualization.
*Invite multiple friends to an instance at once using a searchable dialog that shows who is already present.


Beta/nightly build available [[https://vrcx.app/github/nightly|"here"]] or in-app Settings -> General -> Change build.
===Worlds and instances===
*Organize world and group lists outside of VRChat.
*Search for worlds by name, ID, or URL.
*Create and manage a custom local list of favorite worlds (unrestricted).
*View statistics and player details for the current instance.


=Features=
===Avatars===
*Search for avatars using configurable external databases.
*Upload and edit images for avatars and worlds without Unity.
*Edit and update uploaded avatar or world details (name, description, tags) directly through VRCX, without Unity.


'''<big>👪 Friend, world, and avatar list management</big>'''
===Groups===
*Manage your friends list, world/group/avatar lists outside of VRChat.
*Create group instances (Group, Group+, Group Public) with role-based access, queue, and age gate options.
*Monitor the world/avatar activity of your friends and check their online status.
*Create and browse group posts with role-based visibility.
*Keep track of when you first added them and when you last saw them.
*Browse group photo galleries.
*See how much time you've spent together in worlds and how many times.
*Manage group members, roles, and moderation actions.
*Keep track of friend name changes.
*Export group moderation logs as CSV.
*Save notes to help remember how you met.
*Export or import favorite groups.
*Browse upcoming events in a monthly group calendar view.


'''<big>🔌 Automatically launch apps when you start VRChat</big>'''
===Profile===
*You can configure VRCX to launch other apps when you start VRChat.
*Edit status with saved presets for quick switching between status and description combinations.
For example, you could have VRCX launch an OSC app or a voice changer app when VRChat opens up.
*Edit bio, social links, and pronouns.
'''<big>💾 World Persistence</big>'''
*Change profile picture via image upload.
For worlds that support the feature, VRCX can save world settings, save states, inventories, and other data!
Note: To use this feature, you must have "Allow Untrusted URLs" enabled in your VRChat settings.
For Developers: [[https://github.com/vrcx-team/VRCX/wiki/World-Persistence-(PWI)|"Wiki Page - World Persistence (PWI)"]]
'''<big>🔍 Search for avatars, users, worlds, and groups</big>'''


'''<big>🌎 Build a local, unrestricted world favorites list</big>'''
===Notifications===
*Send and receive invites and friend requests directly from VRCX.
*View instance details of invitations received.


'''<big>📷 Store world data in the pictures you take in-game</big>'''
===Media and photos===
*Keep track of the worlds where in-game photos were taken.


You can remember that one world you took those cool pictures in like... 6 months ago!
===Integration and utilities===
*Automatically open companion apps (e.g. OSC tools, voice changers) when VRChat launches.
*Store settings, saved states, inventories, and other persistent data for supported worlds (World Persistence / PWI).
**'''Note''': VRCX's world persistence is unrelated to VRChat's official world persistence. Requires "Allow [[Untrusted URLs]]" in VRChat settings. For developers, see [https://github.com/vrcx-team/VRCX/wiki/World-Persistence-(PWI) World Persistence (PWI)] by VRCX.
*Display detailed information about the current instance in Discord, including thumbnails, names, instance IDs, player counts, and a join button for public lobbies (Enhanced Discord Rich Presence).
**Integrates with [[Community:PyPyDance|PyPyDance]], [[Community:LSMedia|LSMedia]], [[Community:Popcorn Palace|Popcorn Palace]], [[Community:Idle Home|Idle Home]] and [[Community:VRDancing|VRDancing]].
*Access a configurable VR overlay with live notifications and supported event feeds.
*Automatically re-launch VRChat and rejoin the last instance if it crashes.
*View video links and related data for videos playing in the current world.


'''<big>🔔 Monitor/respond to notifications</big>'''
==Keyboard shortcuts==
You can send/receive invites and friend requests from VRCX as well as see the instance info of invites that you receive.
'''<big>📜 See stats/players for your current instance</big>'''


'''<big>📺 See the links to videos and that are playing in the world you're in</big>'''
*Ctrl + Shift + I open Chromium DevTools.
* Ctrl + R restart VRCX.
*Shift + Alt + R reload custom css.


As well as various other logged data.
==Getting started==
Using outdated versions of VRCX may expose you to security vulnerabilities, including [[wikipedia:Arbitrary_code_execution|remote code execution]]<ref>[https://github.com/vrcx-team/VRCX/security/advisories/GHSA-j98g-mgjm-wqph VR Overlay RCE] on GitHub; retrieved September 23, 2024</ref>. Always update to the latest version.


'''<big>📊 Improved Discord Rich Presence</big>'''
# Download and install the latest installer (VRCX_Setup.exe) from [https://github.com/vrcx-team/VRCX/releases/latest here].
You can optionally display more information about your current instance in Discord.
# Beta/nightly build available [https://vrcx.app/github/nightly here,] or in-app: Settings -> General -> Change build.
World integration for popular worlds like PyPyDance, LSMedia, Movies&Chill and VRDancing.
# Linux users can read a guide to run a compatible version on their operating system, [https://github.com/vrcx-team/VRCX/wiki/Running-VRCX-on-Linux here].
This includes the world thumbnail, name, instance ID, and player count, depending on your settings and whether the lobby is private.  
# For Android users, there are similar alternatives for VRCX available, such as [https://github.com/Nyabsi/VRCAA VRCAA].
You can also add a join button for public lobbies!
'''<big>🔮 VR Overlay with configurable live feed of all supported events/notifications</big>'''


'''<big>📤 Upload avatar/world images without Unity</big>'''
==Configuration and launch parameters==
===Launch parameters===
{| class="wikitable"
|-
| --debug
|Launch Chromium DevTools with VRCX.
|-
| --config="C:\VRCX"
|Set a custom path for VRCX's config folder. Default: %appdata%\VRCX
|-
| --proxy-server="127.0.0.1:8080"
|Set a HTTP/SOCKS proxy server for VRCX to use.
|}


'''<big>📄 Manage and edit uploaded avatar/world details without Unity</big>'''
===Protocol/Launch commands===
{| class="wikitable"
|-
|vrcx://user/usr_id
|Open VRCX user dialog.
|-
|vrcx://avatar/avtr_id
|Open VRCX avatar dialog.
|-
| vrcx://group/grp_id
|Open VRCX group dialog.
|-
|vrcx://world/wrld_id
|Open VRCX world dialog.
|-
|vrcx://world/wrld_id:12345
|Open VRCX world dialog with instance.
|-
|vrcx://world/https://vrch.at/0gmbxjpj<nowiki/>
|Open VRCX world dialog with unlocked instance.
|-
|vrcx://import/avatar/avtr_id,avtr_id...
|Open VRCX avatar favorites import dialog.
|-
| vrcx://import/world/wrld_id,wrld_id...
|Open VRCX world favorites import dialog.
|-
|vrcx://import/friend/usr_id,usr_id...
|Open VRCX friend favorites import dialog.
|-
|vrcx://addavatardb/https://website/vrcx_search.php<nowiki/>
|Open VRCX remote avatar database provider dialog.
|}


'''<big>💀 Automatically restart and join last instance when VRC crashes</big>'''
===VRCX.json===


'''<big>↔️ Export/import favorite groups</big>'''
* VRCX_DatabaseLocation set a custom path for SQLite database, e.g. C:\\VRCX.sqlite3
**NOTE when moving your VRCX.sqlite3 database be sure to move VRCX.sqlite3-shm and VRCX.sqlite3-wal as well, if they exist.
** NOTE be sure to replace every backslash in the path with 2 backslashes to insure the JSON is valid.
* VRCX_ProxyServer set a HTTP/SOCKS proxy server for VRCX to use, e.g. 127.0.0.1:8080


=Miscellanous=
==Gallery==
*Want a new look for VRCX? Check out [[https://github.com/vrcx-team/VRCX/wiki/Themes|"Themes"]]
<gallery widths="225" heights="170">
*See [[https://github.com/vrcx-team/VRCX/wiki/Building-from-source|"Building from source"]] for instructions on how to build VRCX from source.
File:VRCX_Login1.webp|Login Screen
*For a guide on how to run VRCX on linux, see [[https://github.com/vrcx-team/VRCX/wiki/Running-VRCX-on-Linux|"here"]]
File:VRCX_Login2.webp|2FA Supported
File:VRCX_Feed.webp|Feed Screen
File:VRCX_GameLogs.webp|Game Log Screen
File:VRCX_User_Info.webp|User Info (Own)
File:VRCX_Friend_Info.webp|User Info (Friends)
File:VRCX_World1.webp|World Info (Instance Tab)
File:VRCX_World2.webp|World Info (Info Tab)
File:VRCX_Favorite_Friend.webp|Favorite (Friends)
File:VRCX_Favorite_World.webp|Favorite (Worlds)
File:VRCX_Favorite_Avatar.webp|Favorite (Avatars)
File:VRCX_Friend_Log.webp|Friend Log
File:VRCX_discord_presence.webp|Discord Rich Presence
</gallery>


=Is VRCX against VRChat's TOS?=
==See also==
'''No.'''
*[[Community:VRCNext|VRCNext]]
*[[Community:Manage VRChat|Manage VRChat]]
*[[VRChat API]]


VRCX is an external tool that uses the VRChat API to provide the features it does.
==References==
{{reflist}}


It does not modify the game in any way, only using the API responsibly to provide the features it does. It is not a mod, or a cheat, or any other form of modification to the game.
[[Category:English]]
 
[[Category:French]]
To see VRChat's stance on API usage, see the #faq channel in the VRChat Discord.
[[Category:Japanese]]
 
[[Category:Chinese]]
=Disclosure=
[[Category:Italian]]
VRCX is not endorsed by [[VRChat|VRChat]] and does not reflect the views or opinions of VRChat or anyone officially involved in producing or managing VRChat properties. VRChat and all associated properties are trademarks or registered trademarks of VRChat Inc. [[VRChat|VRChat]] © [[VRChat|VRChat]] Inc.
[[Category:Russian]]
 
[[Category:Spanish]]
=Screenshot=
[[Category:Polish]]
<gallery widths="330" heights="250">
[[Category:Third-party applications]]
File:VRCX_Logo.webp|Placeholder,to be replaced
[[Category:Resources]]
File:VRCX_Logo.webp|Placeholder,to be replaced
[[Category:Assets available via GitHub]]
File:VRCX_Logo.webp|Placeholder,to be replaced
File:VRCX_Logo.webp|Placeholder,to be replaced
File:VRCX_Logo.webp|Placeholder,to be replaced
File:VRCX_Logo.webp|Placeholder,to be replaced
File:VRCX_Logo.webp|Placeholder,to be replaced
</gallery>

Latest revision as of 01:12, 6 April 2026

V · ECommunity-written content
The following was created by the community. It may contain material not directly endorsed by the VRChat team. To learn more, consider reading Contributing to the VRChat Wiki.
V · EThird-party API application
This application uses the VRChat API and may require your VRChat account credentials. VRChat, Inc. advises against sharing credentials with third-party applications that do not use official SSO authentication. See VRChat's Creator Guidelines for details.

VRCX is a VRChat-focused open-source third-party application for Windows, Linux, and macOS, which provides a graphical user interface (GUI) for interacting with VRChat via the VRChat API.

Features

Friends and social

  • Manage friends list and organize friend lists outside of VRChat.
  • Track friends' online status, world activities, and avatar changes.
  • Log when friends were added, when last seen, and time spent together in worlds.
  • Monitor name changes and store personal notes to remember how you met.
  • View mutual friends and groups on user profiles, with an interactive graph visualization.
  • Invite multiple friends to an instance at once using a searchable dialog that shows who is already present.

Worlds and instances

  • Organize world and group lists outside of VRChat.
  • Search for worlds by name, ID, or URL.
  • Create and manage a custom local list of favorite worlds (unrestricted).
  • View statistics and player details for the current instance.

Avatars

  • Search for avatars using configurable external databases.
  • Upload and edit images for avatars and worlds without Unity.
  • Edit and update uploaded avatar or world details (name, description, tags) directly through VRCX, without Unity.

Groups

  • Create group instances (Group, Group+, Group Public) with role-based access, queue, and age gate options.
  • Create and browse group posts with role-based visibility.
  • Browse group photo galleries.
  • Manage group members, roles, and moderation actions.
  • Export group moderation logs as CSV.
  • Export or import favorite groups.
  • Browse upcoming events in a monthly group calendar view.

Profile

  • Edit status with saved presets for quick switching between status and description combinations.
  • Edit bio, social links, and pronouns.
  • Change profile picture via image upload.

Notifications

  • Send and receive invites and friend requests directly from VRCX.
  • View instance details of invitations received.

Media and photos

  • Keep track of the worlds where in-game photos were taken.

Integration and utilities

  • Automatically open companion apps (e.g. OSC tools, voice changers) when VRChat launches.
  • Store settings, saved states, inventories, and other persistent data for supported worlds (World Persistence / PWI).
    • Note: VRCX's world persistence is unrelated to VRChat's official world persistence. Requires "Allow Untrusted URLs" in VRChat settings. For developers, see World Persistence (PWI) by VRCX.
  • Display detailed information about the current instance in Discord, including thumbnails, names, instance IDs, player counts, and a join button for public lobbies (Enhanced Discord Rich Presence).
  • Access a configurable VR overlay with live notifications and supported event feeds.
  • Automatically re-launch VRChat and rejoin the last instance if it crashes.
  • View video links and related data for videos playing in the current world.

Keyboard shortcuts

  • Ctrl + Shift + I open Chromium DevTools.
  • Ctrl + R restart VRCX.
  • Shift + Alt + R reload custom css.

Getting started

Using outdated versions of VRCX may expose you to security vulnerabilities, including remote code execution[1]. Always update to the latest version.

  1. Download and install the latest installer (VRCX_Setup.exe) from here.
  2. Beta/nightly build available here, or in-app: Settings -> General -> Change build.
  3. Linux users can read a guide to run a compatible version on their operating system, here.
  4. For Android users, there are similar alternatives for VRCX available, such as VRCAA.

Configuration and launch parameters

Launch parameters

--debug Launch Chromium DevTools with VRCX.
--config="C:\VRCX" Set a custom path for VRCX's config folder. Default: %appdata%\VRCX
--proxy-server="127.0.0.1:8080" Set a HTTP/SOCKS proxy server for VRCX to use.

Protocol/Launch commands

vrcx://user/usr_id Open VRCX user dialog.
vrcx://avatar/avtr_id Open VRCX avatar dialog.
vrcx://group/grp_id Open VRCX group dialog.
vrcx://world/wrld_id Open VRCX world dialog.
vrcx://world/wrld_id:12345 Open VRCX world dialog with instance.
vrcx://world/https://vrch.at/0gmbxjpj Open VRCX world dialog with unlocked instance.
vrcx://import/avatar/avtr_id,avtr_id... Open VRCX avatar favorites import dialog.
vrcx://import/world/wrld_id,wrld_id... Open VRCX world favorites import dialog.
vrcx://import/friend/usr_id,usr_id... Open VRCX friend favorites import dialog.
vrcx://addavatardb/https://website/vrcx_search.php Open VRCX remote avatar database provider dialog.

VRCX.json

  • VRCX_DatabaseLocation set a custom path for SQLite database, e.g. C:\\VRCX.sqlite3
    • NOTE when moving your VRCX.sqlite3 database be sure to move VRCX.sqlite3-shm and VRCX.sqlite3-wal as well, if they exist.
    • NOTE be sure to replace every backslash in the path with 2 backslashes to insure the JSON is valid.
  • VRCX_ProxyServer set a HTTP/SOCKS proxy server for VRCX to use, e.g. 127.0.0.1:8080

Gallery

See also

References

  1. VR Overlay RCE on GitHub; retrieved September 23, 2024