Community:VRCX: Difference between revisions

From VRChat Wiki
← Older edit
VisualWikitext
Tony Lewis (talk | contribs)
automoderated, Community Moderators, Interface administrators
899 edits
Add launch parms + json
Hackebein (talk | contribs)
Community Moderators, Interface administrators
1,527 edits
move 3th party api use message, add os info, sort features
 
(27 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>'''
 
As well as various other logged data.
 
'''<big>📊 Improved Discord Rich Presence</big>'''
You can optionally display more information about your current instance in Discord.
World integration for popular worlds like PyPyDance, LSMedia, Movies&Chill and VRDancing.
This includes the world thumbnail, name, instance ID, and player count, depending on your settings and whether the lobby is private.
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>'''
 
'''<big>📄 Manage and edit uploaded avatar/world details without Unity</big>'''
 
'''<big>💀 Automatically restart and join last instance when VRC crashes</big>'''
 
'''<big>↔️ Export/import favorite groups</big>'''
 
=Miscellanous=
*Want a new look for VRCX? Check out [https://github.com/vrcx-team/VRCX/wiki/Themes| Themes]
*See [https://github.com/vrcx-team/VRCX/wiki/Building-from-source| Building from source] for instructions on how to build VRCX from source.
*For a guide on how to run VRCX on linux, see [https://github.com/vrcx-team/VRCX/wiki/Running-VRCX-on-Linux| here]
*If you looking for VRCX on Android, there is third-party project, see [https://github.com/Nyabsi/VRCAA| here]
=Common Issues=
'''<big>VRCX wont open or opens to a white screen</big>'''
 
This can be caused by a many different things here's a list of things to try:
 
*Install Microsoft Visual C++ Redistributable 2019.
*Reboot your computer, maybe another process is trying to read the database file.
*Disable antivirus software, Avast and AVG are known to delete Cef/VRCX.
*Remove AVerMedia AssistCentral this is known to cause problems with VRCX for some unknown reason.
*Run VRCX as administrator, this can fix it on some rare occasions.
*Test a fresh database, first close VRCX then backup your current database by opening %AppData% and renaming the VRCX folder to something like VRCX.Backup, if this solves it but you'd like to still keep your data follow the steps bellow on how to repair your database.
 
'''<big>VRCX running slow</big>'''
 
*Settings > Appearance > Max Table Size
*Lower this value to something like 100 this will decrease the amount of table entries *Settings > Advanced > Auto Clear Cache
*Lower this interval to something like 3 hours this will decrease the amount of unnecessary worlds, users and avatars stored in RAM.
 
'''<big>SteamVR Overlay not working</big>'''
 
*Disable SteamVR safe mode.
*If your computer has an iGPU follow these steps.
 
'''<big>How to repair VRCX database</big>'''
 
    '''Method.1'''
 
*Close VRCX.
*Install DB Browser for SQLite.
*File > Open Database...
*Browse to %AppData%\VRCX\ then select VRCX.sqlite3.
*File > Export > Database to SQL file...
*Click Save and place the file somewhere.
*File > Close Database
*Rename VRCX.sqlite3 in %AppData%\VRCX\ to something like Backup.sqlite3.
*File > Import > Database from SQL file...
*It will immediately ask you where to save the newly created database, save it in %AppData%\VRCX\ as VRCX.sqlite3.
*File > Write Changes.
*Close DB Browser and delete the no longer needed VRCX.sqlite3.sql export file.
*Start using VRCX as usual.
 
    '''Method.2 (if method.1 not works)'''
 
*Close VRCX.
*Rename VRCX.sqlite3 in %AppData%\VRCX\ to something like Backup.sqlite3.
*Install DB Browser for SQLite.
*File > Open Database...
*Browse to %AppData%\VRCX\ then select Backup.sqlite3.
*File > Save Database As
*It will immediately ask you where to save the newly created database, save it in %AppData%\VRCX\ as VRCX.sqlite3.
*Close DB Browser and start using VRCX as usual.
 
=Keyboard Shorcuts=


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


=Launch parameters & VRCX.json=
==Getting started==
'''<big>VRCX Launch parameters</big>'''
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.


*--debug launch Chromium DevTools with VRCX.
# Download and install the latest installer (VRCX_Setup.exe) from [https://github.com/vrcx-team/VRCX/releases/latest here].
*--config="C:\VRCX" set a custom path for VRCX's config and database.
# Beta/nightly build available [https://vrcx.app/github/nightly here,] or in-app: Settings -> General -> Change build.
*--proxy-server="127.0.0.1:8080" set a HTTP/SOCKS proxy server for VRCX to use.
# 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].
# For Android users, there are similar alternatives for VRCX available, such as [https://github.com/Nyabsi/VRCAA VRCAA].


'''<big>VRCX Protocol/Launch Commands</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.
|}


*vrcx://user/usr_id open VRCX user dialog.
===Protocol/Launch commands===
*vrcx://avatar/avtr_id open VRCX avatar dialog.
{| class="wikitable"
*vrcx://group/grp_id open VRCX group dialog.
|-
*vrcx://world/wrld_id open VRCX world dialog.
|vrcx://user/usr_id
*vrcx://world/wrld_id:12345 open VRCX world dialog with instance.
|Open VRCX user dialog.
*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://avatar/avtr_id
*vrcx://import/world/wrld_id,wrld_id... open VRCX world favorites import dialog.
|Open VRCX avatar 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://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>VRCX.json</big>'''
===VRCX.json===


*VRCX_DatabaseLocation set a custom path for SQLite database, e.g. C:\\VRCX.sqlite3
* 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 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.
** 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
* VRCX_ProxyServer set a HTTP/SOCKS proxy server for VRCX to use, e.g. 127.0.0.1:8080
 
=Is VRCX against VRChat's TOS?=
'''No.'''
 
VRCX is an external tool that uses the VRChat API to provide the features it does.
 
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.
 
To see VRChat's stance on API usage, see the #faq channel in the VRChat Discord.


=Disclosure=
==Gallery==
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.
<gallery widths="225" heights="170">
 
=Screenshot=
<gallery widths="330" heights="250">
File:VRCX_Login1.webp|Login Screen
File:VRCX_Login1.webp|Login Screen
File:VRCX_Login2.webp|2FA Supported
File:VRCX_Login2.webp|2FA Supported
Line 203: Line 152:
File:VRCX_Favorite_Avatar.webp|Favorite (Avatars)
File:VRCX_Favorite_Avatar.webp|Favorite (Avatars)
File:VRCX_Friend_Log.webp|Friend Log
File:VRCX_Friend_Log.webp|Friend Log
File:VRCX_discord_presence.webp|discord Rich Prensence
File:VRCX_discord_presence.webp|Discord Rich Presence
</gallery>
</gallery>
==See also==
*[[Community:VRCNext|VRCNext]]
*[[Community:Manage VRChat|Manage VRChat]]
*[[VRChat API]]
==References==
{{reflist}}
[[Category:English]]
[[Category:French]]
[[Category:Japanese]]
[[Category:Chinese]]
[[Category:Italian]]
[[Category:Russian]]
[[Category:Spanish]]
[[Category:Polish]]
[[Category:Third-party applications]]
[[Category:Resources]]
[[Category:Assets available via GitHub]]

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

  • Login Screen
    Login Screen
  • 2FA Supported
    2FA Supported
  • Feed Screen
    Feed Screen
  • Game Log Screen
    Game Log Screen
  • User Info (Own)
    User Info (Own)
  • User Info (Friends)
    User Info (Friends)
  • World Info (Instance Tab)
    World Info (Instance Tab)
  • World Info (Info Tab)
    World Info (Info Tab)
  • Favorite (Friends)
    Favorite (Friends)
  • Favorite (Worlds)
    Favorite (Worlds)
  • Favorite (Avatars)
    Favorite (Avatars)
  • Friend Log
    Friend Log
  • Discord Rich Presence
    Discord Rich Presence

See also

References

  1. ↑ VR Overlay RCE on GitHub; retrieved September 23, 2024
Retrieved from "https://wiki.vrchat.com/index.php?title=Community:VRCX&oldid=67397"