https://github.com/knah/vrcmods

A collection of various VRChat mods aimed at improving user experience or fixing issues
https://github.com/knah/vrcmods

game-modding modding vrchat

Last synced: about 1 month ago
JSON representation

A collection of various VRChat mods aimed at improving user experience or fixing issues

• Host: GitHub
• URL: https://github.com/knah/vrcmods
• Owner: knah
• License: gpl-3.0
• Archived: true
• Created: 2019-09-30T16:13:39.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-24T16:40:57.000Z (over 1 year ago)
• Last Synced: 2024-09-26T08:00:26.790Z (about 1 month ago)
• Topics: game-modding, modding, vrchat
• Language: C#
• Homepage:
• Size: 13.8 MB
• Stars: 245
• Watchers: 13
• Forks: 140
• Open Issues: 55
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## This repository is no longer maintained

As you may know, VRChat implemented a client-side anti-cheat in a "security update". This prevents the use of MelonLoader, and with it, these mods.  

Fighting against a commercial anti-cheat is not something I want to spend my time on, goes against the spirit of wholesome modding, and risks bans for people who would choose to use a "bypass". This means that this repository will not see any further development. It will soon be archived.  

If you're looking for a social VR platform that still supports modding and listens to the community, you can check out [ChilloutVR](https://store.steampowered.com/app/661130/ChilloutVR/) ([discord server](https://discord.gg/abi); [modding group discord](https://discord.gg/dndGPM3bxu)) or [NeosVR](https://store.steampowered.com/app/740250/Neos_VR/)  

You can still upvote linked Canny posts for ex-mod features - links for them remain below.  

So long, and thanks for all the fish!

## Original README follows

