lumio4u / vrcx

manage your friendship of VRChat

VRCX

VRCX is an assistant application for VRChat that provides information about and managing friendship. This application makes use of the unofficial VRChat API SDK.

VRCX is not endorsed by 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 Inc.

pypy & Natsumi are not responsible for any problems caused by VRCX. Use at your own risk!

How to install VRCX

• Download latest release setup from here.
• Run VRCX_Setup.exe.

Is VRCX against VRChat ToS?

TL;DR: no.

VRChat's official stance on usage of the API, as listed in their Discord #faq channel.

Screenshots

Screenshot(click to open)

Login

Feed

GameLog

UserInfo

Me

Friend

World

Favorite

Friend

World

Avatar

FriendLog

Moderation

Notification

PlayerList

Settings

General

Appearance

Notifications

Wrist Overlay

Discord Presence

Advanced

Other

Join

Create Instance

Discord Rich Presence

VR Overlay(old)

Themes

To install a theme place custom.css into your %AppData%\VRCX folder then press Shift + Alt + R.

Dark Vanilla by MintLily

Pink Theme by Kamiya

Material 3 by Kamiya

VRCX launch parameters

• --debug launch Chromium DevTools with VRCX.
• --config="C:\VRCX.sqlite3" set a custom path for VRCX database.
• --gpufix set VRCX overlay rendering GPU to index 1 forcing the overlay to render to a secondary dedicated GPU or if you're using an integrated GPU it will force rendering to your dedicated GPU.
• 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.

Keyboard shortcuts

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

Common issues

VRCX running slow

• Settings > Appearance > Max Table Size
  • Lower this value to something like 100 this will decrease the amount of table entries stored in RAM.
• 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.

VRCX opens to a white screen

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.
• Unstable RAM can be a potential cause, remove any RAM overclock and run MemTest86.
• 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%\VRCX\ and renaming VRCX.sqlite3 to something like Backup.sqlite3, if this solves it but you'd like to still keep your data follow the steps bellow on how to repair your database.

SteamVR Overlay not working

• Try launch VRCX with the launch parameter --gpufix.
• Disable SteamVR safe mode.
• If your computer has an iGPU follow these steps.

How to repair VRCX database

• 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...
• Click Yes to creating a new database.
• Save it in %AppData%\VRCX\ as VRCX.sqlite3.
• File > Write Changes.
• Close DB Browser and delete the no longer needed *.sql export file.

How to run VRCX on Linux

Guide made by RinLovesYou

• Installing Wine

  • Arch Linux: Wine can be installed by enabling the multilib repository and running sudo pacman -S wine

  • Ubuntu: Please refer to the wiki

• Winetricks Magic

  It is imperative that you are using Wine 7.0rc5 or later! this has not been tested on earlier versions. Wine 7.0 Finally allows for full installation of the .net framework, which is needed for VRCX to function.

  • Start over with a clean wine prefix. Either create one for VRCX or rm -rf ~/.wine and use the main prefix.

  • Ensure you are NOT using DXVK either within your prefix or for your VRCX.exe. VRCX requires WineD3D to operate.

  • winetricks --force -q dotnet472 corefonts Silent and easy automation of the process of installing dependencies.

  • wine winecfg -v win10 Set your prefix windows version.

  • You will require the Linux branch as CEF newer than 108 is currently incompatible with wine staging 8.4 as of this moment. It can be found in the Actions tab under the Linux branch. Download and extract the VRCX artifact.

  • You should just be able to run wine VRCX.exe now. Should you get an error about CEFSharp, you can try wine VRCX.exe -no-cef-sandbox

• Notes

  • VRCX on Linux is known to have a nasty memory leak so keep an eye on memory usage or restart it frequently.

  • If you have a laptop that uses hardware muxing with an Intel iGPU you'll need to set your graphics device in nvidia-settings to only the NVIDIA GPU.

  

How to build VRCX from source

• Get source code

  • Download latest source code zip or clone repo with git clone.

• Build .NET

  • Install Visual Studio if it's not already installed.
  • In Visual Studio "Open Project/Solution" and browse to the Solution file provided inside the downloaded source code.
  • Set Configuration to Release and Platform to x64
  • Restore NuGet packages.
  • Build Solution.

• Build Node.js

  • Download and install Node.js.
  • Run build-node.js.cmd.
  • Run make-junction.cmd.

• Create release zip

  • Run make-zip.cmd for Bandizip or make-zip-7z.cmd for 7-Zip.