VRCX/README.md

VRCX

VRCX is an assistant application for VRChat that provides information about and managing friendship. This application uses the unofficial VRChat API (VRCSDK).

VRCX isn't endorsed by VRChat and doesn't reflect the views or opinions of VRChat or anyone officially involved in producing or managing VRChat. VRChat is trademark 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

Login

Feed

GameLog

UserInfo

World

Favorite

FriendsLog

Moderation

Notification

PlayerList

Settings

Join

NewInstance

Discord Rich Presence

VR Overlay

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.
• vrcx://user/usr_id open VRCX user dialog.
• vrcx://avatar/avtr_id open VRCX avatar dialog.
• vrcx://world/wrld_id open VRCX world dialog.
• vrcx://world/wrld_id:12345 or vrcx://world/https://vrch.at/shortUrl open VRCX world dialog with instance.

Keyboard shortcuts

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

Common issues

VRCX opens to a white screen

This can be caused by a few different things here's some 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.
• 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

• 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.
• 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

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.