Community:VRCX: Difference between revisions

From VRChat Wiki
(Temp COI Notice while rewrite)
(→‎Features: rewriting)
Line 35: Line 35:
Beta/nightly build available [[https://vrcx.app/github/nightly|"here"]] or in-app Settings -> General -> Change build.
Beta/nightly build available [[https://vrcx.app/github/nightly|"here"]] or in-app Settings -> General -> Change build.


=Features=
==Features==


'''<big>👪 Friend, world, and avatar list management</big>'''
* '''Friend, World, and Avatar Management:'''
*Manage your friends list, world/group/avatar lists outside of VRChat.
** Manage your friends list, and organize your world, group, and avatar lists outside of VRChat.
*Monitor the world/avatar activity of your friends and check their online status.
** Track your friends' online status, world activities, and avatar changes.
*Keep track of when you first added them and when you last saw them.
** Log when you added friends, when you last saw them, and how much time you've spent together in worlds.
*See how much time you've spent together in worlds and how many times.
** Monitor name changes and store personal notes to remember how you met.
*Keep track of friend name changes.
*Save notes to help remember how you met.


'''<big>🔌 Automatically launch apps when you start VRChat</big>'''
* '''Auto-Launch Apps with VRChat:'''
*You can configure VRCX to launch other apps when you start VRChat.
** Set up VRCX to automatically open other apps, like an OSC tool or voice changer, when VRChat launches.
For example, you could have VRCX launch an OSC app or a voice changer app when VRChat opens up.
'''<big>💾 World Persistence</big>'''
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>'''
* '''World Persistence:'''
** '''Important''': VRCX’s world persistence feature has nothing to do with VRChat's official development of world persistence.
** '''Note''': To use this feature, you must enable "Allow Untrusted URLs" in your VRChat settings.
** For worlds that support it, VRCX can store settings, saved states, inventories, and other persistent data.
** For developers, visit [https://github.com/vrcx-team/VRCX/wiki/World-Persistence-(PWI)|"World Persistence (PWI)"] by VRCX.


'''<big>📷 Store world data in the pictures you take in-game</big>'''
* '''Avatar, User, World, and Group Search:'''
** Easily search for avatars, users, worlds, and groups within the app.


You can remember that one world you took those cool pictures in like... 6 months ago!
* '''Unrestricted World Favorites List:'''
** Create and manage a custom local list of your favorite worlds.


'''<big>🔔 Monitor/respond to notifications</big>'''
* '''World Data Storage in Photos:'''
You can send/receive invites and friend requests from VRCX as well as see the instance info of invites that you receive.
** Keep track of the worlds where your in-game photos were taken, even months later.
'''<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>'''
* '''Notification Monitoring and Responses:'''
** Send and receive invites and friend requests directly from VRCX.
** View instance details of invitations received.


As well as various other logged data.
* '''Instance Stats and Player Information:'''
** See statistics and player details for your current VRChat instance.


'''<big>📊 Improved Discord Rich Presence</big>'''
* '''Video Links in Worlds:'''
You can optionally display more information about your current instance in Discord.
** View video links and related data for videos playing in the world you’re currently in.
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>'''
* '''Enhanced Discord Rich Presence:'''
** Optionally display detailed information about your current instance in Discord, including world thumbnails, names, instance IDs, and player counts.
** Integrate with popular worlds like PyPyDance, LSMedia, Movies&Chill, and VRDancing.
** Add a join button for public lobbies, depending on privacy settings.


'''<big>📄 Manage and edit uploaded avatar/world details without Unity</big>'''
* '''VR Overlay:'''
** Access a configurable overlay with live notifications and supported event feeds.


'''<big>💀 Automatically restart and join last instance when VRC crashes</big>'''
* '''Avatar and World Image Uploads without Unity:'''
** Upload images for avatars and worlds without needing Unity.


'''<big>↔️ Export/import favorite groups</big>'''
* '''Manage and Edit Avatar/World Details:'''
** Edit and update uploaded avatar or world information directly through VRCX, no Unity required.
 
* '''Automatic Crash Recovery:'''
** Automatically restart VRChat and rejoin the last instance if the application crashes.
 
* '''Group Favorites Export/Import:'''
** Export or import your favorite groups


=Miscellanous=
=Miscellanous=

Revision as of 19:49, 23 September 2024

Vrrat posed-right.png
V · EThis page is a stub.
You can help the VRChat Wiki by improving it.
[Reason: No reason provided.]
IconOnly CL Portal.png
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.
Scale icon orange.svg
V · EThis page was marked as non-Neutral point of view
A "non-neutral point of view" refers to a perspective or stance that shows bias, partiality, or favoritism toward a particular viewpoint, idea, or group.

This approach emphasizes subjective opinions, personal beliefs, or specific agendas, rather than striving for objectivity or impartiality. In contrast to a neutral point of view, it may advocate for or against certain positions, often leading to unbalanced or one-sided representations.

Consider editing this page.

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.

It also includes some other neat features outlined below.

Getting Started

Download and install the latest installer (VRCX_Setup.exe) from ["here"]

Beta/nightly build available ["here"] or in-app Settings -> General -> Change build.

Features

  • Friend, World, and Avatar Management:
    • Manage your friends list, and organize your world, group, and avatar lists outside of VRChat.
    • Track your friends' online status, world activities, and avatar changes.
    • Log when you added friends, when you last saw them, and how much time you've spent together in worlds.
    • Monitor name changes and store personal notes to remember how you met.
  • Auto-Launch Apps with VRChat:
    • Set up VRCX to automatically open other apps, like an OSC tool or voice changer, when VRChat launches.
  • World Persistence:
    • Important: VRCX’s world persistence feature has nothing to do with VRChat's official development of world persistence.
    • Note: To use this feature, you must enable "Allow Untrusted URLs" in your VRChat settings.
    • For worlds that support it, VRCX can store settings, saved states, inventories, and other persistent data.
    • For developers, visit "World Persistence (PWI)" by VRCX.
  • Avatar, User, World, and Group Search:
    • Easily search for avatars, users, worlds, and groups within the app.
  • Unrestricted World Favorites List:
    • Create and manage a custom local list of your favorite worlds.
  • World Data Storage in Photos:
    • Keep track of the worlds where your in-game photos were taken, even months later.
  • Notification Monitoring and Responses:
    • Send and receive invites and friend requests directly from VRCX.
    • View instance details of invitations received.
  • Instance Stats and Player Information:
    • See statistics and player details for your current VRChat instance.
  • Video Links in Worlds:
    • View video links and related data for videos playing in the world you’re currently in.
  • Enhanced Discord Rich Presence:
    • Optionally display detailed information about your current instance in Discord, including world thumbnails, names, instance IDs, and player counts.
    • Integrate with popular worlds like PyPyDance, LSMedia, Movies&Chill, and VRDancing.
    • Add a join button for public lobbies, depending on privacy settings.
  • VR Overlay:
    • Access a configurable overlay with live notifications and supported event feeds.
  • Avatar and World Image Uploads without Unity:
    • Upload images for avatars and worlds without needing Unity.
  • Manage and Edit Avatar/World Details:
    • Edit and update uploaded avatar or world information directly through VRCX, no Unity required.
  • Automatic Crash Recovery:
    • Automatically restart VRChat and rejoin the last instance if the application crashes.
  • Group Favorites Export/Import:
    • Export or import your favorite groups

Miscellanous

  • Want a new look for VRCX? Check out Themes
  • See Building from source for instructions on how to build VRCX from source.
  • For a guide on how to run VRCX on linux, see here
  • If you looking for VRCX on Android, there is third-party project, see here

Common Issues

VRCX wont open or 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.
  • 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.

VRCX running slow

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

SteamVR Overlay not working

  • Disable SteamVR safe mode.
  • If your computer has an iGPU follow these steps.

How to repair VRCX database 

   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 + R restart VRCX.
  • Shift + Alt + R reload custom css.

Launch parameters & VRCX.json

VRCX Launch parameters

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

VRCX 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

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

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.

Screenshot

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

    discord Rich Prensence

Retrieved from "https://wiki.vrchat.com/index.php?title=Community:VRCX&oldid=9263"