BricksVR Modding

A simple repo that explains the basics of modding!


Github · Report An Issue · Request A Feature

Modding Types

1. Clientside
   • UI objects such as making the menu dark (darkemod)
   • Adding a cool FPS counter (AXTL's UI Mod)
   • Possibly adding new menus and such!
   • And way more!
2. Serverside
   • Movable bricks as well as new types of bricks!
   • Drivable cars?!
   • A new way to mess with your friends!
   • And again, too much to explain here.

How to start modding

Step 1: Download MelonLoader from https://github.com/LavaGang/MelonLoader and run it.

• Once you run it, it will ask you to select a MONO (or .exe) application
• Select BricksVR.exe and hit run / install
• Once MelonLoader is done installing you are good to go!

Debugging:

Exploring the mechanics and workings of the game can be very difficult at times. UnityExplorer helps us to debug the game and modify some behaviours in real time!

Step 1: In order to begin debugging install https://github.com/sinai-dev/UnityExplorer/releases

• Unity explorer is not necessary for modding, but is a nice QOL application

Step 3: Unzip Unity explorer

• There should be a file called UnityExplorer.MelonLoader.IL2CPP.zip
• Go into said folder and take out the .dll
• Access the mod folder (Location will vary for alot of people)
• Once done put the .dll you took out, and drop it into the mods folder.

You are now done! Enjoy searching the game.

Creating mods

Now on to creating your own mods!

Step 1: Download the TestMod example, after that you can move the master.zip folder to wherever you like, just make sure you can find it in the future!

Step 2: Once unzipped, open the Testmod.csproj file in Visual Studio, do NOT use any other code editors!

• Once done you can get to coding, check out the Scripts directory on how to use some of these features!
• Coding is fairly simple although you do need knowledge of c#
• When you are done coding your amazing new mod, press ctrl + b to build!
• Take the compiled .dll from the build file, and put it in the Mods directory (this will likely be C:\Program Files (x86)\Steam\steamapps\common\BricksVR\Mods for you)!
• Any new mods you create will need to be put in the Mods folder.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Discord - Message us at BelugaTheAxolotl#2134, Darkcryi#7345 or contact the community through the BricksVR Discord server.

Project Link: https://github.com/zakmasood/BricksVRModding

Acknowledgements

• BricksVR Source Code
• Readme based off of Best README Template