Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paultje52/vrc-patreon-link
Automatically uploads a list of patrons to VRChat everytime a patron joins or leaves, without reuploading the world. For use with Miner28/AvatarImageReader
https://github.com/paultje52/vrc-patreon-link
Last synced: about 2 months ago
JSON representation
Automatically uploads a list of patrons to VRChat everytime a patron joins or leaves, without reuploading the world. For use with Miner28/AvatarImageReader
- Host: GitHub
- URL: https://github.com/paultje52/vrc-patreon-link
- Owner: Paultje52
- License: mit
- Created: 2021-12-31T00:12:46.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-06T11:30:50.000Z (about 1 year ago)
- Last Synced: 2023-12-06T12:35:31.641Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 628 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> _Currently there are some login issues because VRChat changed their API. We're working on a rewrite. In this rewrite, we're also going to use the new [String Loading](https://docs.vrchat.com/docs/string-loading) api._
# VRC-Patreon-Link
> Automatically uploads a list of patrons to VRChat everytime a patron joins or leaves, without reuploading the world. For use with https://github.com/Miner28/AvatarImageReader
- Main
- [Encoder](./encoder/README.md)
- [Parser](./parser/README.md)
## Like this project?
Give us a star on [GitHub](https://github.com/Paultje52/vrc-patreon-link) and join our [Discord](https://discord.gg/n4VPPnX2Mb)!
## How it works
This project makes use of [AvatarImageReader](https://github.com/miner28/AvatarImageReader) to fetch new data in a VRChat world at runtime.
The [Encoder](./encoder/README.md) is a Discord bot which automatically asks Patrons for their VRChat profile URLs, which it turns into a list of usernames. These are then encoded into an avatar thumbnail image, which is uploaded to VRChat.
The [Parser](./parser/README.md) reads the output of AvatarImageReader and extracts the usernames so you can display them and check if the local player has a certain Patreon tier. Read the full technical details below.
An example of a world using this system is [Project Aincrad](https://vrchat.com/home/world/wrld_1caa6d80-9ee4-4a7d-95ee-50259272aa35).
### Technical details
> **Note:** You should have a setup that gives patrons a role in Discord. A simple way to get this to work is by giving Patrons Discord rewards using the Patreon Discord bot. You can use different roles for different tiers and you can even add your Discord staff as separate roles for the synchronization! Any selected role can be checked for or displayed at runtime (in VRChat).
When the encoder starts up or when a role in the server is changed, the encoder will go through everyone that has one of the configured roles. It will then check if everyone has linked a VRChat profile to the bot.
If someone didn't link their VRChat profile to the bot yet, the bot will send the user a DM. To prevent Bot Quarantines, the bot will only open a new DM every 15 seconds. If the user doesn't have their DMs open, the bot will send a message in a configured channel instead. The user can then open their DMs and link their VRChat profile to the bot.
While linking, the user can confirm the link and later remove the link and add a new one.
The encoder will check for new links once every five minutes. If there are, it will encode a new image and upload it to VRChat. The encoded text looks like this.
```
ROLE_NAME.FIRST_USERNAME.SECOND_USERNAME
SECOND_ROLE_NAME.THIRD_USERNAME.FOURTH_USERNAME
```
Text is converted to binary data with UTF16 encoding. 3 bytes of data are encoded into every pixel, giving us a total of 38861 Bytes to work with (the first pixel encodes data length). An example (4x upscaled to prevent bilinear filtering from messing it up) image can be found below.
The first time an avatar pedestal is loaded in the client, the thumbnail image will be downloaded. This gets cached locally. The image is copied from the pedestal once downloading finishes and captured with a camera, then output to a rendertexture. This rendertexture is decoded by AvatarImageReader, which outputs a string, which is then sent to the parser part of this project. The way caching works means that a user needs to restart their client in order to see the most up to date version.
## Setup
Please look at the [Encoder](./encoder/README.md) and [Parser](./parser/README.md) README for more information.
## License
The license for this whole project is **MIT** and can be found [here](LICENSE). The summary of the license is as follows.
- Do whatever you want with the project.
- We are not responsible for any damages caused by the use of this project.
> Please test this system at least once in a (private) test Discord server + VRChat world to ensure everything has been set up correctly.
- The [LICENSE](LICENSE) file must be includes in all forks, including the current copyright notice. When changing anything, you can copyright the _changes_ by adding new lines to the [LICENSE](LICENSE) file.