Community:VRCX: Difference between revisions
From VRChat Wiki
Tony Lewis (talk | contribs) (Making baseline, image to be replaced) |
(Added categories for languages, and category for "third-party applications"; some typo fixes.) |
||
(20 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{stub}} | {{stub}} | ||
{{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="languages"><label>Languages</label><default>''' | <data source="languages"><label>Languages</label><default>'''English, French, Japanese, Simplified Chinese, Italian, Russian, Spanish, Polish'''</default></data> | ||
<data source="url"><label>URL</label> | <data source="url"><label>URL</label> | ||
<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 | '''VRCX''' is a VRChat-focused third-party application for Windows, which provides a graphical user interface (GUI) for VRChat's application programming interface (API). | ||
== 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|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<ref>[https://github.com/vrcx-team/VRCX/security/advisories/GHSA-j98g-mgjm-wqph VR Overlay RCE] on GitHub; retrieved September 23, 2024</ref> | |||
=Features= | ==Features== | ||
''' | * '''Friend, World, and Avatar Management:''' | ||
*Manage your friends list, world | ** 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 [https://github.com/vrcx-team/VRCX/wiki/World-Persistence-(PWI) 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 [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] | ||
<gallery widths=" | |||
File: | ==Configuration and launch parameters== | ||
File: | ===Launch parameters=== | ||
File: | {| class="wikitable" | ||
File: | |- | ||
File: | | --debug || Launch Chromium DevTools with VRCX. | ||
File: | |- | ||
File: | | --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 | |||
==Gallery== | |||
<gallery widths="225" heights="170"> | |||
File:VRCX_Login1.webp|Login Screen | |||
File:VRCX_Login2.webp|2FA Supported | |||
File:VRCX_Feed.webp|Feed Screen | |||
File:VRCX_GameLogs.webp|Game Log Screen | |||
File:VRCX_User_Info.webp|User Info (Own) | |||
File:VRCX_Friend_Info.webp|User Info (Friends) | |||
File:VRCX_World1.webp|World Info (Instance Tab) | |||
File:VRCX_World2.webp|World Info (Info Tab) | |||
File:VRCX_Favorite_Friend.webp|Favorite (Friends) | |||
File:VRCX_Favorite_World.webp|Favorite (Worlds) | |||
File:VRCX_Favorite_Avatar.webp|Favorite (Avatars) | |||
File:VRCX_Friend_Log.webp|Friend Log | |||
File:VRCX_discord_presence.webp|Discord Rich Presence | |||
</gallery> | </gallery> | ||
[[Category:English]] | |||
[[Category:French]] | |||
[[Category:Japanese]] | |||
[[Category:Chinese]] | |||
[[Category:Italian]] | |||
[[Category:Russian]] | |||
[[Category:Spanish]] | |||
[[Category:Polish]] | |||
[[Category:Third-party applications]] |
Latest revision as of 23:57, 23 September 2024
You can help the VRChat Wiki by improving it.
[Reason: No reason provided.]
[Reason: No reason provided.]
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.
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.
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).
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
Gallery
- ↑ VR Overlay RCE on GitHub; retrieved September 23, 2024