Giter Club home page Giter Club logo

vrcmodloader's Introduction

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 !

vrcmodloader's People

Contributors

atilion avatar bluscream avatar herpderpinstine avatar slaynash avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

vrcmodloader's Issues

manual installation

How do you install this mod manually?
Personally VRChatModInstaller isn't working on my system.

Mod Network Disconnected

Me and my friends used the VRChat Mod Manager for a while now and for the past few days it's been disconnected for us and we tried everything to get it to work but it wont. I looked at the Mod Loading tab when you open VRChat and it says "Could not connect because machine has actively refused it."

VRCModLoader Error

Have had no previous issues or changes to the VRChat directory or my internet, but every time I
run the mod installer the tab opens and reveals a message “Failed to get version info! Please check your internet connection.”

I’ve restarted my system, reinstalled and installed/ran every prior version of the installer, reinstalled vrchat, used multiple VPNs, I’ve even whitelisted the installers exe and of course I’ve been running it ad administrator, nothing seems to work and I’m all out of ideas :/
E937330D-6693-40C9-AE19-9B377D3E1CCE

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.