mirror of
https://github.com/vrcx-team/VRCX.git
synced 2026-04-06 00:32:02 +02:00
Readme Docs, Common issues
This commit is contained in:
Natsumi
130
README.md
130
README.md
@@ -7,50 +7,69 @@ VRCX is an assistant application for VRChat that provides information about and
|
||||
|
||||
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!***
|
||||
|
||||
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](https://github.com/pypy-vrc/VRCX/releases/latest).
|
||||
* Run `VRCX_Setup.exe`.
|
||||
- Download latest release setup from [here](https://github.com/pypy-vrc/VRCX/releases/latest).
|
||||
- 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.*
|
||||
_VRChat's official stance on usage of the API, as listed in their Discord #faq channel._
|
||||
|
||||
|
||||
Screenshots
|
||||
=
|
||||
# Screenshots
|
||||
|
||||
### Login
|
||||
|
||||
|
||||
|
||||
|
||||
### Feed
|
||||
|
||||
|
||||
|
||||
### GameLog
|
||||
|
||||
|
||||
|
||||
### UserInfo
|
||||
|
||||
|
||||
|
||||
|
||||
### World
|
||||
|
||||
|
||||
|
||||
|
||||
### Favorite
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### FriendsLog
|
||||
|
||||
|
||||
|
||||
### Moderation
|
||||
|
||||
|
||||
|
||||
### Notification
|
||||
|
||||
|
||||
|
||||
### PlayerList
|
||||
|
||||
|
||||
|
||||
### Settings
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -59,37 +78,104 @@ Screenshots
|
||||
|
||||
|
||||
### 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](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://kamiya.tk/VRCX/themes/m3/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.
|
||||
- `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](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.
|
||||
- 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](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.
|
||||
- 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](https://github.com/RinLovesYou/VRChat-Linux/wiki/VRCX) made by [RinLovesYou](https://github.com/RinLovesYou)
|
||||
- [Guide](https://github.com/RinLovesYou/VRChat-Linux/wiki/VRCX) made by [RinLovesYou](https://github.com/RinLovesYou)
|
||||
|
||||
## How to build VRCX from source
|
||||
|
||||
* Get source code
|
||||
* Download latest source code [zip](https://github.com/pypy-vrc/VRCX/archive/master.zip) or clone repo with `git clone`.
|
||||
- Get source code
|
||||
|
||||
* 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.
|
||||
- Download latest source code [zip](https://github.com/pypy-vrc/VRCX/archive/master.zip) or clone repo with `git clone`.
|
||||
|
||||
* Build Node.js
|
||||
* Download and install [Node.js](https://nodejs.org/en/download/).
|
||||
* Run `build-node.js.cmd`.
|
||||
* Run `make-junction.cmd`.
|
||||
- Build .NET
|
||||
|
||||
* 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).
|
||||
- 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