Community:VRCX: Difference between revisions

From VRChat Wiki
m (Fix Visual + Add links)
m (Minor; Fixed a formatting error.)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{stub}}
{{stub}}
[[Category:Empty]]
{{Noticebox/Community}}
{{Noticebox/Community}}
{{Template:Noticebox/non-npov}}
<infobox type="App" theme="community">
<infobox type="App" theme="community">
<group>
<group>
Line 7: Line 7:
<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'''</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>
Line 25: Line 16:
   </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 third-party application for Windows, which provides a graphical user interface (GUI) for VRChat's application programming interface (API).


It also includes some other neat features outlined below.
== What is API? ==
VRChat's application programmer interface (API) is official VRChat data from VRChat's servers, and streamlined to your account, through VRChat client, the VRChat website, or using the VRChat app. The API can also be queried externally. For this example, with VRCX.


=Getting Started=
Information from VRChat's API includes the following:
Download and install the latest installer (VRCX_Setup.exe) from [[https://github.com/vrcx-team/VRCX/releases/latest|"here"]]


Beta/nightly build available [[https://vrcx.app/github/nightly|"here"]] or in-app Settings -> General -> Change build.
* Login and authentication
** Being able to sign in via Steam, Meta, PICO, etc.
** Signing directly through your VRChat account
* Social and friends list
** Live instance data (and switching instances)
** Data regarding invites, and notifications
** Joining and leaving instances
** Favorite friends lists
* SDK asset uploads
** Your worlds and avatars
** Favorite avatars, worlds, etc.
** Searching for worlds and avatars
* Realtime player state changes
** Status updates, changing bios
** Practically anything account-related
** Changing avatars
** Switching instances (and live instance data)


=Features=
* Data being externally streamed to you, via an instance (Udon; Untrusted URLs)
** Video player data
** Image loading data
** String loading data


'''<big>👪 Friend, world, and avatar list management</big>'''
VRChat's API status can officially be queried here: {{VRC link|https://status.vrchat.com/|VRChat server status}}
*Manage your friends list, world/group/avatar lists outside of VRChat.
*Monitor the world/avatar activity of your friends and check their online status.
*Keep track of when you first added them and when you last saw them.
*See how much time you've spent together in worlds and how many times.
*Keep track of friend name changes.
*Save notes to help remember how you met.


'''<big>🔌 Automatically launch apps when you start VRChat</big>'''
== Potential risks with VRCX ==
*You can configure VRCX to launch other apps when you start VRChat.
While VRCX is deemed safe, and using it is not a violation of the [[Terms of Service]], there are a few risks involved with installing and using VRCX.
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>'''
* VRCX requires logging in, using your [[VRChat Account|VRChat account]], password, and [[Two-Factor Authentication (2FA)]]. VRChat, Inc. advises against giving your credentials to anybody, including using it to log into third-party applications that does not use VRChat's SSO authentication.