This repository contains my mods for VRChat. Join the [VRChat Modding Group discord](https://discord.gg/rCqKSvR) for support and more mods!  

Looking for more (universal) mods? [Check out my universal mods repository!](https://github.com/knah/ML-UniversalMods)

### ~~**Don't want to install mods manually? [Check out the VRCMelonAssistant, an automatic mod installer!](https://github.com/knah/VRCMelonAssistant)**~~

### ~~Alternatively, [read the manual installation section](#installation)~~

## Preface

Modifying the VRChat client is not allowed by VRChat Terms of Service and can lead to your account being banned.  

Based on evidence until this point, VRChat Team will happily hand out bans to people using mods with evil features, such as ripping, crashing, and others things you don't want to be on the receiving end of. 

Mods published here aim to avoid negative attention from VRChat Team and hopefully keep their users in a non-banned state as long as possible.  

However, with that said, **these mods are provided without any warranty and as-is**. 

If you use them and do get banned, don't complain to me that you were not warned. 

Also, report your ban to VRChat Modding Group discord (see above) - every data point matters in determining how safe mods are for general public use.

As an extra point, if you encounter an issue with the game (especially after an update), **make sure that issue is not caused by mods before reporting it to VRChat Team**.  

You can add `--no-mods` launch option (in Steam) to temporarily disable MelonLoader without uninstalling it completely.

Some mods will have Canny tickets linked. It's your duty to go and upvote them to show to VRChat Team what you want from their game. If you decide to comment on Canny, **be respectful** and **avoid mentioning modding** - the team still doesn't like it, obviously.  

And yes, it will probably be ignored/forever hanging in "under review" like the majority of Canny posts. At least we'll have a nice big upvote number on our ignored posts.

## AdvancedSafety

Features:

 * Set hard limits on avatar features, such as polygon count, audio sources, and some other things

   * Reduce crashes

   * Improve performance

   * Remove annoying spawn sounds or global sounds

   * Remove some fullscreen effects (this one is unreliable)

   * Avatars over the limit are not replaced by a gray robot. Instead, elements over limits are removed, with the rest of the avatar kept intact.

 * Hide all avatars of a specific author (requires UI Expansion Kit, button is in user details menu)

 * Hide a specific avatar, no matter who uses it (requires UI Expansion Kit, button in in user quick menu)

 * Hide portals from blocked users or non-friends

   * That blocked user will no longer be able to portal drop you

 * Check downloaded avatars for corruption and prevent crashes from them 

This mod will introduce small lag spikes when avatars are loaded. These should be tolerable compared to VRChat's own lag spikes.  

All numeric limits are configurable.  

 * Don't set animators limit to 0 - you will break all humanoid avatars horribly if you do  

Configurable for friends and vanilla "show avatar" button.  

### Bundle verifier notes

Corrupted bundle protection uses a separate Unity process to crash instead of the main one. This comes with several implications:

 * The extra process uses additional system resources, up to a limit

   * Parallel avatar downloads can create multiple processes with corresponding memory usage

   * Avatar data is held in memory while it's being checked, increasing memory consumption even more during avatar download

 * Newly downloaded avatars take longer to load - this is usually a few seconds extra per avatar

   * Avatars loaded from cache are not checked and load as fast as before.

   * Most corrupted avatars never get cached (VRC crashes before writing them into cache), but in some rare situations you might end up with a cached corrupted avatar. In this case you may need to clear your cache, once.

   * The download progress completes twice for checked avatars - once for the download, second time for loading it in Unity itself

 * Some avatars might be rejected because they require too many resources to load. Default limits are 15 CPU-seconds (download time is not included in those) and 2GB RAM. Limits can be changed in settings.

   * After changing limits to be higher, click the "Reset corrupted bundle cache" button to allow re-checking already-rejected avatars.

   * If you have a weaker PC, you may need to increase time limit to be higher.

   * If people around you use horribly unoptimized avatars, you may need to increase the RAM limit.

   * The point above also applies to component limit.

 * Bundle checking is only enabled in public instances by default, but if your friends are somehow not nice, you can enable the mod in all instance types.

   * It ignores "show avatar" as it works on a more-global level

 * All of this should be done by VRChat on their servers, once for every uploaded avatar. AWS Lambda pricing would be under a cent per upload. Alas.

#### Extra credits

Avatar safety is a complex and ever-evolving field, and this mod would not be as great as it is without contributions from @Requi and Ben (of ReMod fame).

**Canny tickets**:

* [Allow changing safety settings based on trust rank of avatar uploader, not wearer](https://feedback.vrchat.com/feature-requests/p/allow-changing-safety-settings-based-on-trust-rank-of-avatar-uploader-not-wearer) (I wanted to implement this, but it would be too API request heavy to be safe)

* [Allow hiding all avatars made by a specific user](https://feedback.vrchat.com/feature-requests/p/allow-hiding-all-avatars-made-by-a-specific-user)

* [Hiding specific avatars](https://vrchat.canny.io/feature-requests/p/blocking-specific-avatars)

## CameraMinus

Allows resizing the camera, zooming it in/out and hiding camera lens.  

This is a lazy rewrite of original [VRCCameraPlus](https://github.com/Slaynash/VRCCameraPlus) by Slaynash.  

Requires UI Expansion Kit - new buttons are added to Camera expando (collapsed by default, click the small blue square near camera to expand) or to Camera QuickMenu expansion (can be chosen in mod settings).  

**Canny tickets**:

* [A few camera suggestions](https://feedback.vrchat.com/feature-requests/p/a-few-camera-suggestions)

* [Move the camera lens to not be instrusively in the middle of the camera screen](https://feedback.vrchat.com/feature-requests/p/move-the-camera-lens-to-not-be-instrusively-in-the-middle-of-the-camera-screen)

## EmojiPageButtons

This mod is deprecated with the new Quick Menu (UI 1.5).  Last revision containing its code can be found [here](https://github.com/knah/VRCMods/tree/c1c21edbb0ce13ef4c12b5ffefe0d9fcc0161f77)

## FavCat

An all-in-one local favorites mod. Unlimited favorite lists with unlimited favorites in them and a searchable local database of content and players.  

**Requires UI Expansion Kit 0.2.0 or newer**  

#### Features:

* Unlimited lists (categories) for favorites, each of unlimited size

* Lag-free even with large lists

* Freely changeable list height

* ~~Avatar,~~ world, and player favorites supported

* Modifiable list order and multiple list sorting options

* Fully searchable database of everything you have ever seen

* Changeable database location (**it's recommended to store the database in a directory backed up to cloud storage, such as Dropbox or OneDrive**, see below for setup)

* Local image cache for even better performance

* ~~Categorize your own private avatars~~

* ~~Import avatar favorites from other local favorite mods (read below)~~

* Exchange search database with friends (read below)

* Hide default lists that you never use  

* Many more small things

#### Known limitations

* Lists with over a thousand elements can take a bit of time on game startup/list creation

#### Canny tickets

* [**Reconsider the approach to paywalling extra avatar favorite slots/groups**](https://feedback.vrchat.com/vrchat-plus-feedback/p/reconsider-the-approach-to-paywalling-extra-avatar-favorite-slotsgroups)

* [The ability to categorize avatars](https://feedback.vrchat.com/feature-requests/p/the-ability-to-categorize-avatars)

* [Search avatars](https://feedback.vrchat.com/feature-requests/p/search-avatars)

* [Personal avatar sorting](https://feedback.vrchat.com/feature-requests/p/personal-avatar-sorting)

#### Changing database location

Steps to change database location:

1. Run VRChat with the mod at least once

2. Make sure that VRChat is closed

3. Navigate to VRChat install directory (i.e. by clicking "Browse Local Files" in Steam)

4. Navigate to `UserData` folder and open `MelonPreferenes.cfg` with Notepad or other text editor

5. Find the line with `[FavCat]`

6. Find the line with `DatabasePath` under it

7. Change the value to absolute path to new storage folder. The new line should look like this: `DatabasePath = "C:/Users/username/OneDrive"` (with your own path, naturally; make sure to use forward clashes `/` instead of backslashes `\\`)

8. Save and close the text file

9. Copy the two (or four) database files (`favcat-favs.db` and `favacat-store.db`, and `favcat-favs-log.db` and `favcat-store-log.db` if they exist) from the old location (they are in `UserData` by default) to the new one.

If you want to move the image cache, use the same steps as above, but modify the line with `ImageCachePath` and copy `favcat-images.db` instead. It's not recommended to store the image cache in cloud storage due to its big size.

#### Sharing search database with friends

You can exchange the search database with friends to be able to find things they have seen. **Only accept databases from friends you trust - an intentionally malformed database can overwrite parts of yours with garbage**  

How to send database to a friend:

1. Run VRChat with the mod at least once (duh)

2. Make sure that VRChat is closed

3. Navigate to where your database is stored (see "Changing database location")

4. Make sure that there is no file named `favcat-store-log.db`. If there is one, it means that the game was not closed properly. In that case, run the game again, and use "Exit VRChat" button in settings menu to close it.

5. Send `favcat-store.db` to your friend.

How to receive database from a friend:

1. Run VRChat with the mod at least once

2. Navigate to VRChat install directory (i.e. by clicking "Browse Local Files" in Steam)

3. Put the database your friend sent you into `UserData/FavCatImport` folder. If you want to import multiple databases at once, you can rename them, as long as .db extension is kept.

4. In-game, click "More FavCat" on any big menu page, then click "Import databases and text files"

5. Import process can take some time. Once it is done, the corresponding database will be deleted from `UserData/FavCatImport` folder.

Note that your favorites are stored in `favcat-favs.db` - don't send it to your friends, favorite import is not supported. Most certainly don't send `favcat-images.db` to your friends - it's just a boring image cache.

#### Avatar favorites deprecation

Due to recent events surrounding modding (modder ban-unban wave, VRC Team/modders discussion, API changes), I've decided to remove extra avatar favorites from FavCat.  

One of the biggest concerns raised during the still-ongoing discussion between modders and VRChat Team is mods stepping on VRC+ features. VRChat relies on VRC+ supporters to pay for servers and ensure that VRChat continues existing.  

As such, I wanted to proactively address that concern. One of my main goals with modding VRChat is making the game better for everyone, and negatively affecting the platform itself goes against that.    

I believe this step to be necessary to ensure that VRChat team sees (wholesome) modding not as a threat, but as an opportunity.  

On top of that, recent API changes indicate that VRChat Team is taking action to restrict access to avatars. It might be an attempt at ripping prevention, or it might be aimed at privacy enhancement, or it might be aimed at extended avatar favorites. There's no way to tell for sure, and there's no knowing how far those changes would go in the future. 

Local favorite mods have to rely on the API to some degree, and with things changing quickly, there's no reliable way to ensure that things will stay working and stay safe ban-wise in the long run.

Before you read on, please [scroll up a bit](https://github.com/knah/VRCMods#canny-tickets) and **upvote all linked Canny tickets related to avatar favorites**. If you decide to comment on them, remember to **stay civil** and **avoid mentioning mods**.

In more practical terms, this means the following:

 * Starting with this update, you will not be able to add new avatar favorites, create new avatar favorite lists, or import avatar favorite lists  

 * Starting on 2021-05-31, you will not be able to access your existing avatar favorite lists in-game

 * Avatar search will stay accessible for the time being.

 * World and user favorites will stay accessible for the time being.  

   VRChat Team did mention during the recent dev stream that they are going to provide additional player and world favorites for everyone at some later point.

 * You can export all your favorites into plain text files from "More FavCat..." menu in the respective menu page. Exported lists are put in `UserData/FavCatExport` folder.

   Export will be always available and is not subject to time limits mentioned above.  

   This has limited usability, but you probably can put them on pedestals in your own world or find an udon world that has change-pedestal-to-id function (unless that gets restricted eventually).   

   This is still somewhat iffy, but it's unwieldy/uncomfortable enough compared to in-menu favorite lists that I wouldn't consider that as a viable replacement for VRC+ extra favorites.

##### FAQ:

**Q1**: But what about *another mod X* that still offers unlimited avatar favorites for everyone?  

**A1**: Good question! If that is a VRCMG mod, it'll likely follow suit.   

If it's not a VRCMG mod, if I were you, I'd be *extremely* wary of that. Those mods are unverified in VRCMG, and usually for a good reason.  

There have been numerous cases of unverified mods being harmful towards their own users. After all, if one makes a mod to harm other users and/or VRChat itself, who says that they wouldn't want to harm its own users eventually for some petty reason?  

Additionally, consider this: recently there was a relatively big ban wave against users of a certain malicious/unverified mod. It's not too hard to imagine that another malicious/unverified mod will be next.

**Q2**: Does that mean that mods are now okay if they don't touch VRC+?  

**A2**: Nope! According to VRChat Team all mods are still against Terms of Service and therefore bannable, nothing has changed there.

**Q3**: Why only remove avatar favorites, but not world and/or player favorites?  

**A3**: Simply because extra world/player favorites are not a VRC+ feature.  

If, for whatever reason, VRChat decides to remove extra avatar favorites from VRC+ (for example by giving 100 slots to everyone), modded extra favorites will likely come back.

**Q4**: Why remove avatar favorites completely instead of restricting them to VRC+ users?  

**A4**: A fully local mod can't be reliably restricted.

Significant codebase drift, however, is at least mildly annoying to deal with, which reduces probability of questionable forks continuing to provide the same functionality. 

**Q5**: Someone is/will be distributing a modified version of this mod with this dumb restriction removed.  

**A5**: See question one. Also, that's not my problem anymore. Also, if it's **you** who happens to provide that version, make sure your version is easily distinguishable from the mainline one, for example by adding a suffix to the name or version number.

**Q6**: People who don't want to pay for VRC+ won't pay for it anyway, why even bother? / **Answer 2,** therefore why even bother?  

**A6**: It's not only about VRC+, but also about sending a message. There's much to be gained from cooperating with VRChat Team. Monetization/cash flow is an important concern for any company. Being pointlessly contrarian here doesn't help anyone. 

**Q7**: This is a blatant VRC+ cash grab!  

**A7**: If you choose to look at it that way. VRChat needs to get money from somewhere to pay (likely huge) server costs, and eventually repay investors on top of that. Blatantly and purposefully denying them that is simply an asshole thing to do. Also see question 9.    

**Q8**: Today they come for our extra favorites, tomorrow they'll come for *modded feature Y*!  

**A8**: Perhaps. I can't affect VRChat Team's decisions to paywall certain features.  

However, based on the dev stream, it seems unlikely that we'll see much paywalling - there was no mention of "VRC+ only" in respect to any of the new features, except for the few features *specifically for* other VRC+ features.  

**Q9**: You're a sellout/shill! / MelonLoader devs are sellouts! / *Other personal attack or insult*! / *Other rumor without any proof*!  

**A9**: I get it, you're 14 and angry. And I have better things to do than needlessly fighting VRChat Team about the direction they want to take their game in and getting a bunch of people banned along the way.

 

**Closing word**:  

With the introduction of VRC+, users and their feedback became much more important, simply because VRChat depends more than ever on user support to continue existing and developing.  

You now have the option of voting with your wallet (purchasing/cancelling VRC+ depending on your opinion of the direction VRChat is going in), in addition to talking to your friends about it, providing feedback to VRChat via discord or Canny, and exploring competing social VR platforms.  

Capitalism at its best and all that.

#### Used libraries:

* [LiteDB](https://github.com/mbdavid/LiteDB) for all data storage

* [ImageSharp](https://github.com/SixLabors/ImageSharp), because unity is bad at loading images from streams on background thread

A long time ago this was based on Slaynash's [AvatarFav](https://github.com/Slaynash/AvatarFav) and [VRCTools](https://github.com/Slaynash/VRCTools), both licensed under the [MIT license](https://github.com/Slaynash/VRCTools/blob/master/LICENSE). Who knows how much of that still remains inside?

## Finitizer

This mod fixes a set of issues arising from invalid floating point values being accepted from remote users.  

**It might have a minor impact on performance that scales with player and pickup count**. Only use this mod if you frequent publics.

## Friends+ Home

Allows changing instance type of your home world to whatever you want.  

Setting it to public will choose a random populated public instance if one is available.  

UI Expansion Kit 0.2.0 or newer recommended for in-game settings.  

Known instance types are `Public`, `FriendOfGuests`, `FriendsOnly`, `InvitePlus` and `InviteOnly` (if you wish to edit modprefs.ini by hand)

**Canny tickets**:

* [Allow setting your home world to a friends/friends+ instance](https://feedback.vrchat.com/feature-requests/p/allow-setting-your-home-world-to-a-friendsfriends-instance)

## IKTweaks

This mod offers a customized spine solver for full body tracking, and a few other IK-related tweaks.  

Features:

* Alternative spine solver for FBT that people know and love

* The alternative solver can bend the spine more than "lock one" but less than "lock both" modes

* Flexible configuration for said solver, allowing you to fine-tune IK for your avatars and preferences

* Remote players see the new IK too, there's no mismatch between what you and others see

* Stop freezing in walls and tables (or anywhere near them)

* Say goodbye to locomotion animations on all avatars if you hate them

* Adjust hand offsets so your virtual hands line up better with your real ones

* Tune some aspects of IK 2.0, like that pesky elbow-torso avoidance that sometimes makes your elbows *go places*

* Most features are compatible with 3-point and higher IK 2.0

It's recommended to use a normal humanoid rig without any rig hacks (so no neck fix, no FBT fix, no inverted hip, no zero-length spine bones).  

**Canny tickets**:

* [Stop locking avatars in place when players walk through walls](https://feedback.vrchat.com/vrchat-ik-20/p/stop-locking-avatars-in-place-when-players-walk-through-walls)

* [Provide in-depth IK configuration options for enthusiasts](https://feedback.vrchat.com/vrchat-ik-20/p/provide-in-depth-ik-configuration-options-for-enthusiasts)

* [Add calibration mirror or something similar.](https://vrchat.canny.io/vrchat-ik-20/p/feature-request-add-calibration-mirror-or-something-similar)

* [Add support for one-handed calibration](https://vrchat.canny.io/vrchat-ik-20/p/featureaccessibility-add-support-for-one-handed-calibration)

* ... and the rest of IK 2.0 Beta board (assuming it stays)

### Brief settings description

Given that this mod is still work in progress, these are subject to change.

 * Use Pitch-Yaw Shoulders - changes how shoulder angles are computed in 3/4-point tracking. Enabling it usually provides better-looking results

 * Animations mode in FBT - control which part of your body can be controlled by animations when in 6-point FBT

 * Feet stick to ground - uncheck if you want your feet (and the rest of your avatar) to be unable to leave the ground, like in ol' good times

 * Enable IKTweaks (use custom spine solver) - uncheck to go back to default VRC FBT IK.

 * Enforce hip rotation match - if enabled, avatar's hip rotation will exactly match tracker's rotation. Otherwise, IK may rotate the hip to bend the spine more.

 * Shift hip pivot (support inverted hip) - if enabled, the hip will be rotated around the midpoint of two leg bones (where the hip bone should be normally). This greatly improves IK on avatars with the inverted hip rig hack.

 * Pre-straighten spine (improve IK stability) - if enabled, you avatar's spine will be forcefully straightened before solving it. This reduces flippiness/jitter on avatars that have spine bent backwards by default.

 * Straighten neck - this does something cursed to the neck. No further description can be provided.

 * Spine Relax Iterations (max 25) - how much work will be done on bending the spine. Below 5 is not recommended, 10 will provide about 1mm precision for hip positioning, 25 is the maximum sensible value.

 * Maximum bend angles - how much spine/neck can be bent forward/back. If your spine bends too much to your taste or looks cursed on your specific avatar, reduce these angles (minimum recommended value is 1 though). **Angle limits are ignored in "lock both" mode.**

 * Neck bend priority - neck will bend this much faster than the spine. This is intended to handle the fact that people move their neck way more than their spine, so IK should start off by bending it, not spine.

 * Straight spine angle - within this angle from perfectly straight, the spine will be considered almost straight and maximum bend angles will be reduced.

 * Straight spine power - controls the curve with which the spine transitions from straight to bend within the straight angle. Recommended values are between 1 and 2.

 * Allow more head rotation in 3/4-point tracking - ever tried to look up when close to the ground in 3/4-point tracking? Now you can, even if it breaks your neck.

 * Don't freeze head/hands inside walls - prevents your hands/head from freezing if your head gets inside a wall.

 * Disable IK2 elbow-chest avoidance - brings behavior of elbows closer to old 3-point IK, solving some issues with elbows spazzing out in some poses

 * Knee angle mode - affects how knee angle is chosen when you have leg trackers but not knee trackers. "IKT classic" should be the old knee positioner, which is... Bad. "IKT Natural" attempts to bend knees into a more relaxed pose.

 * Hand angles/offsets (found in VRChat Settings menu -> left blue panel -> More IKTweaks -> Adjust hand angles/offsets) - you can configure how avatar hands are positioned relative to controllers. Defaults were tuned for Index controllers, but should be applicable to most other controllers too.

## JoinNotifier

A VRChat mod to notify you when someone joins the instance you're in

Current features:

 - Visual and audible notifications (configurable)

 - Toggleable per instance type (public/friends/private)

 - Can be set to highlight friends or show only friends

 - Custom join/leave sounds - put files named `JN-Join.ogg` and/or `JN-Leave.ogg` into `UserData` folder to override default sounds (they must be in Ogg Vorbis format, naturally)

**Canny tickets**:

* [Join / Leave notifications](https://feedback.vrchat.com/feature-requests/p/join-leave-notifications)

## Lag Free Screenshots

This mod significantly improves screenshot taking performance for handheld camera in VR and F12 key in desktop mode. Benefits are especially noticeable with higher resolution screenshots (4K/8K).

Additional features:

 * You can set your screenshots to be saved as JPEG files instead of PNG to save on file size.  

 * Automatically rotate screenshots so that proper side faces up (like on your real phone!)

 * Add metadata about world and players to screenshot files (disabled by default; both JPEG and PNG are supported, though PNG metadata is not displayed by Windows - you'll have to use a use different photo viewer software)

**Canny tickets**:

* [Record or correct camera orientation](https://feedback.vrchat.com/feature-requests/p/record-or-correct-camera-orientation)

* [A few camera suggestions](https://feedback.vrchat.com/feature-requests/p/a-few-camera-suggestions)

* [8K camera](https://feedback.vrchat.com/feature-requests/p/8k-camera)

## MirrorResolutionUnlimiter

Headset and display resolutions increase each year, and yet VRChat limits mirror resolution to 2048 pixels per eye. With this mod, that's not the case anymore!  

Set whatever limit you want, with an option to un-potatoify mirrors that world makers set to potato resolution for their insane reasons. Or you can make all mirrors blurry as a sacrifice to performance gods. It's up to you, really.

Note that increasing mirror texture resolution will increase VRAM usage and lower performance, as your GPU will have to do more work.

If UI Expansion Kit is installed, Settings page in the main menu will get two buttons to optimize and beautify all visible mirrors in the world.

Settings:

 * Max mirror resolution - the maximum size of eye texture for mirror reflections. 2048 is VRChat default, 4096 is mod default.

 * Force auto resolution - removes mirror resolution limits set by world maker. Off by default.

 * Mirror MSAA - changes MSAA specifically for mirrors. Valid values are 0 (same as main camera), 1, 2, 4 and 8. Lower MSAA may lead to "shimmering" and jaggies, especially in VR.

**Canny tickets**:

* [problem of maximum resolution of mirror](https://feedback.vrchat.com/feature-requests/p/problem-of-maximum-resolution-of-mirror)

## ParticleAndBoneLimiterSettings

This mod provides an UI for changing VRChat's built-in dynamic bone and particle limiter settings.  

Refer to VRChat docs [for particle limiter](https://docs.vrchat.com/docs/avatar-particle-system-limits#particle-limiter-configuration-description) and [for dynamic bone limiter](https://docs.vrchat.com/docs/avatar-dynamic-bone-limits) for a detailed description of what these settings do.  

Changing these settings should not require game restart.  

Requires UI Expansion Kit. Settings are placed into the Mod Settings menu.

**Canny tickets**:

* [Particle Limiter](https://feedback.vrchat.com/feature-requests/p/particle-limitier)

## ScaleGoesBrr

This mod adds proper support for scale sliders on AV3 avatars that have them.

Proper support includes properly scaling your playspace and viewpoint in VR, including in FBT, so the avatar functions the same way as if you scaled it in Unity (and adjusted the viewpoint).

This requires avatars to actually have a scaling control, but adding that to your own avatar is not terribly complicated if you're familiar with AV3.

**Required avatar setup**:  

All the avatar needs to do is scale **avatar root** (not armature, not hips, and not any other bone).

No further setup is necessary - no state behaviors, no animating viewpoint position, no pose space or other hacks, just root scale.  

It's not recommended to scale avatar too small (below 0.1 scale) or too big as that might lead to issues with using the menu, similar to extremely tiny or huge avatars.  

**Canny tickets**:

 * [Remeasure avatar](https://vrchat.canny.io/avatar-30/p/remeasure-avatar) (not this exact feature, but a similar one)

## SparkleBeGone

This mod is deprecated with the new Quick Menu (UI 1.5). Last revision containing its code can be found [here](https://github.com/knah/VRCMods/tree/c1c21edbb0ce13ef4c12b5ffefe0d9fcc0161f77)

## Styletor

This mod allows you to reskin your Quick Menu (and, eventually, main menu and other UI elements) using VRChat's new UI Styling system.  

**Important note:** VRChat's UI Style system is currently not released for general use, and, as such, may change at any moment without notice. In practical terms this means that UI styles made for this mod can break on updates easily and frequently.  

Custom UI styles (both user-provided and world-provided) are planned for UI 2.5 update. Pray that neither of those will be a VRC+ feature, because you know how that goes.

*Styletor will be back next week with new questionable styling facts*

**Requires UI Expansion Kit**

#### Usage (simple):

 1. Install the mod and UI Expansion Kit

 2. Select "Basic Recolorable Style" in mod settings

 3. Adjust colors as you see fit

 4. To easily replace QM background:

    1. Find an image you want. Ideally it would be a transparent PNG image with 797x1024 resolution. JPEG images are supported too.

       * A more square aspect ratio for the image might be required - that resolution is based on default style, but the actual menu looks way more square than that. Perhaps 1024x1024 would be good?

    2. Put the image into `UserData/StyletorStyles`, named exactly `background_layer_02_lines` (including image format extension).

    3. Click "Reload styles from disk" button in mod settings to apply it without restarting.

 5. To install custom styles/skins, put them into `UserData/StyletorStyles`. Both directory-based skins and ZIP files are supported. "Reload styles from disk" button will show them in UI without restarting.

#### Creating styles

 * You can export the default style to use as a reference using "Export default VRChat style" button in mod settings

 * Create a new folder in `UserData/StyletorStyles`, i.e. `UserData/StyletorStyles/my-cool-style`

 * In that folder, create a file named `info.json`, i.e. `UserData/StyletorStyles/my-cool-style/info.json`. This JSON file contains some info about your skin, such as name. See [this class](Styletor/Jsons/StyleMetadata.cs) for a description of its format.

 * If you want to override style properties, create a file named `overrides.vrcss`. This file uses the same format as styles in the default skin. No, the format is not documented anywhere, just follow the example of default style.

 * If you want to override style properties after all previous overrides from your style were applied, create a file named `overrides-secondpass.vrcss`. It uses the same format as `overrides.vrcss`

 * If you want to override images/sprites, place them in same files (and paths) as the default example skin.

 * You can additionally specify certain sprite properties using an extra JSON file named same as image file with added `.json` extensions, i.e. `background.png.json`. The format for this JSON is described in [this file](Styletor/Jsons/SpriteJson.cs)

 * If you want to make an user-friendly distribution of your style, you can add all contents of your style folder to a ZIP file (so that info.json is in ZIP file root) and distribute that.

 * Note that you should not redistribute original VRChat assets (as provided by default skin export) due to copyright restrictions.

 * If you want your style to support user-provided colors, you can use special color placeholders. A list of them can be found in [this file](Styletor/Styles/ColorizerManager.cs) (look for `ReplacePlaceholders`)

 * You can look at example styles in [this folder](Styletor/BundledStyles)

#### Custom stylesheet instructions

Styletor provides a few custom stylesheet instructions to make certain tasks easier:

 * `!!styletor-copy SelectorA !! SelectorB` will copy a style for `SelectorA` into `SelectorB`. This can both create new style for `SelectorB` or overwrite an existing one.

 * `!!styletor-new` can be used, alone on a line, before a selector block to mark it as a new style. This suppresses "overrides nothing" warnings.

 * `!!styletor-new-block-start` and `!!styletor-new-block-end` (alone on a line) can be used to mark start and end of a block wn which all styles are considered `!!styletor-new`

#### Integration for other mods

 * Other (GPL-compatible) mods can provide custom styles via [an API](Styletor/API/StyletorApi.cs)

 * Alternatively, mods can have embedded resources with names ending in `.styletor.zip` for mod-provided styles

 * For mods that modify Quick Menu, cloning default elements should be sufficient to make them styled (as long as you don't delete StyleElement component off them)

#### Known limitations

 * Main menu is not currently recolored. It doesn't use the style system, although I'm looking into applying styles to it too before UI 2.0 update (which would make this menu styleable too).

 * If you add new properties to a style, changing to another style without those properties will leave them applied to elements.

   * This is why the "Default style fixes" mix-in exists - it adds some properties over the default style to make reverting to it work properly

   * In general, if your skin has issues with reverting to default VRC style, you should also ship a similar "fixes" mix-in style to add missing properties to the default style.

 * UI sounds (or any other resources other than styles and textures/sprites) can't be overridden. This will likely be expanded upon eventually.

#### Extra credits

 * Non-readable texture export method was adapted from [UnityExplorer](https://github.com/sinai-dev/UnityExplorer)

 * Lemon image used on the sample lemon QM background comes from [Twitter Emoji](https://github.com/twitter/twemoji)

## True Shader Anticrash

This mod prevents practically all known shader crashes. Note that it can affect how stuff looks as it rewrites shader code to be non-crashy. Setting changes require world rejoin to reload shaders.

### Partial source code

Main logic of this mod is located in the native DLL that currently is not opensource. The DLL is build upon [HLSLcc](https://github.com/Unity-Technologies/HLSLcc) and uses [Microsoft Detours](https://github.com/microsoft/Detours). An opensource release for it will likely be available at a later point.

## Turbones

This mod significantly speeds up dynamic bones by optimizing collision checks, the simulation code, and optionally providing multithreading.    

Features:

 * Highly efficient collision checks - hundreds thousands per frame without noticeable performance drop

 * Optimized dynamic-timestep simulation code - no more FPS dropping even more because of DB script doing additional steps per frame

 * An option for multithreading dynamic bone simulation (but this one is of limited usefulness due to simulation being already too fast)

 * No more weird twitching or jerkiness (when using optimized simulation)

 * Collision feedback API for other mods

 * Integrates seamlessly with VRChat's dynamic bone limiter (you may want to increase limits *a lot*) and global dynamic bone mods 

Big thanks to Zettai for finding that collision checks are a very low-hanging easy-to-optimize target, and a lot of other work on multithreading dynamic bones.  

Optimized bones have slight visual differences in behavior due to switching to dynamic timestep.  

Additionally, some weird configurations might have issues with optimized/multithreaded simulation. Specifically, the following *will* behave erratically:

 * Zero length bones

 * Dynamic bone colliders on transforms controlled by dynamic bones

 * Dynamic bone components (or roots) on transforms controlled by other dynamic bones

### Other mod compatibility

This mod should be compatible with all "global dynamic bones" type mods out of the box.  

For mods working on collisions (i.e. ImmersiveTouch), you have two options:

 * Either the mod needs to support collision feedback (see [the collision feedback API](Turbones/JigglySolverApi.cs))

 * Or you can disable custom dynamic bone solver while leaving optimized collision checks enabled - this should be compatible with other mods patching collisions.

### Partial source code

Main logic of this mod is located in the native DLL, which contains the optimized dynamic bone code.  

Sources to it can't be published due to it being based on the paid Dynamic Bone asset from Asset Store.  

The DLL uses Rust with `glam` vector math library.

 

## UI Expansion Kit

This mod provides additional UI panels for use by other mods, and a unified mod settings UI.  

Some settings (currently boolean ones) can be pinned to quick menu for faster access.  

Refer to [API](UIExpansionKit/API) for mod integration.  

MirrorResolutionUnlimiter has an [example](MirrorResolutionUnlimiter/MirrorResolutionUnlimiterMod.cs) of soft dependency on this mod

 

This mod uses [Google Noto](https://www.google.com/get/noto/) font, licensed under [SIL Open Font License 1.1](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL).  

## View Point Tweaker

This mod allows you to move view point ("view ball") on avatars. The tweak will affect only you, but other players will see your adjusted head position correctly.  

Adjusted view points are saved per avatar.  

**Requires UI Expansion Kit 0.2.0+**. The menu to tweak view point can be found in UI Elements Quick Menu submenu.  

Do note that the coordinates displayed in that menu are local offset of the view point, not the coordinates you set in avatar descriptor.

## ILRepack

There's a copy of [ILRepack.Lib.MSBuild.Task](https://github.com/ravibpatel/ILRepack.Lib.MSBuild.Task) and [ILRepack](https://github.com/gluck/il-repack) built for netcore/MSBuild 16 shipped with the repo.

## IntegrityCheckGenerator and IntegrityCheckWeaver

These two serve to tightly integrate integrity check with mods to make automated patching of it harder. See [this writeup](Malicious-Mods.md) for rationale for this.

## Installation

To install these mods, you will need to install [MelonLoader](https://discord.gg/2Wn3N2P) (discord link, see \#how-to-install).  

Then, you will have to put mod .dll files from [releases](https://github.com/knah/VRCMods/releases) into the `Mods` folder of your game directory

## Building

To build these, drop required libraries (found in `/MelonLoader/Managed` after melonloader installation, list found in `Directory.Build.props`) into Libs folder, then use your IDE of choice to build.

 * Libs folder is intended for newest libraries (MelonLoader 0.4.0)

## License

With the following exceptions, all mods here are provided under the terms of [GNU GPLv3 license](LICENSE)

* ILRepack.Lib.MSBuild.Task is covered by [its own license](https://github.com/ravibpatel/ILRepack.Lib.MSBuild.Task/blob/master/LICENSE.md)

* ILRepack is covered by [Apache 2.0 license](https://github.com/gluck/il-repack/blob/master/LICENSE)

* UI Expansion Kit is additionally covered by [LGPLv3](UIExpansionKit/COPYING.LESSER) to allow other mods to link to it

* Bundle Verifier executable shipped in Advanced Safety is provided as-is, all-rights-reserved, without any warranty, and without source code (for the time being, it will be opensourced eventually)

* Assetbundles included in some mods are not code (so not covered by GPL) and all-rights-reserved for the time being. Opensourcing Unity projects is mildly painful, but I'll likely do that eventually too under some kind of CC license