Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/forever-and-a-day/VRCPlusPet-Free

VRChat Mod that uses MelonLoader. Hides VRC+ advertising, can replace default pet, his phrases, poke sounds and chat bubble (configurable). This fork enables VRCat for free, with unintended side effects (see readme). Is WIP.
https://github.com/forever-and-a-day/VRCPlusPet-Free

melonloader-mod vrchat vrchat-mod

Last synced: 2 months ago
JSON representation

VRChat Mod that uses MelonLoader. Hides VRC+ advertising, can replace default pet, his phrases, poke sounds and chat bubble (configurable). This fork enables VRCat for free, with unintended side effects (see readme). Is WIP.

Awesome Lists containing this project

README 

        
# VRCPlusPet-Free



As a plus subscriber myself, I don't think VRCat is a significant driver of subscriptions. Enjoy!



VRChat Mod that uses [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader). 


Hides VRC+ advertising, can replace default pet, his phrases, poke sounds and chat bubble.



❗ Final Notice ❗

For multiple reasons, including compatibility with VRChat Build 1101, this mod is obsolete. Therefore, this repo is being archived. I've learned a lot, and hope to learn more in the future. If you want to further this mod's goal through contributions, feel free to contact me on discord (ID in profile) and I'll consider putting it back up. For now, though, so long! Off to new adventures! Love ya! 



Notice!


This mod in its current state, breaks emmVRC's Plus check. This is not an intended function. Please be aware that abusing this mod to add emmVRC Favorites is abuse of the emmVRC Network! Doing so will likely result in a ban if (again, likely) emmVRC moves to checking your supporter tag server-side with their own servers. DO NOT add emmVRC Favorites without VRC+. If you get VRC+, you don't even need this mod, just use the original by WhiteSnowflake! This mod is intended only to let free users use/customize the cat, or remove the VRC+ ads if you don't use emmVRC.





If someone knows how to make this not interfere with emmVRC, please submit a pull request! I don't know C#, unfortunately, but will accept commits that clearly aren't malicious or obfuscated! Same goes for maintenance or improvements! 



 

If your name is Emilia or you otherwise develop for emmVRC, I would strongly recommend you preform your VRC+ checks from your own server at game run time using the Player API and the system_supporter tag, then have the local mod pull that information from your server (and reject new favs server-side if the local mod sends them anyway). If this method is truly technically impossible, please let me know on discord (forever-and-a-day#3000) and I'll take this mod down. 



Main Features:


 

 * All features can be enabled/disabled;

 * VRC+ advertising hiding (w/o hiding "Early Supporter Badge" and "Supporter Badge");

 * Changing main menu tab buttons to normal size;

 * Custom pet image;

 * Custom pet phrases;

 * Custom pet poke sounds;

 * Custom chat bubble image (text background). 



![Natsuki preview](https://i.ibb.co/txdSMpn/2020-12-30-054613.png)



Requirements:



 1. [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader/releases) (min. v0.3.0);

 2. [UIExpansionKit](https://github.com/knah/VRCMods/releases/tag/updates-2021-02-02).



How to install from releases:



> VRChat game folder: Steam Library -> RMB on VRChat -> Properties -> Local Files -> Browse Local Files.



Just drop "VRCPlusPet-Free.dll" from the releases section of this page to "VRChat/Mods" folder.

 

How to build and install from source (best practice):



0. Make sure you have Visual Studio ([2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=16#)

 is fine) installed - Other IDEs will likely work, but then you prob know what you're doing

1. Clone this repository or click green Download Code button, then Download ZIP (extract the zip)

2. Open the directory where you cloned/extracted the code

3. Copy all the DLLs from {VRChat-INSTALL-DIR}\MelonLoader\Managed to the "References" Folder

4. (Unknown if necessary, won't break anything) Copy {VRChat-INSTALL-DIR}\MelonLoader\MelonLoader.dll into the "References" Folder 

5. Copy {VRChat-INSTALL-DIR}\Mods\UIExpansionKit.dll into the "References" Folder

6. Open VRCPlusPet.sln in Visual Studio

7. Expand the project in the tree on the right and check for creepy code in the files (references to weird websites, auth tokens, etc) or obfuscation (single character C# filenames, randomized variable names, code that you're pretty sure a human programmer wouldn't understand, etc) 

8. Once you're absolutely sure it's safe, open the "Build" menu at the top and choose "Build *ProjectName*", usually "Build VRCPlusPet" or "Build VRCPlusPet-Free"

9. In a few moments, a folder should appear in the project directory named "Output", and inside that, "VRCPlusPet". Rename VRCPlusPet.dll to something like VRCPlusPet-Free.dll to avoid confusion with the original, if you want, then copy it into {VRChat-INSTALL-DIR}\Mods. 

10. You can now run the game. Enjoy! 

 

Mod configuration



All configs is placed in the in the Mod Settings menu that placed in the lower right corner of VRChat's Settings menu. 


Game restart needed after changing.



How to disable/enable VRC+ advertising?



 1. Enable/Disable "FAKE VRCP" in mod config.



How to replace Pet image?



  > Mod currently supports only ".png" image files. 


  > Image file name must be "pet.png". 



  1. Enable "Replace pet image?" in mod config;

  2. Open VRChat game folder (Steam Library -> RMB on VRChat -> Properties -> Local Files -> Browse Local Files);

  3. Drop image file to "UserData/VRCPlusPet_Config/" folder (make sure that file has name "pet.png").



How to replace Chat Bubble image?



  > Mod currently supports only ".png" image files. 


  > Image file name must be "bubble.png". 


  > Image editing required. 


 

  1. Download original image: [Click me >_<](https://cdn.discordapp.com/attachments/548545237123989505/793646716779364362/ChatBubble_IMG_UI.png);

  2. Edit the image as you want;

  3. Enable "Replace bubble image?" in mod config;

  4. Open VRChat game folder (Steam Library -> RMB on VRChat -> Properties -> Local Files -> Browse Local Files);

  5. Drop image file to "UserData/VRCPlusPet_Config/" folder (make sure that file has name "bubble.png").



  > [Green version from the screenshot](https://media.discordapp.net/attachments/674717751662739478/813119607854202880/bubble.png)



How to replace Pet Phrases?


  

  1. Enable "Replace pet phrases?" in mod config (for auto-creating files - game restart needed);

  2. Open VRChat game folder (Steam Library -> RMB on VRChat -> Properties -> Local Files -> Browse Local Files);

  3. Change files in "UserData/VRCPlusPet_Config/" folder.



  > "normalPhrases.txt" - Random phrases. 


  > "pokePhrases.txt" - Random Phrases when poking.

  

How to replace Poke Sounds?



  > Mod currently supports only ".ogg/.wav" sound files. 


  > Sound files can have any names. 


  

  1. Enable "Replace pet poke sounds?" in mod config (for auto-creating folder - game restart needed);

  2. Open VRChat game folder  (Steam Library -> RMB on VRChat -> Properties -> Local Files -> Browse Local Files);

  3. Drop audio files to "UserData/VRCPlusPet_Config/audio/" folder.

 

Warning



  I'm not responsible if you get banned or anything like that! Use this mod at your own risk.

 

Credits


 

  1. Original idea - [VRC-Minus](https://github.com/HerpDerpinstine/VRC-Minus) by HerpDerpinstine;

  2. [UIExpansionKit](https://github.com/knah/VRCMods) by knah;

  3. [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) by HerpDerpinstine.