'''<big>📷 Store world data in the pictures you take in-game</big>'''
* Flooding or spamming the API may risk disconnecting you from VRChat services, and very rarely, risking an account ban.
* Using outdated versions of VRCX may make you vulnerable to Remote Command Execution (RCE) exploits<ref>[https://github.com/vrcx-team/VRCX/security/advisories/GHSA-j98g-mgjm-wqph VR Overlay RCE] on GitHub; retrieved September 23, 2024</ref>


You can remember that one world you took those cool pictures in like... 6 months ago!
==Features==


'''<big>🔔 Monitor/respond to notifications</big>'''
* '''Friend, World, and Avatar Management:'''
You can send/receive invites and friend requests from VRCX as well as see the instance info of invites that you receive.
** 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.
'''<big>📜 See stats/players for your current instance</big>'''
** 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.


'''<big>📺 See the links to videos and that are playing in the world you're in</big>'''
* '''Auto-Launch Apps with VRChat:'''
** Set up VRCX to automatically open other apps, like an OSC tool or voice changer, when VRChat launches.


As well as various other logged data.
* '''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>📊 Improved Discord Rich Presence</big>'''
* '''Avatar, User, World, and Group Search:'''
You can optionally display more information about your current instance in Discord.
** Easily search for avatars, users, worlds, and groups within the app.
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>'''
* '''Unrestricted World Favorites List:'''
** Create and manage a custom local list of your favorite worlds.


'''<big>📄 Manage and edit uploaded avatar/world details without Unity</big>'''
* '''World Data Storage in Photos:'''
** Keep track of the worlds where your in-game photos were taken, even months later.


'''<big>💀 Automatically restart and join last instance when VRC crashes</big>'''
* '''Notification Monitoring and Responses:'''
** Send and receive invites and friend requests directly from VRCX.
** View instance details of invitations received.


'''<big>↔️ Export/import favorite groups</big>'''
* '''Instance Stats and Player Information:'''
** See statistics and player details for your current VRChat instance.


=Miscellanous=
* '''Video Links in Worlds:'''
*Want a new look for VRCX? Check out [https://github.com/vrcx-team/VRCX/wiki/Themes| Themes]
** View video links and related data for videos playing in the world you’re currently in.
*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]


=Is VRCX against VRChat's TOS?=
* '''Enhanced Discord Rich Presence:'''
'''No.'''
** 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.


VRCX is an external tool that uses the VRChat API to provide the features it does.
* '''VR Overlay:'''
** Access a configurable overlay with live notifications and supported event feeds.


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.
* '''Avatar and World Image Uploads without Unity:'''
** Upload images for avatars and worlds without needing Unity.


To see VRChat's stance on API usage, see the #faq channel in the VRChat Discord.
* '''Manage and Edit Avatar/World Details:'''
** Edit and update uploaded avatar or world information directly through VRCX, no Unity required.


=Disclosure=
* '''Automatic Crash Recovery:'''
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.
** Automatically restart VRChat and rejoin the last instance if the application crashes.


=Screenshot=
* '''Group Favorites Export/Import:'''
** Export or import your favorite groups
 
==Keyboard shorcuts==
 
*Ctrl + Shift + I open Chromium DevTools.
*Ctrl + R restart VRCX.
*Shift + Alt + R reload custom css.
 
==Getting started==
Download and install the latest installer (VRCX_Setup.exe) from [https://github.com/vrcx-team/VRCX/releases/latest here]
 
Beta/nightly build available [https://vrcx.app/github/nightly here] or in-app Settings -> General -> Change build.
 
Linux User should have a look [https://github.com/vrcx-team/VRCX/wiki/Running-VRCX-on-Linux here]
 
==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.
|}
 
===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 || 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
 
==Screenshots==
<gallery widths="330" heights="250">
<gallery widths="330" heights="250">
File:VRCX_Login1.webp|Login Screen
File:VRCX_Login1.webp|Login Screen

Latest revision as of 22:57, 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 a VRChat-focused third-party application for Windows, which provides a graphical user interface (GUI) for VRChat's application programming interface (API).

What is API?

VRChat's application programmer interface (API) is official VRChat data from VRChat's servers, and streamlined to your account, through VRChat client, the VRChat website, or using the VRChat app. The API can also be queried externally. For this example, with VRCX.

Information from VRChat's API includes the following:

  • Login and authentication
    • Being able to sign in via Steam, Meta, PICO, etc.
    • Signing directly through your VRChat account
  • Social and friends list
    • Live instance data (and switching instances)
    • Data regarding invites, and notifications
    • Joining and leaving instances
    • Favorite friends lists
  • SDK asset uploads
    • Your worlds and avatars
    • Favorite avatars, worlds, etc.
    • Searching for worlds and avatars
  • Realtime player state changes
    • Status updates, changing bios
    • Practically anything account-related
    • Changing avatars
    • Switching instances (and live instance data)
  • Data being externally streamed to you, via an instance (Udon; Untrusted URLs)
    • Video player data
    • Image loading data
    • String loading data

VRChat's API status can officially be queried here: Official VRChat source VRChat server status

Potential risks with VRCX

While VRCX is deemed safe, and using it is not a violation of the Terms of Service, there are a few risks involved with installing and using VRCX.

  • VRCX requires logging in, using your VRChat account, password, and Two-Factor Authentication (2FA). VRChat, Inc. advises against giving your credentials to anybody, including using it to log into third-party applications that does not use VRChat's SSO authentication.
  • Flooding or spamming the API may risk disconnecting you from VRChat services, and very rarely, risking an account ban.
  • Using outdated versions of VRCX may make you vulnerable to Remote Command Execution (RCE) exploits[1]

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

Keyboard shorcuts

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

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.

Linux User should have a look here

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

Screenshots

  • 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

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