mirror of
https://github.com/MrUnknownDE/VRCX.git
synced 2026-04-16 13:23:52 +02:00
2e18d3615d
* Update README.md concerning VRChatRPC.dll * Completely remove VRChatRPC.dll in README * ToS friendly at last :>
96 lines
5.6 KiB
Markdown
96 lines
5.6 KiB
Markdown
# VRCX
|
|
|
|
[](https://github.com/pypy-vrc/VRCX/actions/workflows/github_actions.yml)
|
|
[](https://vrcx.pypy.moe/discord)
|
|
|
|
VRCX is an assistant application for VRChat that provides information about and managing friendship. This application uses the unofficial VRChat API (VRCSDK).
|
|
|
|
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!***
|
|
|
|
|
|
## How to install VRCX
|
|
|
|
* 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.*
|
|
|
|
|
|
Screenshots
|
|
=
|
|
### Login
|
|
|
|
|
|
|
|
### Feed
|
|
|
|
### GameLog
|
|
|
|
### UserInfo
|
|
|
|
|
|
### World
|
|
|
|
|
|
### Favorite
|
|
|
|
|
|
|
|
### FriendsLog
|
|
|
|
### Moderation
|
|
|
|
### Notification
|
|
|
|
### PlayerList
|
|
|
|
### Settings
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Join
|
|
|
|
### NewInstance
|
|
|
|
### Discord Rich Presence
|
|
|
|
|
|
### VR Overlay
|
|
|
|
|
|
|
|
|
|
## How to run VRCX on Linux
|
|
|
|
* [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`.
|
|
|
|
* 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).
|