Skip to content

Bluscream/VRCModLoader

 
 

Repository files navigation

VRCModLoader

A VRChat mod loader based on Illusion Plugin Architecture

Installation

Before install:

  • Tupper (from VRChat Team) said that any modification of the game can lead to a ban, as with this mod
  • You need to know that this mod has not been validated by the VRChat team, but they don't seems to care if someone use it

You can install it using the mod installer available on the VRCTools website

How does it works

This file is loaded by the modified UnityEngine.dll assembly.
On start, it will first install/update the VRCTools mod (It's a required mod for having all VRCModLoader features), copy all files located in <VRChat_Install_Folder>/Mods to a temporary folder, and then load all of them.

How to create a mod

To create a mod, you will need to create a new C# library, and reference the VRCModLoader.dll, UnityEngine.dll and UnityEngine.CoreModule.dll files. (you may also need more other UnityEngine.*.dll files)
A basic mod main class is made like this:

using VRCModLoader;

//VRCModInfo(name, version, authorname [, downloadurl])
[VRCModInfo("TestMod", "1.0", "Slaynash")]
public class TestMod : VRCMod
{
    // All the following methods are optional
    // They also works like Unity's magic methods
    void OnApplicationStart() { }
    void OnApplicationQuit() { }
    void OnLevelWasLoaded(int level) { }
    void OnLevelWasInitialized(int level) { }
    void OnUpdate() { }
    void OnFixedUpdate() { }
    void OnLateUpdate() { }
    void OnGUI() { }
}

You can also reference VRCTools to use the VRCTools utils (VRCUiManagerUtils, ...) and/or use the VRCModNetwork
(Please ask Slaynash on the VRCTools discord to register your packets first or they will be refused by the server)

Launch Options

  • --no-vr: Start the game without VR (game command)
  • --verbose: Enable the debug console
  • --vrctools.noupdate: Disable the VRCTools download/update on game start
  • --vrctools.forceupdate: Force the update of VRCTools on game start
  • --nomodloader: Disable the modloader

Tutorials and helps

Unofficial VRChat API Documentation: http://vrchatapi.github.io/ ... More coming later ...

Disclaimer

'I' stand for Hugo Flores (Slaynash).

I am not affiliated with VRChat. This content is for entertainment purpose only, and is provided "AS IS". I am not responsible of any legal prejudice against VRChat, the VRChat team, VRChat community or legals prejudice done with an edited version of this code.

Want more infos or some help ?

You can join the VRCTools discord server if you need some help, want to know when an update is released, the status of the known bugs, the upcoming features, or simply talk with others !

About

A VRChat mod loader based on Illusion Plugin Architecture (https://github.com/Eusth/IPA)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 100.0%