mirror of
https://github.com/MrUnknownDE/VRCX.git
synced 2026-04-11 19:03:51 +02:00
82 lines
5.4 KiB
Markdown
82 lines
5.4 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 is not responsible for any problems caused by VRCX. ***Use at your own risk!***
|
|
|
|
|
|
|
|
*VRChat's official stance on usage of the API, as listed in their Discord #faq channel.*
|
|
|
|
Special comments about VRChatRPC.DLL
|
|
-
|
|
VRChatRPC.DLL is used to login VRChat via your **Steam account**. (If you press the Steam login button on the login page)
|
|
|
|
If you don't need to login via Steam, VRChatRPC.DLL will not be used.
|
|
|
|
In detail, VRChatRPC.DLL accesses the VRChat Process (DLL Injection) and calls the Steam API to obtain the Login Token. This may lead to BAN from VRChat.
|
|
|
|
No technical measures have been taken on security yet (Of course I can't say there's no risk, but there's no problem), but I don't know what will happen later.
|
|
|
|
Since it is impossible to login to a 3rdparty account in the usual way, so this is the only way.
|
|
|
|
It's source code is available at https://github.com/pypy-vrc/VRChatRPC.
|
|
|
|
Screenshots
|
|
=
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# How to install VRCX
|
|
|
|
* Download latest release [zip](https://github.com/pypy-vrc/VRCX/releases/latest).
|
|
* Extract entire zip archive.
|
|
* Run `VRCX.exe`.
|
|
|
|
# How to run VRCX on Linux
|
|
|
|
* [Guide](https://github.com/RinLovesYou/VRChat-Linux/wiki/VRCX) made by @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).
|