Jiggle Bones

<cat>Model.Physics</cat> 
<title>Jiggle Bones</title>

# Introduction
Jiggle bones are a simple way to give physical, dangly attributes to your models. They have various usages including simulating hair and rope, forming solid hinge-based objects, and also have organic applications such as simulating breasts and fat.

This page covers how to set up your bones in Maya and implement them as jiggle bones in-game. Knowledge is still fairly limited on this topic, but the below guide should help you understand the basics of jiggle bones for you to experiment and have fun.

The fundamental and theoretical approach to bones and rigs are quite consistent across modelling packages.

**This page does not cover in detail modelling, rigging, skin binding, or implementation.**

###The assumption is that:
1. You know how to [create and manage addons and projects](https://wiki.facepunch.com/sbox/CreatingProjects) in s&box.

2. You know how to [import your 3d asset into ModelDoc and get it in-game](https://wiki.facepunch.com/sbox/Importing_and_creating_assets).

3. You have set up the skeleton for your model and it is rigged, whether that is a creature, a simple prop with dangly parts, or a clothing item for Terry. The character rig from Terry’s model (citizen_2022-10-31.fbx) is what we will be using throughout this page, so if you are simulating bones on Terry’s clothes (zippers, frilly parts, etc), you’re especially in luck, but the same knowledge applies to simpler props.

4. If it is a piece of clothing for Terry, you have properly bound it to Terry’s skin and it synchronises with Terry’s joints, bones, and movements. Check out [Danduw's video](https://www.youtube.com/watch?v=W7AoTMVv3QQ) for more information on garment creation.

5. For the Maya parts, make sure you've got some experience using the software. You can also apply the same techniques in Blender.

#Contents
This tutorial will cover applying two jiggle bones to two different things: [a zipper on a boot](#zipper), and [a pair of fake breasts](#creatingjigglebonesforthefakebreasts). 

If you want to skip adding bones then head straight to [implementation](#4importingintomodeldoc). 

There is also a short [list of examples from Valve](#valvesexamples) from other Source games to give you an idea of how they are made.

**This page should hopefully cover you for most other applications of jiggle bones.** The article gives you a general foundation for you to go and experiment. Jiggle bones can give some very interesting and dynamic results.

One thing to remember is this: **jiggle bones take a long time to tweak.** You will likely not achieve the desired effect for your jiggle bones immediately. Additionally, **you are at the mercy of a physics engine.** 
This means it can be hard to control your jiggle bones, and clipping is often present. However, thanks to the proactive nature of Source 2, we can edit the jiggle bones using ModelDoc’s GUI to see the effect immediately after recompiling your model.

<warning>**Make frequent backups.** Before you press on, absorb this universal advice. Source 2 is an engine that permits rapid changes to your content. Make sure you save a screenshot of your jiggle bone settings as well. </warning>

#Terminology refresher
###Vertex weights
Every model is made up of vertices (the corner points of a mesh.) Source 2 needs to know which vertices will be affected by which bone so it can accurately simulate the physics effects upon each vertex. The process to mark these vertices is called **vertex weight painting**. In Maya, the whiter the vertex, the more that vertex will be **influenced** by that bone. Notice how when we paint vertices black, we can save a bad case of clipping, as we reduce the influence upon that bone by removing the white paint.
<upload src="b35c1/8dafa36c1839b66.gif" size="1031931" name="PaintingExample.gif" />
###Influences
**Bones and joints** must **influence** vertices. By selecting a joint in the **hierarchy list** during painting, we can see how it affects surrounding vertices (the white and black paint on the model).
<upload src="b35c1/8dafa36ff3835f4.gif" size="433059" name="HierarchyPaint.gif" />
###Joints and bones
Bones are the longer shaped object that sits between two joints. Joints are the round object that sits between the bones.
<upload src="b33fe/8daf981bca18ae8.png" size="16223" name="image.png" />
###Hierarchy
In Maya, skeletons are organised into hierarchies, with parent bones and child bones. For example, lower arm > wrist > fingers. Your jiggle bones will need to be placed into the most suitable (usually the nearest) hierarchical section for them to behave properly.
<upload src="b33fe/8daf8e868ec8a42.gif" size="259814" name="HierarchyMaya01.gif" />
###Deformation
How the vertices are pulled, stretched, and warped due to their surrounding influences. Deformation is good for organic parts, but not great for solid parts (such as zippers, metal, etc).

###Skinning
This is the process of binding the mesh and its vertices to the nearest bone on the skeletal rig. Again, [Danduw's video](https://www.youtube.com/watch?v=W7AoTMVv3QQ) goes over that in  more depth.

#Important advice before you start
###1. Make backups.
Again, this cannot be stressed enough. It is good practice in the world of game dev.
###2. Regularly export your vertex weight maps from your model. 
If you ever go back and forth between the engine and Maya to tweak your vertex weight painting, you should have a version to go back to if it turned out horribly. Vertex painting can get burdensome if you have, for example, a clothing mesh that won’t play nice with Terry’s rig because you may have to clear up a lot of clipping issues. This might not be an issue with simpler props.
<upload src="b35c1/8daf9a087569b9d.gif" size="218825" name="ExportWeightMapsNew.gif" />
###3. Jiggle bones must follow the x-axis (the red axis). 
This is so your jiggle bones will correspond and react in the proper fashion.
<upload src="b33fe/8daf981e21c7fc7.gif" size="439884" name="JointBoneXAxisAlign.gif" />
###4. Keep your model combined and as one mesh. 
Remember that the vertices are what will be physically simulated by the engine. In the case of the zipper, it is a part of the entire boot model - you don’t need to separate the zip as a separate mesh.
###5. Source 2 works with a maximum of 4 joint influences when skin binding. 
Keep the above in mind when binding and unbinding skin.
#Zipper
The first section will cover a basic dangling zipper from a pair of leather boots. We will start in Maya, move into ModelDoc, and then test out our zipper in-game.

These boots are already bound to the skeleton, are weight painted, and properly follow Terry’s leg movements. The zip in question remains solid and keeps its shape. If you are working with garments, you should watch [Danduw's video](https://www.youtube.com/watch?v=W7AoTMVv3QQ) on the basics of vertex weight painting to ensure your model fits and moves cleanly before playing with jiggle bones.
<upload src="b33fe/8daf9824821afba.gif" size="6268778" name="JiggleBonesTerryLegMovements.gif" />
##1. Creating your jiggle joints and bones

###1.1 Export your weight maps. 
We are adding new joints, and so the model must be unbound from the skin and then rebound before any changes in the hierarchy are detected. Export your weight maps so you can reimport them onto the mesh when we rebind the skin later.
<upload src="b33fe/8daf98205b424a2.gif" size="218825" name="ExportWeightMapsNew.gif" />
###1.2 Unbind your skin from the skeleton rig.
This is so we can freely work with the skeleton to add bones. The skeleton turns dark blue to indicate that a mesh is not skinned to it.
<upload src="b33fe/8daf982572a42d5.gif" size="285679" name="UnbindSkin.gif" />
###1.3 Choose the nearest and most applicable joint for your use case. 
For the zipper, joint **leg_lower_R** appears most suitable and thus this is the best starting joint.
<upload src="b33fe/8daf98266382ed6.gif" size="191584" name="NearestBoneJoint.gif" />
###1.4 Turn on Snap to points so the bone you’re about to create snaps close to the desired point.
<upload src="b33fe/8daf8e89e6a6587.gif" size="62519" name="SnaptoPointsMaya01.gif" />
###1.5 Using Skeleton > Create Joints, click on the joint leg_lower_R and click out two joints. 
<note>**You don't actually have to click out two joints. One joint is fine for this kind of hinge-like mesh.** After all, Source 2's jiggle bones only attach to a single joint. Sometimes, the additional joints you draw out can be used to stabilise one end of the mesh, especially if it is more organic or flexible. The more joints and bones you add, the more flexibility and bends you'll be able to achieve, and with each jiggle bone you can customise it at each stage in the chain! Just make sure you apply vertex paint for each joint you construct, so the vertices are affected by them. 

**For the sake of this tutorial, we will draw out an additional bone to help us visualise things a little.** It doesn't hurt, but it's not totally necessary for something like a zip that just dangles from a single point. Be aware of this for future projects.</note>

You can keep clicking until you’re done.

<upload src="b33fe/8daf982720f0f77.gif" size="358161" name="CreateJoints.gif" />

###1.6 You’ve just added a new bone to the rig. Wow!
Rename them appropriately. In this case, it’d be zipper_upper_R and zipper_lower_R.
<upload src="b33fe/8daf9827b664d35.gif" size="249911" name="RenamingJoints.gif" />
###1.7 As shown above, rotate the joints so that the x-axis follows the zipper.
What we’ve created is essentially a small armature for the zip to follow.

###1.8 Repeat the above for the opposite boot. 
Remember to keep good naming conventions (e.g., zipper_upper_L and zipper_lower_L).

##2. Rebinding your skin & reimporting your weights

###2.1 Select your mesh in the outliner, hold CTRL, and then select your rig (in this case, it is the pelvis). This selection order creates the hierarchy. 
You don’t want to select the two things the other way around. Then, click the Bind Skin settings box. Ensure your settings are as follows, then click apply.

<upload src="b33fe/8daf9829e456dc5.gif" size="592348" name="RebindingMesh.gif" />

###2.2 With the mesh selected (not the skeleton), reimport your weight maps. 
This should restore your hard work from earlier.

<upload src="b33fe/8daf982d2b3b2dd.gif" size="269693" name="ReimportWeightMaps.gif" />

##3. Painting your weights

###3.1 Because the zip is a solid part of the mesh, this means the deformation has to remain minimal or non-existent. 
We don’t want the zipper to bend or warp. In the case of this boot, the zipper sits in a location that has barely any deformation. Lucky.

However, sometimes you may find your solid part bends and warps uncontrollably. To fix this, we have to ensure the solid part is not influenced by any other joint than the one that is placed directly upon it. If the zipper’s vertices are influenced by other joints in the hierarchy, it’ll get pulled into those directions. We want to make sure it keeps its shape, so that the jiggle bone effect is more realistic.

<upload src="b35c1/8dafa38d8c99b5c.gif" size="4596722" name="Deformation.gif" />

Use your discretion as to which influences will have the best looking effect. Keep the number of bones low if it is something like a hinge - a bit like this zip - and painting will become a lot easier. 
In this case, we only want the zip to be influenced by one joint: zip_upper_R. You only need it to be influenced by one joint in this case, because the jiggle bone in Source 2 will assign only to a single joint.

###3.2 Anything that is influenced (painted white) by the zipper bone we have created will jiggle.
 In the case of this zip, we want to make sure only zipper_upper_R and zipper_upper_L are influencing the corresponding zips on each boot, so make sure the jiggle bones are only affecting the desired jiggling parts. If they affect other parts of the mesh, those parts will jiggle too. We don’t want that.

<upload src="b35c1/8daf99fc4bab30b.gif" size="267454" name="PaintingWeights1.gif" />

As a general rule of thumb, the more solid an object, the more solid the vertex weight paint should be (white). Naturally, gradients are better for fleshier or organic parts.

<note>You can also go into vertex selection mode, and copy individual vertex weights to paste onto other vertices if you want them to deform similarly (or not deform at all, depending on case usage).

<upload src="b35c1/8daf99ffc1410d9.gif" size="142810" name="CopyPasteWeights.gif" /></note>

###3.4 Test the jiggle bone and surrounding joints.
Manipulate the bones and make sure the area behaves as you want it to. If everything looks good, we can move onto importation. The zips here don't deform or clip. That's good!

<upload src="b35c1/8daf9a004c8d941.gif" size="12163066" name="JointTest.gif" />

###3.5 Select the mesh, hold CTRL, and then select the skeleton (the pelvis, in this case). 
Remember to restore your bind pose before you export as .fbx.

<upload src="b35c1/8daf9a30f306cbb.gif" size="478616" name="BindPose.gif" />

###3.6 Export as .fbx into your chosen addon folder.
Keep Maya open in case you need to adjust your weight painting later.

<note>The author ran into problems exporting models with skeletons using FBX 2020, because the skeleton wouldn't show in ModelDoc. Try and earlier FBX version - 2019 worked fine in this case. Always check your FBX export settings as well.</note>

##4. Importing into ModelDoc

###4.1 Search in the asset browser for your model. Load it into ModelDoc. 
After adding your textures, compiling, and saving it as a .vmdl, you should see that your new and fantastic jiggle bones were imported.

<upload src="b35c1/8daf9a615beff15.png" size="789305" name="image.png" />

<note>If you are importing garments, remember to save your mesh, textures, and .clothing file into the **sbox/addons/citizen/models/citizen_clothes** folder with the proper folder structure to match the rest of the stuff there. This is possibly temporary until Facepunch introduces a proper custom clothing system.</note>

###4.2 Click +Add and choose JiggleBone. Rename it appropriately (ZipBoneRight and ZipBoneLeft). Then, choose the corresponding bones.
 Do this for every bone you want to jiggle.

###4.3 Shape the capsule to the shape of your jiggling mesh. 
It should ideally start on the first joint and end on the last.

<upload src="b35c1/8daf9a7a20564d5.png" size="534141" name="image.png" />

###4.4 The below variables were used for the zipper. 
These may not be perfect - and you may spend hours, days, weeks, or years perfecting your jiggle bones - but they do the job. They might be a good place to start if you want to experiment.

<upload src="b35c1/8daf9a99120c478.png" size="59859" name="image.png" />

<note>**Tip:** You can hold CTRL or Shift and select multiple fields in ModelDoc nodes (for example, in the jiggle bone node), copy, and then paste them into another node!</note>

###4.5 Hit compile. 
If your mesh is a garment, you won’t be able to test it until you get in game. If it’s a basic physics prop - and once the variables are set up - you can hit the play button in the top left to test it out.

###4.6 Use the jiggle bone helpers in ModelDoc to predict the effect of your variables.
For example, turning on the yaw, pitch, and angle constraints creates a couple of cones and planes for you to visualise the maximum and minimum effects of the physical forces. Changing the Min Yaw and Max Yaw values, for example, will also change the min and max yaw angles of the folded plane to help you understand how physics will affect the model.

<upload src="b35c1/8daf9aa96c3b00c.png" size="241118" name="image.png" />

##6. Test, test, and test again

###6.1 When in game, press F2 to use the free camera. 
You can witness your jiggly bits react to any animations supplied to the skeleton by s&box. It's not perfect, but it's a good start. I know you can definitely do better!

<upload src="b35c1/8daf9adcc073418.gif" size="21168500" name="JigglyZips.gif" />

###6.2 Adjust your variables (try to only do one at a time) and keep an eye on your in-game model. 
It is crucial that you keep ModelDoc open and your game running so you can see any changes you make and if they benefit your project. If you are experiencing severe deformation, it's likely that you painted your vertex weights wrong or in an inconsistent manner. **This is why you left Maya open - go back and adjust your painting!**

#Creating jiggle bones for the fake breasts

Coming soon.

# Settings and variables for jiggle bones

#Valve's examples
The below features example settings for different types of props from Valve games. This is how they set their bones up and so are a good guide to use if you’re lost or nothing is happening.

##Atlas (BallBot) from Portal 2
<upload src="a80d0/8daf9bde775241f.png" size="61289" name="sbox-dev_rfwr59RqpA.png" />

<upload src="a80d0/8daf9c24d2c6510.gif" size="20658331" name="sbox-dev_bF3TvcOzBZ.gif" />
<upload src="a80d0/8daf9bf272328d2.gif" size="16198031" name="atlas-back.gif" />

##Chell (Player) from Portal 2
<upload src="a80d0/8daf9be14a77862.png" size="60564" name="sbox-dev_X68PByuqid.png" />

<upload src="a80d0/8daf9be3e410ba4.gif" size="25076635" name="sbox-dev_fLq7lqGmX3.gif" />
<upload src="a80d0/8daf9be4b4baf8c.gif" size="17587021" name="sbox-dev_2opI0ZRl8J.gif" />

Jiggle Bones

Account Management

Special Pages

Wiki List

S&box Wiki