mirror of
https://github.com/MrUnknownDE/VRCX.git
synced 2026-04-23 08:43:50 +02:00
Add /settings endpoint, clean up README, make WorldDB U# impl easier/faster (#556)
* docs: Change readme * feat: New /settings endpoint; Make U# implementation easier To further avoid the 5 second string loading delay, developers are no longer required to use /init before getting data; Every data request endpoint will now initialize the world automatically and include a connection key in the response. Changed the way debug init works; It should now work for all endpoints without extra checks by just returning the current world as wrld_12345. New /settings endpoint allows the change of the allow_external_reads column in the database, but getting data is currently unimplemented. Fix store request logging being... completely wrong. * Update README.md Co-authored-by: Tayou <31988415+TayouVR@users.noreply.github.com> --------- Co-authored-by: Tayou <31988415+TayouVR@users.noreply.github.com>
This commit is contained in:
Teacup
GitHub
304
README.md
304
README.md
@@ -1,270 +1,130 @@
|
||||
# VRCX
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/vrcx-team/VRCX/actions/workflows/github_actions.yml)
|
||||
# <img src="https://raw.githubusercontent.com/vrcx-team/VRCX/master/VRCX.ico" width="64" height="64"> </img> VRCX
|
||||
[](https://github.com/vrcx-team/VRCX/releases/latest)
|
||||
[](https://github.com/vrcx-team/VRCX/actions/workflows/github_actions.yml)
|
||||
[](https://vrcx.pypy.moe/discord)
|
||||
|
||||
| **English** | [日本語](./README.jp.md) |
|
||||
|
||||
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 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.
|
||||
|
||||
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.
|
||||
# Getting Started
|
||||
|
||||
pypy & Natsumi are not responsible for any problems caused by VRCX. **_Use at your own risk!_**
|
||||
<div align="center">
|
||||
|
||||
## How to install VRCX
|
||||
Download and run the latest installer (`VRCX_Setup.exe`) from [here](https://github.com/vrcx-team/VRCX/releases/latest).
|
||||
|
||||
- Download latest release setup from [here](https://github.com/vrcx-team/VRCX/releases/latest).
|
||||
- Run `VRCX_Setup.exe`.
|
||||
# Features
|
||||
|
||||
## Is VRCX against VRChat ToS?
|
||||
<div align="left">
|
||||
|
||||
**TL;DR:** no.
|
||||
- :family: Friend, world, and avatar list management
|
||||
- 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.
|
||||
- :electric_plug: Automatically launch apps when you start VRChat
|
||||
- You can configure VRCX to launch other apps when you start VRChat.
|
||||
- For example, you could have VRCX launch an OSC app or a voice changer app when VRChat opens up.
|
||||
- :floppy_disk: World Persistence
|
||||
- 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: [Wiki Page - World Persistence (PWI)](https://github.com/vrcx-team/VRCX/wiki/World-Persistence-(PWI))
|
||||
- :mag: Search for avatars, users, worlds, and groups
|
||||
- :clipboard: Build a local, unrestricted world favorites list
|
||||
- :camera: Store world data in the pictures you take in-game, so you can remember that one world you took those cool pictures in like... 6 months ago!
|
||||
- :bell: Monitor/respond to notifications
|
||||
- You can send/receive invites and friend requests from VRCX as well as see the instance info of invites that you receive.
|
||||
- :scroll: See stats/players for your current instance
|
||||
- :tv: See the links to videos and that are playing in the world you're in, as well as various other logged data.
|
||||
- :bar_chart: Improved Discord Rich Presence
|
||||
- You can optionally display more information about your current instance in Discord.
|
||||
- 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!
|
||||
- :crystal_ball: VR Overlay with configurable live feed of all supported events/notifications
|
||||
|
||||
_VRChat's official stance on usage of the API, as listed in their Discord #faq channel._
|
||||
|
||||
## Miscellanous
|
||||
|
||||
- Want a new look for VRCX? Check out [Themes](https://github.com/vrcx-team/VRCX/wiki/Themes)
|
||||
- See [Building from source](https://github.com/vrcx-team/VRCX/wiki/Building-from-source) for instructions on how to build VRCX from source.
|
||||
- For a guide on how to run VRCX on linux, see [here](https://github.com/vrcx-team/VRCX/wiki/Running-VRCX-on-Linux)
|
||||
|
||||
# Screenshots
|
||||
|
||||
<details><summary><h2>Screenshot(click to open)</h2></summary>
|
||||
<div align="center">
|
||||
|
||||
### Login
|
||||
<h3>Login</h3>
|
||||
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><img src="https://user-images.githubusercontent.com/82102170/224703139-9cb24dda-3839-4f75-a665-cca69f9e08ea.png" alt="login"></td>
|
||||
<td align="center"><img src="https://user-images.githubusercontent.com/82102170/224703275-103e78fd-e917-428d-b901-6817d6b59b29.png" alt="2fa"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Feed
|
||||
<h3>Feed</h3>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224714129-772d7418-034a-4fe3-aa2e-22ea71154d9a.png" alt="feed">
|
||||
|
||||
### GameLog
|
||||
<h3>GameLog</h3>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224714186-75cbf46d-f7b2-4a16-bcc5-2ec06d7f4b0d.png" alt="gamelog">
|
||||
|
||||
### UserInfo
|
||||
<h3>UserInfo</h3>
|
||||
|
||||
#### Me
|
||||
<h4>Me</h4>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224704240-b10aba50-29b9-4ef4-b35a-958107a32cd6.png" alt="me">
|
||||
|
||||
#### Friend
|
||||
<h4>Friend</h4>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224714608-ac49621f-c28f-4266-8af8-715f4b9f2367.png" alt="friend">
|
||||
|
||||
### World
|
||||
<h3>World</h3>
|
||||
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><img src="https://user-images.githubusercontent.com/82102170/224715566-67782a5e-f948-402b-b78d-1b2dd5e2382f.png" alt="instance"></td>
|
||||
<td align="center"><img src="https://user-images.githubusercontent.com/82102170/224715824-c0c4220e-4f20-4799-8419-f8138de35b7a.png" alt="info"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Favorite
|
||||
<h3>Favorite</h3>
|
||||
|
||||
#### Friend
|
||||
<h4>Friend</h4>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224716414-5c6720bd-6d38-4e2d-9353-6bfaee47700e.png" alt="friend">
|
||||
|
||||
#### World
|
||||
<h4>World</h4>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224716652-ca54f3d1-449b-43f9-81f3-7bd0833c7d9d.png" alt="world">
|
||||
|
||||
#### Avatar
|
||||
<h4>Avatar</h4>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224717146-37681b38-61ef-4302-8104-212c2161dc12.png" alt="avatar">
|
||||
|
||||
### FriendLog
|
||||
<h3>Friend Log</h3>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224717793-dbbccdfd-4f89-4597-b38e-8070549b2cf8.png" alt="friendlog">
|
||||
|
||||
### Moderation
|
||||
<h3>Discord Rich Presence</h3>
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/82102170/224725991-3fc81a3d-ca15-4dcb-a057-d713803bd666.png" alt="discord">
|
||||
|
||||
### Notification
|
||||
<!-- The other images will be similar to this -->
|
||||
</div>
|
||||
|
||||
|
||||
## Is VRCX against VRChat's TOS?
|
||||
|
||||
### PlayerList
|
||||
**No.**
|
||||
|
||||
|
||||
VRCX is an external tool that uses the VRChat API to provide the features it does.
|
||||
|
||||
### Settings
|
||||
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.
|
||||
|
||||
#### General
|
||||
To see VRChat's stance on API usage, see the #faq channel in the VRChat Discord.
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### Appearance
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
#### Notifications
|
||||
|
||||
|
||||
|
||||
#### Wrist Overlay
|
||||
|
||||
|
||||
|
||||
#### Discord Presence
|
||||
|
||||
|
||||
|
||||
#### Advanced
|
||||
|
||||
|
||||
|
||||
|
||||
### Other
|
||||
|
||||
#### Join
|
||||
|
||||
|
||||
|
||||
#### Create Instance
|
||||
|
||||
|
||||
|
||||
#### Discord Rich Presence
|
||||
|
||||
|
||||
|
||||
### VR Overlay(old)
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
## Themes
|
||||
|
||||
To install a theme place `custom.css` into your `%AppData%\VRCX` folder then press `Shift + Alt + R`.
|
||||
|
||||
[Dark Vanilla](https://github.com/MintLily/Dark-Vanilla/tree/main/VRCX) by [MintLily](https://github.com/MintLily)
|
||||
|
||||
|
||||
[Pink Theme](https://github.com/kamiya10/VRCX-theme/tree/main/pink) by [Kamiya](https://github.com/kamiya10)
|
||||
|
||||
|
||||
[Material 3](https://github.com/kamiya10/VRCX-theme/tree/main/m3) by [Kamiya](https://github.com/kamiya10)
|
||||
|
||||
|
||||
## 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](https://aka.ms/vs/17/release/vc_redist.x64.exe).
|
||||
- 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](https://www.windowsdigitals.com/force-chrome-firefox-game-to-use-nvidia-gpu-integrated-graphics/).
|
||||
|
||||
### **How to repair VRCX database**
|
||||
|
||||
- Close VRCX.
|
||||
- Install [DB Browser for SQLite](https://sqlitebrowser.org/).
|
||||
- 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](https://github.com/RinLovesYou)
|
||||
|
||||
- Installing Wine
|
||||
|
||||
- Arch Linux: Wine can be installed by enabling the [multilib](https://wiki.archlinux.org/title/Multilib) repository and running `sudo pacman -S wine`
|
||||
|
||||
- Ubuntu: Please refer to the [wiki](https://wiki.winehq.org/Ubuntu)
|
||||
|
||||
- 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](https://github.com/vrcx-team/VRCX/archive/master.zip) or clone repo with `git clone`.
|
||||
|
||||
- Build .NET
|
||||
|
||||
- Install [Visual Studio](https://visualstudio.microsoft.com/) if it's not already installed.
|
||||
- In Visual Studio "Open Project/Solution" and browse to the [Solution file](https://docs.microsoft.com/en-us/visualstudio/extensibility/internals/solution-dot-sln-file) provided inside the downloaded source code.
|
||||
- Set [Configuration](https://docs.microsoft.com/en-us/visualstudio/ide/understanding-build-configurations?view=vs-2019) to `Release` and Platform to `x64`
|
||||
- Restore [NuGet](https://docs.microsoft.com/en-us/nuget/consume-packages/package-restore#restore-packages-automatically-using-visual-studio) packages.
|
||||
- [Build](https://docs.microsoft.com/en-us/visualstudio/ide/building-and-cleaning-projects-and-solutions-in-visual-studio) Solution.
|
||||
|
||||
- Build Node.js
|
||||
|
||||
- Download and install [Node.js](https://nodejs.org/en/download/).
|
||||
- Run `build-node.js.cmd`.
|
||||
- Run `make-junction.cmd`.
|
||||
|
||||
- Create release zip
|
||||
- Run `make-zip.cmd` for [Bandizip](https://www.bandisoft.com/bandizip) or `make-zip-7z.cmd` for [7-Zip](https://www.7-zip.org).
|
||||
|
||||
Reference in New Issue
Block a user