Description

Helps add jiggle physics to your cosmetics (or any in-game model). Please read the tutorial on how to do so below!

Note:

• This plugin can be used to add jiggle physics to any model loaded in-game. While this tutorial mainly focuses on cosmetics, the steps below can be applied to any rigged model in Unity.
• The tutorial below assumes you already have the MoreCompanyCosmeticPackage imported and set up in Unity already. You can find a tutorial for that HERE

BEFORE READING AHEAD: YOUR MODEL MUST BE RIGGED IN ORDER FOR JIGGLE PHYSICS TO WORK

If your model is not already rigged, you can watch this great video by Seymour (his Thunderstore profile) which covers rigging your model using Blender:

Disclaimer/Credits

I only created the plugin for BepInEx to load, all the scripts this plugin uses was made by Naelstrof, I only compiled them. Again, NONE of the scripts/code was produced by me. You can find the GitHub project HERE

Video Tutorial

A video tutorial covering the information below can be viewed here:

Tutorial

Getting Your Unity Project Setup

• Install this mod via r2modman or the thunderstore app
• Navigate to the folder where this mod was installed
  • In r2modman/thunderstore app, you can click on Settings on the left-hand side and click on "Browse Profile Folder"
  • Here, you can click into BepInEx -> plugins -> HGG-JigglePhysicsPlugin (Take note of the BepInEx folder as you will be navigating there again shortly)
• With your Unity project open, create a new folder, name it, and drag and drop the JigglePhysicsPlugin.dll from the HGG-JigglePhysicsPlugin folder into that folder (I have named mine "Test")

• Next, navigate to where your BepInEx is installed, and click into the "core" folder

• Drag all the highlighted dll's into Unity, the same place you placed the JigglePhysicsPlugin.dll (Do NOT drag in BepInEx.Harmony.dll, it is unnecessary and will cause your Unity to crash) Your project should now look like this:

• If the arrow besides the dll does not show up, you may have to close your Unity project and re-open it

Adding Jiggle Physics To Your Model

• Click the arrow on the JigglePhysicsPlugin.dll and drag JiggleRigBuilder onto the model you want jiggle physics added to (I just copied the scavengermodel to test, do NOT move or add the script to the original)

• In the Inspector, you should now see that "Jiggle Rig Builder (Script)" has been added as a component to your model

• In this script, you will want to drag the part of the model that you want jiggle physics to be added to onto "Root Transform"

• Next, right click in the folder where your dll.'s were placed, click "Create" -> "JigglePhysics" -> "Settings", this will create a Jiggle Settings

• Drag the newly created settings into the Jiggle Rig Builder (Script), into "Jiggle Settings"

• Now, hit the Play button at the top of Unity and re-select the Scene view, this will allow you to move your model and see the physics in real-time

• While in "Play mode", you can click on the Settings file you created earlier and adjust the settings to fit your needs

• Once you've tuned the physics to your liking, exit "Play mode", and follow the necessary steps to build your cosmetic. Those steps, again, can be found HERE
• If done correctly, you should have added jiggle physics to your cosmetic, congrats!

Contact

If you are having trouble or have any questions, you can reach out to me on discord @ waga. / Waga#7703

v1.1.21

• Fixed the boken image links in the README

v1.1.2

• Updated README
• Added a video tutorial for rigging models, made by Seymour
• Fixed inccorect plugin version displaying in BepInEx logs

v1.1.1

• Added a video tutorial

v1.1.0

• Fixed loading priority so JigglePhysicsPlugin should always load before any mods that load cosmetics, increasing compatibilty
• Removed "Incompatible Mods" section in the README

v1.0.2

• Added incompatibility section

v1.0.1

• Updated the tutorial

v1.0.0

• Release