.. Ragdoll Tools documentation master file, created by
   sphinx-quickstart on Mon May 19 14:49:12 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


.. toctree::
   :maxdepth: 2
   :caption: Contents:




.. |preset| image:: preset.png

.. |select_settings| image:: select_settings.png

.. |set_mass| image:: set_mass.png

.. |copy_rigid_body_settings| image:: copy_rigid_body_settings.png

.. |copy_rigid_body_constraint_settings| image:: copy_rigid_body_constraint_settings.png

.. |follow_settings| image:: follow_settings.png

.. |color_coding| image:: color_coding.png

.. |bake_rigid_body| image:: bake_rigid_body.png

.. |pie| image:: pie.png



|pie|



|

Ragdoll
=======

|

Make
----

This operator adds ragdoll rig to selected armatures using a given preset.
Presets are sorted by similarity to the active armature


.. video:: make.webm
   :align: center
   :width: 100%

|

Any armature rigged with this addon can be used as preset.
Check **Use as preset** in object settings and it wil appear in the preset list

|preset|


|

Select
------

Select anything and this operator will select the rest of the ragdoll rig

.. video:: select.webm
   :align: center
   :width: 100%

|

In operator settings you can change which parts of the rig should be selected

|select_settings|


|

Mirror
------

Select what you want to mirror and choose direction

.. video:: mirror.webm
   :align: center
   :width: 100%

|

Remove
------

Select anything that has ragdoll rig and use this operator to remove it

.. video:: remove.webm
   :align: center
   :width: 100%

|
|
|
|

Hitboxes
========

Hitbox shape can be adjusted from hitbox object settings in **Object Mode** or from bone settings in **Pose Mode**.

.. tip::
   Hold ``Alt`` to change settings for all selected hitboxes at once

.. video:: hit_box_shape.webm
   :align: center
   :width: 100%


|

From mesh
---------

Select bones in **Pose Mode** then go to **Object Mode** and select mesh objects and armature.
This operator will make hitboxes for selected bones out of selected meshes.

.. video:: from_mesh.webm
   :align: center
   :width: 100%


|

Connect
-------

Select bones in **Pose Mode** then go to **Object Mode** and select mesh objects and armature.
This operator will assign every object to the nearest selected bone as a hitbox.

.. video:: connect.webm
   :align: center
   :width: 100%


|

Set mass
--------

Sets mass of selected items proportional to their volumes so their total mass adds up to a given value

|set_mass|


|

Copy settings
-------------

This operator copies rigid body settings from active to selected

|copy_rigid_body_settings|

|
|
|
|

Constraints
===========

|

Make
----

Select bones or hitboxes end this operator will create rigid body constraints between them.


.. video:: make_constraints.webm
   :align: center
   :width: 100%



|

Set limits
----------

Run this operator and move character.
Constraint limits will be set accordingly to the range of motion

.. video:: constraint_limits.webm
   :align: center
   :width: 100%



|

Copy settings
-------------

This operator copies rigid body constraints settings from active to selected

|copy_rigid_body_constraint_settings|




|
|
|
|

Animation
=========

Once you have a ragdoll,play animation.

.. video:: animation_play.webm
   :align: center
   :width: 100%

|

You can make hitboxes softly follow bones .
To do this use **Follow bone** property.
To make them follow bones hard use **Animated** property

|follow_settings|


These properties can be animated

.. video:: fall.webm
   :align: center
   :width: 100%



.. tip::
   Use this `addon <https://github.com/xbodya13/keyframe_selected>`_  to animate properties for multiple items at once

.. tip::
   Change settings like this to enable color coding

   |color_coding|


.. tip::
   If Blender crashes often during simulation try to save/reload before running it



Bake simulation to prevent recalculation on every playback

|bake_rigid_body|



Bake
----

Use this operator to transfer animation from hitboxes to bones

.. video:: bake.webm
   :align: center
   :width: 100%

|

Clear cache
-----------

Removes rigid body cache