VRChatMods

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 15 Open GitHub ↗

Collection of my vrchat mods

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Archive Notice
As of the latest VRChat update on 2022/07/27 the game now comes with Easy Anti Cheat. This makes open source modding near impossible. ChilloutVR is another alternative for a VR social game that supports modding and has friendly developers that listen to their community. Sure it might never be as big as VRChat is but I for one will likely never play VRChat again.

# Disclaimer

Modding the VRChat client is against VRChat's Terms of Service. Therefore use these mods at your own risk. I am not responsible for if you get banned or any other punishment by using these mods!

## Mods

- [ActionMenuApi](#actionmenuapi)
- [ActionMenuUtils](#actionmenuutils)
- [StandaloneThirdPerson](#standalonethirdperson)
- [UpdateChecker](#updatechecker)  
- [WorldPredownload](#worldpredownload)

## Canny Posts

I highly recommend checking out the canny posts linked below and upvoting if you'd like VRChat to implement some mods as actual vanilla features

- [World Predownloading/Preloading](https://feedback.vrchat.com/feature-requests/p/preload-worlds)
- [Menu Respawn Issue ActionMenuUtils addresses](https://feedback.vrchat.com/feature-requests/p/respawnhub-hotkey)
- [Not currently a mod feature but priority for friend's avatars first](https://feedback.vrchat.com/feature-requests/p/friends-first-model-priority-loading)
- [Thirdperson for Keyboard/Mouse Users](https://feedback.vrchat.com/feature-requests/p/thirdperson-for-keyboardmouse-users)

## Building

To Build simply:

1. Set a `VRC_DIRECTORY` environment variable. 
    - On Windows you can run `setx VRC_DIRECTORY "C:\[SomePath]\common\VRChat"`

2. Clone repo using git
3. Open solution in an ide that supports C#
4. Build Solution/Specific Project

### ILRepack
A copy of [ILRepack.Lib.MSBuild.Task](https://github.com/ravibpatel/ILRepack.Lib.MSBuild.Task) and [ILRepack](https://github.com/gluck/il-repack) are included in the repo to build the solution

## ActionMenuApi

This mod doesn't do anything on it's own.

It provides an easy way for modders to add integration with the action menu.

It supports the use of the

- Radial Puppet
- Four Axis Puppet
- Button
- Toggle Button
- Sub Menus

### Preview
![Menu Preview](https://i.imgur.com/h43xPEG.png)

Additionally allows mods to add their menus to a dedicated section on the action menu to prevent clutter.

More information [here](https://github.com/gompocp/ActionMenuApi)

## ActionMenuUtils

- Lets you respawn using the action menu
- Lets you go home for when respawning wont save you such as in broken worlds with no floor
- Additionally lets you reset avatar or rejoin instance
- Shows an example of how you might use my action menu api thingy :) more info available [here](https://github.com/gompocp/ActionMenuApi/)

### Acknowledgements

- [Knah](https://github.com/knah/) for the assetbundle loading mechanism from <https://github.com/knah/VRCMods>,
  for suggesting to add a button for go home and just help in general :)
- [Ben](https://github.com/BenjaminZehowlt/) for xref scanning mechanism from <https://github.com/BenjaminZehowlt/DynamicBonesSafety>
- SOS emoji from <https://openmoji.org/> full credit to them for it

## StandaloneThirdPerson

- Has a Freeform camera (thanks ljoonal <3)
- You can scroll in and out using the mouse scroll wheel
- You can switch to behind shoulders too in rear view mode
- KeyBinds configurable via uix/the config file. Valid values can be found [here](https://docs.unity3d.com/ScriptReference/KeyCode.html)
![UIX Settings](https://i.imgur.com/KoRTTqU.png) 
- Third person camera fov and nearclipplane value can be edited as well via uix/the config file

### Preview
#### Directly behind view
![Directly behind view](https://i.imgur.com/Nrq9V3z.jpeg)
#### Front view
![Front View](https://i.imgur.com/BSfitPU.png)
#### Behind right shoulder
![Left Side View](https://i.imgur.com/RuDD82W.jpeg)
#### Behind left shoulder
![Right Side View](https://i.imgur.com/S6vvWwx.jpeg)

### Acknowledgements

- Credit to [Knah](https://github.com/knah/) for [EnableDisable Listener](https://github.com/knah/VRCMods/blob/master/UIExpansionKit/Components/EnableDisableListener.cs)
- Credit to [Psychloor and emmVRC team](https://github.com/Psychloor/PlayerRotater/blob/master/PlayerRotater/Utilities.cs#L76) for world check
- Credit to [ljoonal](https://github.com/ljoonal/) some of the math is loosely based off of their [third person mod for cvr](https://github.com/ljoonal/CVR-Mods/blob/main/ThirdPersonCamera/ThirdPersonCamera.cs)
- Some acknowledgement needs to be given to [emmVRC](https://github.com/emmVRC/) as they are the people that originally (afaik ¯\\\_(ツ)_/¯ ) had a third person mod for vrchat

## UpdateChecker

- Simple mod for people who dislike auto updaters
- Checks for mod updates and lets you know in the console
- Only works for mods that follow the semver format

### Preview
![Console Preview](https://i.imgur.com/s3BP2qf.png)

### Acknowledgements

- Uses [Semver](https://github.com/maxhauser/semver) for semver parsing and handling
- Some code was used from [Slaynash](https://github.com/Slaynash/VRCModUpdater/blob/main/Core/VRCModUpdaterCore.cs)

## WorldPredownload

- You can hit preload on an invite, on a world page or on a friend user page
- You can see your download status bottom right of quick menu
- Currently you can only download/preload one world at a time
- If you go to another world while downloading, it'll cancel the download
- Performance may degrade for split second on world enter due to you having a large cache size

### Preview
![World Page Preview](https://i.imgur.com/tGpwiSC.png)

### Acknowledgements

- Credit to [Natsumi](https://github.com/Natsumi-sama/) for helping me with the new cache structure <3
- Credit to [vrcx team](https://github.com/pypy-vrc/VRCX/blob/master/html/src/app.js) for their regexes to parse the asseturl   
- Credit to [Psychloor](https://github.com/Psychloor/AdvancedInvites/blob/master/AdvancedInvites/InviteHandler.cs) for method to convert worldID to apiWorld instance + much much more, and some of the way stuff is structured is also inspired by his utilities file
- Credit to [Ben](https://github.com/BenjaminZehowlt/DynamicBonesSafety) for xref scanning mechanism and hud icon idea
- Credit to [Knah](https://github.com/knah/) for [Enable Listener](https://github.com/knah/VRCMods/blob/master/UIExpansionKit/Components/EnableDisableListener.cs) and the [hud icon method](https://github.com/knah/VRCMods/blob/master/JoinNotifier/JoinNotifierMod.cs#L120) that I changed to use here along with the [assetbundle loading mechanism](https://github.com/knah/VRCMods/blob/master/JoinNotifier/JoinNotifierMod.cs#L61)
- fwenny for helping with some testing

Repo structure from [Knah's VRCMods Repo](https://github.com/knah/VRCMods/)

VRChatMods

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

VRChatMods

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README